diff --git a/doc/iscsi.md b/doc/iscsi.md index 1763e99d9..6c38a998b 100644 --- a/doc/iscsi.md +++ b/doc/iscsi.md @@ -81,7 +81,7 @@ In addition to the configuration file, the iSCSI target may also be configured v ### Portal groups - iscsi_create_portal_group -- Add a portal group. - - delete_portal_group -- Delete an existing portal group. + - iscsi_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. - iscsi_get_portal_groups -- Show information about all available portal groups. diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index b9e1251f0..19b002624 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -257,7 +257,7 @@ Example response: "get_iscsi_global_params", "target_node_add_lun", "get_iscsi_connections", - "delete_portal_group", + "iscsi_delete_portal_group", "iscsi_create_portal_group", "iscsi_get_portal_groups", "delete_target_node", @@ -3515,7 +3515,7 @@ Example response: } ~~~ -## delete_portal_group method {#rpc_delete_portal_group} +## iscsi_delete_portal_group method {#rpc_iscsi_delete_portal_group} Delete an existing portal group. @@ -3535,7 +3535,7 @@ Example request: "tag": 1 }, "jsonrpc": "2.0", - "method": "delete_portal_group", + "method": "iscsi_delete_portal_group", "id": 1 } ~~~ diff --git a/lib/iscsi/iscsi_rpc.c b/lib/iscsi/iscsi_rpc.c index 69259409e..65f4c04dd 100644 --- a/lib/iscsi/iscsi_rpc.c +++ b/lib/iscsi/iscsi_rpc.c @@ -844,24 +844,24 @@ out: SPDK_RPC_REGISTER("iscsi_create_portal_group", spdk_rpc_iscsi_create_portal_group, SPDK_RPC_RUNTIME) SPDK_RPC_REGISTER_ALIAS_DEPRECATED(iscsi_create_portal_group, add_portal_group) -struct rpc_delete_portal_group { +struct rpc_iscsi_delete_portal_group { int32_t tag; }; -static const struct spdk_json_object_decoder rpc_delete_portal_group_decoders[] = { - {"tag", offsetof(struct rpc_delete_portal_group, tag), spdk_json_decode_int32}, +static const struct spdk_json_object_decoder rpc_iscsi_delete_portal_group_decoders[] = { + {"tag", offsetof(struct rpc_iscsi_delete_portal_group, tag), spdk_json_decode_int32}, }; static void -spdk_rpc_delete_portal_group(struct spdk_jsonrpc_request *request, - const struct spdk_json_val *params) +spdk_rpc_iscsi_delete_portal_group(struct spdk_jsonrpc_request *request, + const struct spdk_json_val *params) { - struct rpc_delete_portal_group req = {}; + struct rpc_iscsi_delete_portal_group req = {}; struct spdk_json_write_ctx *w; struct spdk_iscsi_portal_grp *pg; - if (spdk_json_decode_object(params, rpc_delete_portal_group_decoders, - SPDK_COUNTOF(rpc_delete_portal_group_decoders), + if (spdk_json_decode_object(params, rpc_iscsi_delete_portal_group_decoders, + SPDK_COUNTOF(rpc_iscsi_delete_portal_group_decoders), &req)) { SPDK_ERRLOG("spdk_json_decode_object failed\n"); goto invalid; @@ -883,7 +883,8 @@ spdk_rpc_delete_portal_group(struct spdk_jsonrpc_request *request, invalid: spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); } -SPDK_RPC_REGISTER("delete_portal_group", spdk_rpc_delete_portal_group, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER("iscsi_delete_portal_group", spdk_rpc_iscsi_delete_portal_group, SPDK_RPC_RUNTIME) +SPDK_RPC_REGISTER_ALIAS_DEPRECATED(iscsi_delete_portal_group, delete_portal_group) struct rpc_get_iscsi_connections_ctx { struct spdk_jsonrpc_request *request; diff --git a/scripts/rpc.py b/scripts/rpc.py index d1addde4b..72f6919d6 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -1046,14 +1046,15 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.') p.set_defaults(func=delete_target_node) - def delete_portal_group(args): - rpc.iscsi.delete_portal_group(args.client, tag=args.tag) + def iscsi_delete_portal_group(args): + rpc.iscsi.iscsi_delete_portal_group(args.client, tag=args.tag) - p = subparsers.add_parser('delete_portal_group', + p = subparsers.add_parser('iscsi_delete_portal_group', + aliases=['delete_portal_group'], help='Delete a portal group') p.add_argument( 'tag', help='Portal group tag (unique, integer > 0)', type=int) - p.set_defaults(func=delete_portal_group) + p.set_defaults(func=iscsi_delete_portal_group) def delete_initiator_group(args): rpc.iscsi.delete_initiator_group(args.client, tag=args.tag) diff --git a/scripts/rpc/iscsi.py b/scripts/rpc/iscsi.py index 37962a756..434dd9ae8 100644 --- a/scripts/rpc/iscsi.py +++ b/scripts/rpc/iscsi.py @@ -452,7 +452,8 @@ def delete_target_node(client, target_node_name): return client.call('delete_target_node', params) -def delete_portal_group(client, tag): +@deprecated_alias('delete_portal_group') +def iscsi_delete_portal_group(client, tag): """Delete a portal group. Args: @@ -462,7 +463,7 @@ def delete_portal_group(client, tag): True or False """ params = {'tag': tag} - return client.call('delete_portal_group', params) + return client.call('iscsi_delete_portal_group', params) def delete_initiator_group(client, tag): diff --git a/scripts/spdkcli/ui_node_iscsi.py b/scripts/spdkcli/ui_node_iscsi.py index c51e672c2..6753224a9 100644 --- a/scripts/spdkcli/ui_node_iscsi.py +++ b/scripts/spdkcli/ui_node_iscsi.py @@ -292,7 +292,7 @@ class UIPortalGroups(UINode): self.refresh() def delete(self, tag): - self.get_root().delete_portal_group(tag=tag) + self.get_root().iscsi_delete_portal_group(tag=tag) def ui_command_create(self, tag, portal_list): """Add a portal group. diff --git a/scripts/spdkcli/ui_root.py b/scripts/spdkcli/ui_root.py index fb2601863..48b26cef1 100644 --- a/scripts/spdkcli/ui_root.py +++ b/scripts/spdkcli/ui_root.py @@ -409,8 +409,8 @@ class UIRoot(UINode): rpc.iscsi.iscsi_create_portal_group(self.client, **kwargs) @verbose - def delete_portal_group(self, **kwargs): - rpc.iscsi.delete_portal_group(self.client, **kwargs) + def iscsi_delete_portal_group(self, **kwargs): + rpc.iscsi.iscsi_delete_portal_group(self.client, **kwargs) @verbose def construct_initiator_group(self, **kwargs): diff --git a/test/iscsi_tgt/rpc_config/rpc_config.py b/test/iscsi_tgt/rpc_config/rpc_config.py index b859b19df..f59557d1b 100755 --- a/test/iscsi_tgt/rpc_config/rpc_config.py +++ b/test/iscsi_tgt/rpc_config/rpc_config.py @@ -126,7 +126,7 @@ def verify_iscsi_connection_rpc_methods(rpc_py): check_output('iscsiadm -m node --logout', shell=True) check_output('iscsiadm -m node -o delete', shell=True) rpc.delete_initiator_group(initiator_tag) - rpc.delete_portal_group(portal_tag) + rpc.iscsi_delete_portal_group(portal_tag) rpc.delete_target_node(name) output = rpc.get_iscsi_connections() jsonvalues = json.loads(output) @@ -167,7 +167,7 @@ def verify_scsi_devices_rpc_methods(rpc_py): check_output('iscsiadm -m node --logout', shell=True) check_output('iscsiadm -m node -o delete', shell=True) rpc.delete_initiator_group(initiator_tag) - rpc.delete_portal_group(portal_tag) + rpc.iscsi_delete_portal_group(portal_tag) rpc.delete_target_node(name) output = rpc.get_scsi_devices() jsonvalues = json.loads(output) @@ -218,7 +218,7 @@ def verify_portal_groups_rpc_methods(rpc_py, rpc_param): "tag value is {}, expected {}".format(value['tag'], idx + 1)) for idx, value in enumerate(tag_list): - rpc.delete_portal_group(value) + rpc.iscsi_delete_portal_group(value) output = rpc.iscsi_get_portal_groups() jsonvalues = json.loads(output) verify(len(jsonvalues) == (len(tag_list) - (idx + 1)), 1, @@ -390,7 +390,7 @@ def verify_target_nodes_rpc_methods(rpc_py, rpc_param): rpc.iscsi_create_target_node(rpc_param['target_name'], rpc_param['alias_name'], lun_mapping, net_mapping, rpc_param['queue_depth'], '-d') - rpc.delete_portal_group(portal_tag) + rpc.iscsi_delete_portal_group(portal_tag) rpc.delete_initiator_group(initiator_tag) rpc.delete_target_node(name) output = rpc.iscsi_get_target_nodes() diff --git a/test/json_config/clear_config.py b/test/json_config/clear_config.py index b10c24264..ea45cc41d 100755 --- a/test/json_config/clear_config.py +++ b/test/json_config/clear_config.py @@ -86,7 +86,7 @@ def clear_nvmf_subsystem(args, nvmf_config): def get_iscsi_destroy_method(iscsi): - destroy_method_map = {'iscsi_create_portal_group': "delete_portal_group", + destroy_method_map = {'iscsi_create_portal_group': "iscsi_delete_portal_group", 'add_initiator_group': "delete_initiator_group", 'iscsi_create_target_node': "delete_target_node", 'set_iscsi_options': None