Merge pull request #315 from CiscoDevNet/dcnm_image_upgrade_v2_backup

Dcnm image upgrade v2

Author: mikewiebe

playbooks/roles/dcnm_image_upgrade/dcnm_hosts.yaml

@@ -0,0 +1,15 @@
+all:
+  vars:
+    ansible_user: "admin"
+    ansible_password: "password-ndfc"
+    switch_password: "password-switch"
+    ansible_python_interpreter: python
+    ansible_httpapi_validate_certs: False
+    ansible_httpapi_use_ssl: True
+  children:
+    ndfc:
+      vars:
+        ansible_connection: ansible.netcommon.httpapi
+        ansible_network_os: cisco.dcnm.dcnm
+      hosts:
+        192.168.1.1:

playbooks/roles/dcnm_image_upgrade/dcnm_tests.yaml

@@ -0,0 +1,46 @@
+---
+# This playbook can be used to execute integration tests for
+# the role located in:
+#
+# tests/integration/targets/dcnm_image_upgrade
+#
+# Modify the hosts and vars sections with details for your testing
+# setup and uncomment the testcase you want to run.
+#
+- hosts: dcnm
+  gather_facts: no
+  connection: ansible.netcommon.httpapi
+
+  vars:
+    # testcase: 00_setup_create_fabric
+    # testcase: 01_setup_add_switches_to_fabric
+    # testcase: 02_setup_replace_image_policies
+    # testcase: deleted
+    # testcase: deleted_1x_switch
+    # testcase: merged_global_config
+    # testcase: merged_override_global_config
+    # testcase: query
+    fabric_name: LAN_Classic_Fabric
+    switch_username: admin
+    switch_password: "{{ switch_password }}"
+    leaf1: 192.168.1.2
+    leaf2: 192.168.1.3
+    spine1: 192.168.1.4
+    # for dcnm_image_policy and dcnm_image_upgrade roles
+    image_policy_1: NR1F
+    image_policy_2: NR2F
+    # for dcnm_image_policy role
+    epld_image_1: n9000-epld.10.3.1.F.img
+    epld_image_2: n9000-epld.10.3.1.F.img
+    nxos_image_1: nxos64-cs.10.3.1.F.bin
+    nxos_image_2: nxos64-cs.10.3.2.F.bin
+    nxos_release_1: 10.3.1_nxos64-cs_64bit
+    nxos_release_2: 10.3.2_nxos64-cs_64bit
+    # for dcnm_image_upgrade role
+    fabric_name_1: "{{ fabric_name }}"
+    ansible_switch_1: "{{ leaf1 }}"
+    ansible_switch_2: "{{ leaf2 }}"
+    ansible_switch_3: "{{ spine1 }}"
+
+  roles:
+    - dcnm_image_upgrade

plugins/module_utils/common/api/v1/imagemanagement/rest/packagemgnt/packagemgnt.py

@@ -0,0 +1,87 @@
+# Copyright (c) 2024 Cisco and/or its affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+__author__ = "Allen Robel"
+
+import logging
+
+from ansible_collections.cisco.dcnm.plugins.module_utils.common.api.v1.imagemanagement.rest.rest import \
+    Rest
+
+
+class PackageMgnt(Rest):
+    """
+    ## api.v1.imagemanagement.rest.packagemgnt.PackageMgnt()
+
+    ### Description
+    Common methods and properties for PackageMgnt() subclasses
+
+    ### Path
+    ``/appcenter/cisco/ndfc/api/v1/imagemanagement/rest/packagemgnt``
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.class_name = self.__class__.__name__
+        self.log = logging.getLogger(f"dcnm.{self.class_name}")
+        self.packagemgnt = f"{self.rest}/packagemgnt"
+        self.log.debug("ENTERED api.v1.PackageMgnt()")
+
+
+class EpIssu(PackageMgnt):
+    """
+    ## api.v1.imagemanagement.rest.packagemgnt.EpIssu()
+
+    ### Description
+    Return endpoint information.
+
+    ### Raises
+    -   None
+
+    ### Path
+    -   ``/api/v1/imagemanagement/rest/packagemgnt/issu``
+
+    ### Verb
+    -   GET
+
+    ### Parameters
+    -   path: retrieve the path for the endpoint
+    -   verb: retrieve the verb for the endpoint
+
+    ### Usage
+    ```python
+    instance = EpIssu()
+    path = instance.path
+    verb = instance.verb
+    ```
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.class_name = self.__class__.__name__
+        self.log = logging.getLogger(f"dcnm.{self.class_name}")
+        msg = "ENTERED api.v1.imagemanagement.rest."
+        msg += f"packagemgnt.{self.class_name}"
+        self.log.debug(msg)
+
+    @property
+    def path(self):
+        return f"{self.packagemgnt}/issu"
+
+    @property
+    def verb(self):
+        return "GET"

plugins/module_utils/common/api/v1/imagemanagement/rest/policymgnt/policymgnt.py

@@ -299,18 +299,52 @@ def __init__(self):
         super().__init__()
         self.class_name = self.__class__.__name__
         self.log = logging.getLogger(f"dcnm.{self.class_name}")
+        self._serial_numbers = None
         msg = "ENTERED api.v1.imagemanagement.rest."
         msg += f"policymgnt.{self.class_name}"
         self.log.debug(msg)
 
     @property
     def path(self):
-        return f"{self.policymgnt}/detach-policy"
+        """
+        ### Summary
+        The endpoint path.
+
+        ### Raises
+        -   ``ValueError`` if:
+                -   ``path`` is accessed before setting ``serial_numbers``.
+        """
+        if self.serial_numbers is None:
+            msg = f"{self.class_name}.serial_numbers must be set before "
+            msg += f"accessing {self.class_name}.path."
+            raise ValueError(msg)
+        query_param = ",".join(self.serial_numbers)
+        return f"{self.policymgnt}/detach-policy?serialNumber={query_param}"
 
     @property
     def verb(self):
         return "DELETE"
 
+    @property
+    def serial_numbers(self):
+        """
+        ### Summary
+        A ``list`` of switch serial numbers.
+
+        ### Raises
+        -   ``TypeError`` if:
+                -   ``serial_numbers`` is not a ``list``.
+        """
+        return self._serial_numbers
+
+    @serial_numbers.setter
+    def serial_numbers(self, value):
+        if not isinstance(value, list):
+            msg = f"{self.class_name}.serial_numbers must be a list "
+            msg += "of switch serial numbers."
+            raise TypeError(msg)
+        self._serial_numbers = value
+
 
 class EpPolicyEdit(PolicyMgnt):
     """