[ignore] fixed nd_backup_restore module

Author: sajagana

plugins/modules/nd_backup.py

@@ -2,6 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Copyright: (c) 2023, Shreyas Srish (@shrsr) <[email protected]>
+# Copyright: (c) 2025, Sabari Jaganathan (@sajagana) <[email protected]>
 # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from __future__ import absolute_import, division, print_function
@@ -19,6 +20,7 @@
 - Manages backup of the cluster configuration.
 author:
 - Shreyas Srish (@shrsr)
+- Sabari Jaganathan (@sajagana)
 options:
   name:
     description:

plugins/modules/nd_backup_restore.py

@@ -2,6 +2,7 @@
 # -*- coding: utf-8 -*-
 
 # Copyright: (c) 2023, Shreyas Srish (@shrsr) <[email protected]>
+# Copyright: (c) 2025, Sabari Jaganathan (@sajagana) <[email protected]>
 # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from __future__ import absolute_import, division, print_function
@@ -19,6 +20,7 @@
 - Manages importing the cluster configuration using a backup.
 author:
 - Shreyas Srish (@shrsr)
+- Sabari Jaganathan (@sajagana)
 options:
   name:
     description:
@@ -41,6 +43,24 @@
     - This key is required when querying or deleting a restored job among multiple restored jobs that have the same name.
     - This key can be obtained by querying a restored job.
     type: str
+  ignore_persistent_ips:
+    description:
+    - When the O(ignore_persistent_ips=true), will overwrite the existing external service IP addresses configured on the Nexus Dashboard.
+    type: bool
+    aliases: [ ignore_external_service_ip_configuration ]
+  restore_type:
+    description:
+    - This parameter is only supported on ND v3.2.1 and later.
+    - The O(restore_type=config_only) option restores only configuration settings of the Nexus Dashboard.
+    - The O(backup_type=full) option restores the entire settings of the Nexus Dashboard.
+    type: str
+    choices: [ config_only, full ]
+    default: config_only
+    aliases: [ type ]
+  remote_location:
+    description:
+    - The name of the remote storage location. This parameter is only supported on ND v3.2.1 and later.
+    type: str
   state:
     description:
     - Use C(restore) for importing a backup of the cluster config.
@@ -84,6 +104,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible_collections.cisco.nd.plugins.module_utils.nd import NDModule, nd_argument_spec
+from ansible_collections.cisco.nd.plugins.module_utils.utils import snake_to_camel
 
 
 def main():
@@ -94,14 +115,16 @@ def main():
         file_location=dict(type="str"),
         restore_key=dict(type="str", no_log=False),
         state=dict(type="str", default="restore", choices=["restore", "query", "absent"]),
+        ignore_persistent_ips=dict(type="bool", aliases=["ignore_external_service_ip_configuration"]),
+        restore_type=dict(type="str", default="config_only", choices=["config_only", "full"], aliases=["type"]),
+        remote_location=dict(type="str"),
     )
 
     module = AnsibleModule(
         argument_spec=argument_spec,
         supports_check_mode=True,
         required_if=[
-            ["state", "restore", ["name", "encryption_key", "file_location"]],
-            ["state", "absent", ["name"]],
+            ["state", "restore", ["encryption_key"]],
         ],
     )
 
@@ -112,10 +135,89 @@ def main():
     restore_key = nd.params.get("restore_key")
     file_location = nd.params.get("file_location")
     state = nd.params.get("state")
+    ignore_persistent_ips = nd.params.get("ignore_persistent_ips")
+    restore_type = snake_to_camel(nd.params.get("restore_type"))
+    remote_location = nd.params.get("remote_location")
 
     if encryption_key is not None and len(encryption_key) < 8:
         nd.fail_json("The encryption key must have a minium of 8 characters.")
 
+    if nd.version < "3.2.1":
+        nd_backup_restore_before_3_2_1(nd, name, encryption_key, file_location, restore_key, state, module)
+    elif nd.version >= "3.2.1":
+        nd_backup_restore_from_3_2_1(nd, name, encryption_key, file_location, state, module, ignore_persistent_ips, restore_type, remote_location)
+    nd.exit_json()
+
+
+def nd_backup_restore_from_3_2_1(nd, name, encryption_key, file_location, state, module, ignore_persistent_ips, restore_type, remote_location):
+    if name and (remote_location or file_location):
+        nd.fail_json("The parameters name and (remote_location or file_location) cannot be specified at the same time.")
+
+    nd.existing = nd.query_obj("/api/v1/infra/backups/status")
+    import_path = "/api/v1/infra/backups/actions/import"
+
+    # Remove backup status (not idempotent)
+    if state == "absent" and (not nd.existing or nd.existing.get("state") != "processing"):
+        nd.previous = nd.existing
+        if not module.check_mode:
+            nd.request(import_path, method="DELETE")
+
+    # Restore from backup (not idempotent)
+    elif state == "restore" and (not nd.existing or nd.existing.get("state") != "processing"):
+
+        if not module.check_mode:  # Need to delete the imported file before starting the restore process
+            nd.request(import_path, method="DELETE")
+
+        import_payload = {"encryptionKey": encryption_key}
+
+        if remote_location and file_location and not name:
+            import_payload.update({"source": remote_location, "path": file_location})
+        elif not remote_location and file_location and not name:
+            # Local file upload
+            if not module.check_mode:
+                import_payload["path"] = nd.request(
+                    "/api/action/class/backuprestore/file-upload", method="POST", data=None, file=file_location, file_key="files", output_format="raw"
+                )
+        elif name:
+            import_payload["name"] = name.split(".")[0]  # Restore operation requires only name of the backup file
+
+        nd.sanitize(import_payload, collate=True)
+
+        restore_payload = {
+            "ignorePersistentIPs": ignore_persistent_ips
+            or False,  # add note to the document saying that ignore_persistent_ips set to false when it is not specified
+            "type": restore_type or "configOnly",  # add note to the document saying that restore_type set to configOnly when it is not specified
+        }
+        nd_payload = {
+            "fileUploadPayload": {"fileLocation": file_location},
+            "importPayload": import_payload,
+            "restorePayload": restore_payload,
+        }
+        nd.sanitize(nd_payload, collate=True)
+
+        if not module.check_mode:
+            nd.request(import_path, method="POST", data=import_payload)
+            nd.request("/api/v1/infra/backups/actions/restore", method="POST", data=restore_payload)
+            nd.existing = nd.query_obj("/api/v1/infra/backups/status")
+        else:
+            nd.existing = nd.proposed
+
+    # Operation not allowed if backup status is processing
+    elif state != "query" and nd.existing and nd.existing.get("state") == "processing":
+        nd.fail_json(
+            msg="The {0} operation could not proceed because a system {1} is in progress ({2}% complete).".format(
+                state, nd.existing.get("operation"), nd.existing.get("details", {}).get("progress")
+            )
+        )
+
+
+def nd_backup_restore_before_3_2_1(nd, name, encryption_key, file_location, restore_key, state, module):
+    if state == "restore" and not (name and encryption_key and file_location):
+        nd.fail_json("state is restore but all/one of the following are missing: name, encryption_key, file_location")
+
+    if state == "absent" and not name:
+        nd.fail_json("state is absent but all of the following are missing: name")
+
     path = "/nexus/infra/api/platform/v1/imports"
     # The below path for GET operation is to be replaced by an official documented API endpoint once it becomes available.
     restored_objs = nd.query_obj("/api/config/class/imports")
@@ -156,8 +258,6 @@ def main():
             nd.request(path, method="POST", data=payload, file=file_location, file_key="importfile", output_format="raw")
         nd.existing = nd.proposed
 
-    nd.exit_json()
-
 
 if __name__ == "__main__":
     main()

plugins/modules/nd_rest.py

@@ -48,6 +48,10 @@
     - The file path containing the body of the HTTP request.
     type: path
     aliases: [ config_file ]
+  ignore_previous_state:
+    description:
+    - This parameter ignores the object's previous state.
+    type: bool
 extends_documentation_fragment:
 - cisco.nd.modules
 - cisco.nd.check_mode
@@ -212,6 +216,7 @@ def main():
         ),
         content=dict(type="raw", aliases=["payload"]),
         file_path=dict(type="path", aliases=["config_file"]),
+        ignore_previous_state=dict(type="bool"),
     )
 
     module = AnsibleModule(
@@ -222,6 +227,7 @@ def main():
     content = module.params.get("content")
     path = module.params.get("path")
     file_path = module.params.get("config_file")
+    ignore_previous_state = module.params.get("ignore_previous_state")
 
     nd = NDModule(module)
 
@@ -251,7 +257,8 @@ def main():
 
     # Append previous state of the object
     if method in ("PUT", "DELETE", "PATCH"):
-        nd.existing = nd.previous = sanitize(nd.query_obj(path, ignore_not_found_error=True), ND_REST_KEYS_TO_SANITIZE)
+        if not ignore_previous_state:
+            nd.existing = nd.previous = sanitize(nd.query_obj(path, ignore_not_found_error=True), ND_REST_KEYS_TO_SANITIZE)
     nd.result["previous"] = nd.previous
 
     # Perform request