rpc: Rename delete_initiators_from_initiator_group to iscsi_initiator_group_remove_initiators

Change-Id: Id1bf2b21bb91982f3e8d6466b8493b4608f99299
Signed-off-by: Pawel Kaminski <pawelx.kaminski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/467328
Community-CI: Broadcom SPDK FC-NVMe CI <spdk-ci.pdl@broadcom.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>

doc/jsonrpc.md

@@ -266,7 +266,7 @@ Example response:
     "iscsi_create_target_node",
     "iscsi_get_target_nodes",
     "delete_initiator_group",
-    "delete_initiators_from_initiator_group",
+    "iscsi_initiator_group_remove_initiators",
     "iscsi_initiator_group_add_initiators",
     "add_initiator_group",
     "get_initiator_groups",

lib/iscsi/iscsi_rpc.c

@@ -217,7 +217,7 @@ SPDK_RPC_REGISTER_ALIAS_DEPRECATED(iscsi_initiator_group_add_initiators,
 				   add_initiators_to_initiator_group)
 
 static void
-spdk_rpc_delete_initiators_from_initiator_group(struct spdk_jsonrpc_request *request,
+spdk_rpc_iscsi_initiator_group_remove_initiators(struct spdk_jsonrpc_request *request,
 		const struct spdk_json_val *params)
 {
 	struct rpc_initiator_group req = {};
@@ -249,8 +249,10 @@ invalid:
 	spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");
 	free_rpc_initiator_group(&req);
 }
-SPDK_RPC_REGISTER("delete_initiators_from_initiator_group",
+SPDK_RPC_REGISTER("iscsi_initiator_group_remove_initiators",
-		  spdk_rpc_delete_initiators_from_initiator_group, SPDK_RPC_RUNTIME)
+		  spdk_rpc_iscsi_initiator_group_remove_initiators, SPDK_RPC_RUNTIME)
+SPDK_RPC_REGISTER_ALIAS_DEPRECATED(iscsi_initiator_group_remove_initiators,
+				   delete_initiators_from_initiator_group)
 
 struct rpc_delete_initiator_group {
 	int32_t tag;

scripts/rpc.py

@@ -1006,7 +1006,7 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse
     This parameter can be omitted.  Example: '255.255.0.0 255.248.0.0' etc""", required=False)
     p.set_defaults(func=iscsi_initiator_group_add_initiators)
 
-    def delete_initiators_from_initiator_group(args):
+    def iscsi_initiator_group_remove_initiators(args):
         initiators = None
         netmasks = None
         if args.initiator_list:
@@ -1017,13 +1017,14 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse
             netmasks = []
             for n in args.netmask_list.strip().split(' '):
                 netmasks.append(n)
-        rpc.iscsi.delete_initiators_from_initiator_group(
+        rpc.iscsi.iscsi_initiator_group_remove_initiators(
             args.client,
             tag=args.tag,
             initiators=initiators,
             netmasks=netmasks)
 
-    p = subparsers.add_parser('delete_initiators_from_initiator_group',
+    p = subparsers.add_parser('iscsi_initiator_group_remove_initiators',
+                              aliases=['delete_initiators_from_initiator_group'],
                               help='Delete initiators from an existing initiator group')
     p.add_argument(
         'tag', help='Initiator group tag (unique, integer > 0)', type=int)
@@ -1031,7 +1032,7 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse
     enclosed in quotes.  This parameter can be omitted.  Example: 'ANY' or '127.0.0.1 192.168.200.100'""", required=False)
     p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes.
     This parameter can be omitted.  Example: '255.255.0.0 255.248.0.0' etc""", required=False)
-    p.set_defaults(func=delete_initiators_from_initiator_group)
+    p.set_defaults(func=iscsi_initiator_group_remove_initiators)
 
     def delete_target_node(args):
         rpc.iscsi.delete_target_node(

scripts/rpc/iscsi.py

@@ -415,7 +415,8 @@ def iscsi_initiator_group_add_initiators(
     return client.call('iscsi_initiator_group_add_initiators', params)
 
 
-def delete_initiators_from_initiator_group(
+@deprecated_alias('delete_initiators_from_initiator_group')
+def iscsi_initiator_group_remove_initiators(
         client, tag, initiators=None, netmasks=None):
     """Delete initiators from an existing initiator group.
 
@@ -433,7 +434,7 @@ def delete_initiators_from_initiator_group(
         params['initiators'] = initiators
     if netmasks:
         params['netmasks'] = netmasks
-    return client.call('delete_initiators_from_initiator_group', params)
+    return client.call('iscsi_initiator_group_remove_initiators', params)
 
 
 def delete_target_node(client, target_node_name):

scripts/spdkcli/ui_node_iscsi.py

@@ -439,7 +439,7 @@ class UIInitiatorGroups(UINode):
             initiators = initiators.split(" ")
         if netmasks:
             netmasks = netmasks.split(" ")
-        self.get_root().delete_initiators_from_initiator_group(
+        self.get_root().iscsi_initiator_group_remove_initiators(
             tag=tag, initiators=initiators,
             netmasks=netmasks)
 

scripts/spdkcli/ui_root.py

@@ -432,8 +432,8 @@ class UIRoot(UINode):
         rpc.iscsi.iscsi_initiator_group_add_initiators(self.client, **kwargs)
 
     @verbose
-    def delete_initiators_from_initiator_group(self, **kwargs):
+    def iscsi_initiator_group_remove_initiators(self, **kwargs):
-        rpc.iscsi.delete_initiators_from_initiator_group(self.client, **kwargs)
+        rpc.iscsi.iscsi_initiator_group_remove_initiators(self.client, **kwargs)
 
     @verbose
     def add_pg_ig_maps(self, **kwargs):

test/iscsi_tgt/rpc_config/rpc_config.py

@@ -268,7 +268,7 @@ def verify_initiator_groups_rpc_methods(rpc_py, rpc_param):
 
     for idx, value in enumerate(rpc_param['netmask']):
         tag = idx + 1
-        rpc.delete_initiators_from_initiator_group(tag, '-n', rpc_param['initiator_name'], '-m', value)
+        rpc.iscsi_initiator_group_remove_initiators(tag, '-n', rpc_param['initiator_name'], '-m', value)
 
     output = rpc.get_initiator_groups()
     jsonvalues = json.loads(output)