diff --git a/doc/iscsi.md b/doc/iscsi.md index 7e65367a3..715b1f047 100644 --- a/doc/iscsi.md +++ b/doc/iscsi.md @@ -84,7 +84,7 @@ In addition to the configuration file, the iSCSI target may also be configured v - delete_portal_group -- Delete an existing portal group. - add_pg_ig_maps -- Add initiator group to portal group mappings to an existing iSCSI target node. - delete_pg_ig_maps -- Delete initiator group to portal group mappings from an existing iSCSI target node. - - get_portal_groups -- Show information about all available portal groups. + - iscsi_get_portal_groups -- Show information about all available portal groups. ~~~ /path/to/spdk/scripts/rpc.py add_portal_group 1 10.0.0.1:3260 diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 70e044cb5..5db989d65 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -259,7 +259,7 @@ Example response: "get_iscsi_connections", "delete_portal_group", "add_portal_group", - "get_portal_groups", + "iscsi_get_portal_groups", "delete_target_node", "delete_pg_ig_maps", "add_pg_ig_maps", @@ -3424,7 +3424,7 @@ Example response: } ~~~ -## get_portal_groups method {#rpc_get_portal_groups} +## iscsi_get_portal_groups method {#rpc_iscsi_get_portal_groups} Show information about all available portal groups. @@ -3440,7 +3440,7 @@ Example request: request: { "jsonrpc": "2.0", - "method": "get_portal_groups", + "method": "iscsi_get_portal_groups", "id": 1 } ~~~ diff --git a/lib/iscsi/iscsi_rpc.c b/lib/iscsi/iscsi_rpc.c index de7558d95..fcb71b38f 100644 --- a/lib/iscsi/iscsi_rpc.c +++ b/lib/iscsi/iscsi_rpc.c @@ -686,14 +686,14 @@ invalid: SPDK_RPC_REGISTER("delete_target_node", spdk_rpc_delete_target_node, SPDK_RPC_RUNTIME) static void -spdk_rpc_get_portal_groups(struct spdk_jsonrpc_request *request, - const struct spdk_json_val *params) +spdk_rpc_iscsi_get_portal_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_portal_groups requires no parameters"); + "iscsi_get_portal_groups requires no parameters"); return; } @@ -704,7 +704,8 @@ spdk_rpc_get_portal_groups(struct spdk_jsonrpc_request *request, spdk_jsonrpc_end_result(request, w); } -SPDK_RPC_REGISTER("get_portal_groups", spdk_rpc_get_portal_groups, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER("iscsi_get_portal_groups", spdk_rpc_iscsi_get_portal_groups, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(iscsi_get_portal_groups, get_portal_groups) struct rpc_portal { char *host; diff --git a/scripts/rpc.py b/scripts/rpc.py index d7d8dfdf9..9eeb3c291 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -782,12 +782,13 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse help='Display current authentication group configuration') p.set_defaults(func=get_iscsi_auth_groups) - def get_portal_groups(args): - print_dict(rpc.iscsi.get_portal_groups(args.client)) + def iscsi_get_portal_groups(args): + print_dict(rpc.iscsi.iscsi_get_portal_groups(args.client)) p = subparsers.add_parser( - 'get_portal_groups', help='Display current portal group configuration') - p.set_defaults(func=get_portal_groups) + 'iscsi_get_portal_groups', aliases=['get_portal_groups'], + 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)) diff --git a/scripts/rpc/iscsi.py b/scripts/rpc/iscsi.py index 55eec4736..332098eca 100644 --- a/scripts/rpc/iscsi.py +++ b/scripts/rpc/iscsi.py @@ -124,13 +124,14 @@ def get_iscsi_auth_groups(client): return client.call('get_iscsi_auth_groups') -def get_portal_groups(client): +@deprecated_alias('get_portal_groups') +def iscsi_get_portal_groups(client): """Display current portal group configuration. Returns: List of current portal group configuration. """ - return client.call('get_portal_groups') + return client.call('iscsi_get_portal_groups') def get_initiator_groups(client): diff --git a/scripts/spdkcli/ui_node_iscsi.py b/scripts/spdkcli/ui_node_iscsi.py index 3df640da8..c51e672c2 100644 --- a/scripts/spdkcli/ui_node_iscsi.py +++ b/scripts/spdkcli/ui_node_iscsi.py @@ -335,7 +335,7 @@ class UIPortalGroups(UINode): def refresh(self): self._children = set([]) - self.pgs = list(self.get_root().get_portal_groups()) + self.pgs = list(self.get_root().iscsi_get_portal_groups()) for pg in self.pgs: try: UIPortalGroup(pg, self) diff --git a/scripts/spdkcli/ui_root.py b/scripts/spdkcli/ui_root.py index 8b6f35be3..6c80d295d 100644 --- a/scripts/spdkcli/ui_root.py +++ b/scripts/spdkcli/ui_root.py @@ -392,9 +392,9 @@ class UIRoot(UINode): @verbose @is_method_available - def get_portal_groups(self): + def iscsi_get_portal_groups(self): if self.is_init: - for pg in rpc.iscsi.get_portal_groups(self.client): + for pg in rpc.iscsi.iscsi_get_portal_groups(self.client): yield ScsiObj(pg) @verbose diff --git a/test/iscsi_tgt/rpc_config/rpc_config.py b/test/iscsi_tgt/rpc_config/rpc_config.py index 289ce66ae..587cf9192 100755 --- a/test/iscsi_tgt/rpc_config/rpc_config.py +++ b/test/iscsi_tgt/rpc_config/rpc_config.py @@ -188,10 +188,10 @@ def create_malloc_bdevs_rpc_methods(rpc_py, rpc_param): def verify_portal_groups_rpc_methods(rpc_py, rpc_param): rpc = spdk_rpc(rpc_py) - output = rpc.get_portal_groups() + output = rpc.iscsi_get_portal_groups() jsonvalues = json.loads(output) verify(not jsonvalues, 1, - "get_portal_groups returned {} groups, expected empty".format(jsonvalues)) + "iscsi_get_portal_groups returned {} groups, expected empty".format(jsonvalues)) lo_ip = (target_ip, other_ip) nics = json.loads(rpc.get_interfaces()) @@ -202,10 +202,10 @@ def verify_portal_groups_rpc_methods(rpc_py, rpc_param): # The portal group tag must start at 1 tag = idx + 1 rpc.add_portal_group(tag, "{}:{}".format(value, rpc_param['port'])) - output = rpc.get_portal_groups() + output = rpc.iscsi_get_portal_groups() jsonvalues = json.loads(output) verify(len(jsonvalues) == tag, 1, - "get_portal_groups returned {} groups, expected {}".format(len(jsonvalues), tag)) + "iscsi_get_portal_groups returned {} groups, expected {}".format(len(jsonvalues), tag)) tag_list = [] for idx, value in enumerate(jsonvalues): @@ -219,7 +219,7 @@ def verify_portal_groups_rpc_methods(rpc_py, rpc_param): for idx, value in enumerate(tag_list): rpc.delete_portal_group(value) - output = rpc.get_portal_groups() + output = rpc.iscsi_get_portal_groups() jsonvalues = json.loads(output) verify(len(jsonvalues) == (len(tag_list) - (idx + 1)), 1, "get_portal_group returned {} groups, expected {}".format(len(jsonvalues), (len(tag_list) - (idx + 1))))