diff --git a/doc/iscsi.md b/doc/iscsi.md index 6c38a998b..bd25f9a99 100644 --- a/doc/iscsi.md +++ b/doc/iscsi.md @@ -95,7 +95,7 @@ In addition to the configuration file, the iSCSI target may also be configured v - add_initiator_group -- Add an initiator group. - delete_initiator_group -- Delete an existing initiator group. - iscsi_initiator_group_add_initiators -- Add initiators to an existing initiator group. - - get_initiator_groups -- Show information about all available initiator groups. + - iscsi_get_initiator_groups -- Show information about all available initiator groups. ~~~ /path/to/spdk/scripts/rpc.py add_initiator_group 2 ANY 10.0.0.2/32 diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 19b002624..140dcba60 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -269,7 +269,7 @@ Example response: "iscsi_initiator_group_remove_initiators", "iscsi_initiator_group_add_initiators", "add_initiator_group", - "get_initiator_groups", + "iscsi_get_initiator_groups", "set_iscsi_options", "set_bdev_options", "set_bdev_qos_limit", @@ -2914,7 +2914,7 @@ Example response: } ~~~ -## get_initiator_groups method {#rpc_get_initiator_groups} +## iscsi_get_initiator_groups method {#rpc_iscsi_get_initiator_groups} Show information about all available initiator groups. @@ -2939,7 +2939,7 @@ Example request: ~~~ { "jsonrpc": "2.0", - "method": "get_initiator_groups", + "method": "iscsi_get_initiator_groups", "id": 1 } ~~~ diff --git a/lib/iscsi/iscsi_rpc.c b/lib/iscsi/iscsi_rpc.c index 65f4c04dd..50a41d3f7 100644 --- a/lib/iscsi/iscsi_rpc.c +++ b/lib/iscsi/iscsi_rpc.c @@ -45,14 +45,14 @@ #include "spdk_internal/log.h" static void -spdk_rpc_get_initiator_groups(struct spdk_jsonrpc_request *request, - const struct spdk_json_val *params) +spdk_rpc_iscsi_get_initiator_groups(struct spdk_jsonrpc_request *request, + const struct spdk_json_val *params) { struct spdk_json_write_ctx *w; if (params != NULL) { spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, - "get_initiator_groups requires no parameters"); + "iscsi_get_initiator_groups requires no parameters"); return; } @@ -63,7 +63,9 @@ spdk_rpc_get_initiator_groups(struct spdk_jsonrpc_request *request, spdk_jsonrpc_end_result(request, w); } -SPDK_RPC_REGISTER("get_initiator_groups", spdk_rpc_get_initiator_groups, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER("iscsi_get_initiator_groups", spdk_rpc_iscsi_get_initiator_groups, + SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(iscsi_get_initiator_groups, get_initiator_groups) struct rpc_initiator_list { size_t num_initiators; diff --git a/scripts/rpc.py b/scripts/rpc.py index 72f6919d6..77dee0f98 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -790,12 +790,13 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse help='Display current portal group configuration') p.set_defaults(func=iscsi_get_portal_groups) - def get_initiator_groups(args): - print_dict(rpc.iscsi.get_initiator_groups(args.client)) + def iscsi_get_initiator_groups(args): + print_dict(rpc.iscsi.iscsi_get_initiator_groups(args.client)) - p = subparsers.add_parser('get_initiator_groups', + p = subparsers.add_parser('iscsi_get_initiator_groups', + aliases=['get_initiator_groups'], help='Display current initiator group configuration') - p.set_defaults(func=get_initiator_groups) + p.set_defaults(func=iscsi_get_initiator_groups) def iscsi_get_target_nodes(args): print_dict(rpc.iscsi.iscsi_get_target_nodes(args.client)) diff --git a/scripts/rpc/iscsi.py b/scripts/rpc/iscsi.py index 434dd9ae8..dc954925a 100644 --- a/scripts/rpc/iscsi.py +++ b/scripts/rpc/iscsi.py @@ -134,13 +134,14 @@ def iscsi_get_portal_groups(client): return client.call('iscsi_get_portal_groups') -def get_initiator_groups(client): +@deprecated_alias('get_initiator_groups') +def iscsi_get_initiator_groups(client): """Display current initiator group configuration. Returns: List of current initiator group configuration. """ - return client.call('get_initiator_groups') + return client.call('iscsi_get_initiator_groups') @deprecated_alias('get_target_nodes') diff --git a/scripts/spdkcli/ui_node_iscsi.py b/scripts/spdkcli/ui_node_iscsi.py index 6753224a9..1951c418f 100644 --- a/scripts/spdkcli/ui_node_iscsi.py +++ b/scripts/spdkcli/ui_node_iscsi.py @@ -445,7 +445,7 @@ class UIInitiatorGroups(UINode): def refresh(self): self._children = set([]) - self.igs = list(self.get_root().get_initiator_groups()) + self.igs = list(self.get_root().iscsi_get_initiator_groups()) for ig in self.igs: UIInitiatorGroup(ig, self) diff --git a/scripts/spdkcli/ui_root.py b/scripts/spdkcli/ui_root.py index 48b26cef1..a8109c166 100644 --- a/scripts/spdkcli/ui_root.py +++ b/scripts/spdkcli/ui_root.py @@ -399,9 +399,9 @@ class UIRoot(UINode): @verbose @is_method_available - def get_initiator_groups(self): + def iscsi_get_initiator_groups(self): if self.is_init: - for ig in rpc.iscsi.get_initiator_groups(self.client): + for ig in rpc.iscsi.iscsi_get_initiator_groups(self.client): yield ScsiObj(ig) @verbose diff --git a/test/iscsi_tgt/rpc_config/rpc_config.py b/test/iscsi_tgt/rpc_config/rpc_config.py index f59557d1b..d5656e762 100755 --- a/test/iscsi_tgt/rpc_config/rpc_config.py +++ b/test/iscsi_tgt/rpc_config/rpc_config.py @@ -243,18 +243,18 @@ def verify_portal_groups_rpc_methods(rpc_py, rpc_param): def verify_initiator_groups_rpc_methods(rpc_py, rpc_param): rpc = spdk_rpc(rpc_py) - output = rpc.get_initiator_groups() + output = rpc.iscsi_get_initiator_groups() jsonvalues = json.loads(output) verify(not jsonvalues, 1, - "get_initiator_groups returned {}, expected empty".format(jsonvalues)) + "iscsi_get_initiator_groups returned {}, expected empty".format(jsonvalues)) for idx, value in enumerate(rpc_param['netmask']): # The initiator group tag must start at 1 tag = idx + 1 rpc.add_initiator_group(tag, rpc_param['initiator_name'], value) - output = rpc.get_initiator_groups() + output = rpc.iscsi_get_initiator_groups() jsonvalues = json.loads(output) verify(len(jsonvalues) == tag, 1, - "get_initiator_groups returned {} groups, expected {}".format(len(jsonvalues), tag)) + "iscsi_get_initiator_groups returned {} groups, expected {}".format(len(jsonvalues), tag)) tag_list = [] for idx, value in enumerate(jsonvalues): @@ -270,10 +270,10 @@ def verify_initiator_groups_rpc_methods(rpc_py, rpc_param): tag = idx + 1 rpc.iscsi_initiator_group_remove_initiators(tag, '-n', rpc_param['initiator_name'], '-m', value) - output = rpc.get_initiator_groups() + output = rpc.iscsi_get_initiator_groups() jsonvalues = json.loads(output) verify(len(jsonvalues) == tag, 1, - "get_initiator_groups returned {} groups, expected {}".format(len(jsonvalues), tag)) + "iscsi_get_initiator_groups returned {} groups, expected {}".format(len(jsonvalues), tag)) for idx, value in enumerate(jsonvalues): verify(value['tag'] == idx + 1, 1, @@ -288,10 +288,10 @@ def verify_initiator_groups_rpc_methods(rpc_py, rpc_param): for idx, value in enumerate(rpc_param['netmask']): tag = idx + 1 rpc.iscsi_initiator_group_add_initiators(tag, '-n', rpc_param['initiator_name'], '-m', value) - output = rpc.get_initiator_groups() + output = rpc.iscsi_get_initiator_groups() jsonvalues = json.loads(output) verify(len(jsonvalues) == tag, 1, - "get_initiator_groups returned {} groups, expected {}".format(len(jsonvalues), tag)) + "iscsi_get_initiator_groups returned {} groups, expected {}".format(len(jsonvalues), tag)) tag_list = [] for idx, value in enumerate(jsonvalues): @@ -305,10 +305,10 @@ def verify_initiator_groups_rpc_methods(rpc_py, rpc_param): for idx, value in enumerate(tag_list): rpc.delete_initiator_group(value) - output = rpc.get_initiator_groups() + output = rpc.iscsi_get_initiator_groups() jsonvalues = json.loads(output) verify(len(jsonvalues) == (len(tag_list) - (idx + 1)), 1, - "get_initiator_groups returned {} groups, expected {}".format(len(jsonvalues), (len(tag_list) - (idx + 1)))) + "iscsi_get_initiator_groups returned {} groups, expected {}".format(len(jsonvalues), (len(tag_list) - (idx + 1)))) if not jsonvalues: break for jidx, jvalue in enumerate(jsonvalues):