Merge pull request #494 from netscaler/rename

Supporting operation rename

Author: shivashankar-vaddepally

plugins/module_utils/common.py

@@ -190,29 +190,47 @@ def _check_create_resource_params(resource_name, resource_module_params, action=
         ]
     except KeyError:
         resource_action_keys = []
-
-    # TODO: Should we allow non-add keys for the resource? OR should we error out if any non-add key is passed?
-    for key in resource_module_params.keys():
-        if not action:
-            if key in resource_add_keys:
-                post_data[key] = resource_module_params[key]
-            elif resource_name == "service" and key == "ipaddress":
-                post_data["ip"] = resource_module_params[key]
-            else:
-                log(
-                    "WARNING: Key `{}` is not allowed for the resource `{}` for CREATE operation. Skipping the key for the operation".format(
-                        key, resource_name
-                    )
-                )
+    if action == "rename":
+        oldnamekey = NITRO_RESOURCE_MAP[resource_name]["primary_key"]
+        if oldnamekey in resource_module_params:
+            post_data[oldnamekey] = resource_module_params[oldnamekey]
+        else:
+            msg = "ERROR: Key `{}` is required for the resource `{}` for RENAME operation".format(
+                oldnamekey, resource_name
+            )
+            log(msg)
+            return False, msg, None
+        if "newname" in resource_module_params:
+            post_data["newname"] = resource_module_params["newname"]
         else:
-            if key in resource_action_keys:
-                post_data[key] = resource_module_params[key]
+            msg = "ERROR: Key `newname` is required for the resource `{}` for RENAME operation".format(
+                resource_name
+            )
+            log(msg)
+            return False, msg, None
+    else:
+        # TODO: Should we allow non-add keys for the resource? OR should we error out if any non-add key is passed?
+        for key in resource_module_params.keys():
+            if not action:
+                if key in resource_add_keys:
+                    post_data[key] = resource_module_params[key]
+                elif resource_name == "service" and key == "ipaddress":
+                    post_data["ip"] = resource_module_params[key]
+                else:
+                    log(
+                        "WARNING: Key `{}` is not allowed for the resource `{}` for CREATE operation. Skipping the key for the operation".format(
+                            key, resource_name
+                        )
+                    )
             else:
-                log(
-                    "WARNING: Key `{}` is not allowed for the resource `{}` for `{}` action. Skipping the key for the operation".format(
-                        key, resource_name, action.upper()
+                if key in resource_action_keys:
+                    post_data[key] = resource_module_params[key]
+                else:
+                    log(
+                        "WARNING: Key `{}` is not allowed for the resource `{}` for `{}` action. Skipping the key for the operation".format(
+                            key, resource_name, action.upper()
+                        )
                     )
-                )
 
     return True, None, post_data
 
@@ -601,6 +619,8 @@ def get_valid_desired_states(resource_name):
         desired_states.add("switched")
     if "unset" in supported_operations:
         desired_states.add("unset")
+    if "rename" in supported_operations:
+        desired_states.add("renamed")
     if "apply" in supported_operations:
         desired_states.add("applied")
     return desired_states

plugins/module_utils/module_executor.py

@@ -963,6 +963,7 @@ def main(self):
                 "flushed",
                 "switched",
                 "unset",
+                "renamed",
                 "applied",
             }:
                 state_action_map = {
@@ -971,6 +972,7 @@ def main(self):
                     "flushed": "flush",
                     "switched": "switch",
                     "unset": "unset",
+                    "renamed": "rename",
                     "applied": "apply",
                 }
                 self.act_on_resource(

plugins/modules/appflowaction.py

@@ -31,6 +31,7 @@
       - present
       - absent
       - unset
+      - renamed
     default: present
     description:
       - The state of the resource being configured by the module on the NetScaler
@@ -39,6 +40,7 @@
         the module's parameters.
       - When C(absent), the resource will be deleted from the NetScaler ADC node.
       - When C(unset), the resource will be unset on the NetScaler ADC node.
+      - When C(renamed), the resource will be renamed on the NetScaler ADC node.
     type: str
   botinsight:
     type: str

plugins/modules/appflowcollector.py

@@ -31,6 +31,7 @@
       - present
       - absent
       - unset
+      - renamed
     default: present
     description:
       - The state of the resource being configured by the module on the NetScaler
@@ -39,6 +40,7 @@
         the module's parameters.
       - When C(absent), the resource will be deleted from the NetScaler ADC node.
       - When C(unset), the resource will be unset on the NetScaler ADC node.
+      - When C(renamed), the resource will be renamed on the NetScaler ADC node.
     type: str
   ipaddress:
     type: str

plugins/modules/appflowpolicy.py

@@ -31,6 +31,7 @@
       - present
       - absent
       - unset
+      - renamed
     default: present
     description:
       - The state of the resource being configured by the module on the NetScaler
@@ -39,6 +40,7 @@
         the module's parameters.
       - When C(absent), the resource will be deleted from the NetScaler ADC node.
       - When C(unset), the resource will be unset on the NetScaler ADC node.
+      - When C(renamed), the resource will be renamed on the NetScaler ADC node.
     type: str
   action:
     type: str

plugins/modules/appflowpolicylabel.py

@@ -30,13 +30,15 @@
     choices:
       - present
       - absent
+      - renamed
     default: present
     description:
       - The state of the resource being configured by the module on the NetScaler
         ADC node.
       - When C(present), the resource will be added/updated configured according to
         the module's parameters.
       - When C(absent), the resource will be deleted from the NetScaler ADC node.
+      - When C(renamed), the resource will be renamed on the NetScaler ADC node.
     type: str
   labelname:
     type: str

plugins/modules/appfwpolicy.py

@@ -31,6 +31,7 @@
       - present
       - absent
       - unset
+      - renamed
     default: present
     description:
       - The state of the resource being configured by the module on the NetScaler
@@ -39,6 +40,7 @@
         the module's parameters.
       - When C(absent), the resource will be deleted from the NetScaler ADC node.
       - When C(unset), the resource will be unset on the NetScaler ADC node.
+      - When C(renamed), the resource will be renamed on the NetScaler ADC node.
     type: str
   comment:
     type: str

plugins/modules/appfwpolicylabel.py

@@ -30,13 +30,15 @@
     choices:
       - present
       - absent
+      - renamed
     default: present
     description:
       - The state of the resource being configured by the module on the NetScaler
         ADC node.
       - When C(present), the resource will be added/updated configured according to
         the module's parameters.
       - When C(absent), the resource will be deleted from the NetScaler ADC node.
+      - When C(renamed), the resource will be renamed on the NetScaler ADC node.
     type: str
   labelname:
     type: str

plugins/modules/authenticationloginschemapolicy.py

@@ -31,6 +31,7 @@
       - present
       - absent
       - unset
+      - renamed
     default: present
     description:
       - The state of the resource being configured by the module on the NetScaler
@@ -39,6 +40,7 @@
         the module's parameters.
       - When C(absent), the resource will be deleted from the NetScaler ADC node.
       - When C(unset), the resource will be unset on the NetScaler ADC node.
+      - When C(renamed), the resource will be renamed on the NetScaler ADC node.
     type: str
   action:
     type: str

plugins/modules/authenticationoauthidppolicy.py

@@ -31,6 +31,7 @@
       - present
       - absent
       - unset
+      - renamed
     default: present
     description:
       - The state of the resource being configured by the module on the NetScaler
@@ -39,6 +40,7 @@
         the module's parameters.
       - When C(absent), the resource will be deleted from the NetScaler ADC node.
       - When C(unset), the resource will be unset on the NetScaler ADC node.
+      - When C(renamed), the resource will be renamed on the NetScaler ADC node.
     type: str
   action:
     type: str