Provision workflow feature #440

syed-khadeerahmed · 2024-10-22T05:21:51Z

Description

2 bugs fixed
Wireless provisioning getting TypeError: 'NoneType' object is not iterable
[IaC2][Provision]: Unexpected Success During Wireless Device Re-provisioning

Type of Change

Bug fix
New feature
Breaking change
Documentation update

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules
All the sanity checks have been completed and the sanity test cases have been executed

Ansible Best Practices

Tasks are idempotent (can be run multiple times without changing state)
Variables and secrets are handled securely (e.g., using ansible-vault or environment variables)
Playbooks are modular and reusable
Handlers are used for actions that need to run on change

Documentation

All options and parameters are documented clearly.
Examples are provided and tested.
Notes and limitations are clearly stated.

Screenshots (if applicable)

Notes to Reviewers

…low_feature

madhansansel · 2024-10-23T07:17:14Z

plugins/modules/provision_workflow_manager.py

+        primary_managed_ap_locations:
+            description:
+                - List of site locations allocated for the primary managed Access Points (APs).
+                - This is mandatory for provisioning wireless devices if the managed AP location is not set.


We use required

- Required for provisioning wireless devices if the managed AP location is not set.

madhansansel · 2024-10-23T07:17:26Z

plugins/modules/provision_workflow_manager.py

+            description:
+                - List of site locations allocated for the primary managed Access Points (APs).
+                - This is mandatory for provisioning wireless devices if the managed AP location is not set.
+                - Supported in Cisco Catalyst version 2.3.7.6 and above.


- Supported in Cisco Catalyst version 2.3.7.6 and later.

madhansansel · 2024-10-23T07:18:30Z

plugins/modules/provision_workflow_manager.py

@@ -73,6 +73,20 @@
                - This is mandatory for provisioning of wireless devices.
            type: list
            elements: str
+        primary_managed_ap_locations:
+            description:
+                - List of site locations allocated for the primary managed Access Points (APs).


- List of site locations assigned to primary managed Access Points (APs).

madhansansel · 2024-10-23T07:20:01Z

plugins/modules/provision_workflow_manager.py

+            elements: str
+        secondary_managed_ap_locations:
+            description:
+                - List of site locations allocated for the secondary managed Access Points (APs).


- List of site locations assigned to secondary managed Access Points (APs).

madhansansel · 2024-10-23T07:20:38Z

plugins/modules/provision_workflow_manager.py

+        secondary_managed_ap_locations:
+            description:
+                - List of site locations allocated for the secondary managed Access Points (APs).
+                - This is mandatory for provisioning wireless devices if the managed AP location is not set.


- Required for provisioning wireless devices if the managed AP location is not set.

plugins/modules/provision_workflow_manager.py

madhansansel · 2024-10-23T08:13:49Z

plugins/modules/provision_workflow_manager.py

+        already_provisioned_site = self.find_device_site(device_id)
+
+        if already_provisioned_site != self.site_name:
+            self.log("inside new logic")


self.log("Device re-provisioning logic triggered.", "INFO")

madhansansel · 2024-10-23T09:07:17Z

plugins/modules/provision_workflow_manager.py

@@ -1049,7 +1119,7 @@ def provision_wired_device(self, to_provisioning, to_force_provisioning):
        if status == "success":
            if not to_force_provisioning:
                self.result["changed"] = False
-                msg = "Device '{0}' is already provisioned.".format(self.validated_config.get("management_ip_address"))
+                msg = "wired Device '{0}' is already provisioned.".format(self.validated_config.get("management_ip_address"))


Wired device
or
The wired device

madhansansel · 2024-10-23T09:09:48Z

plugins/modules/provision_workflow_manager.py

+            if primary_ap_location:
+                self.log("Processing primary access point locations", "INFO")
+                for primary_sites in primary_ap_location:
+                    self.log("Retrieving site ID for primary location: {0}".format(primary_ap_location), "DEBUG")


Hope you wanted to print the primary_sites instead of primary_ap_location

self.log("Retrieving site ID for primary location: {0}".format(primary_sites), "DEBUG")

madhansansel · 2024-10-23T09:10:32Z

plugins/modules/provision_workflow_manager.py

+            if secondary_ap_location:
+                self.log("Processing secondary access point locations", "INFO")
+                for secondary_sites in secondary_ap_location:
+                    self.log("Retrieving site ID for secondary location: {0}".format(secondary_ap_location), "DEBUG")


self.log("Retrieving site ID for secondary location: {0}".format(secondary_sites), "DEBUG")

madhansansel · 2024-10-23T16:55:03Z

plugins/modules/provision_workflow_manager.py

                    type: bool
                    default: false
                ap_reboot_percentage:
                    description:
                      - The percentage of APs to reboot simultaneously during an upgrade.
                      - Must be an integer value, typically between 1 and 100, indicating the proportion of APs to upgrade at a time.
+                      - Supported in Cisco Catalyst version 2.3.7.6 and later.
+                      - Permissible values are - 5, 15, 25


We're stating the value between 1 and 100. But here, we're saying that the allowed values are 5, 15, 25. Is that right? Also we specify the default value as 20..

If you want to stick with 5, 15, 20, and 25 as the permissible values, you could update the description like this:

- Must be one of the permissible values: 5, 15, 20, or 25, representing the proportion of APs to reboot at once. - Default value is 20.

yes, Madhan the permissible values - [5, 15, 25] and I have remove the default value as 20 and updated the code

madhansansel · 2024-10-24T07:01:51Z

plugins/modules/provision_workflow_manager.py

            type: dict
            suboptions:
                enable_rolling_ap_upgrade:
                    description:
                      - Enable or disable the rolling AP upgrade feature.
                      - If set to 'true', APs will be upgraded in batches based on the specified reboot percentage.
+                      - Supported in Cisco Catalyst version 2.3.7.6 and later.
                    type: bool
                    default: false
                ap_reboot_percentage:
                    description:
                      - The percentage of APs to reboot simultaneously during an upgrade.
                      - Must be an integer value, typically between 1 and 100, indicating the proportion of APs to upgrade at a time.


Do we need this? Do we support it? can you check my earlier comment?

madhansansel · 2024-10-24T09:16:16Z

plugins/modules/provision_workflow_manager.py

                    type: bool
                    default: false
                ap_reboot_percentage:
                    description:
                      - The percentage of APs to reboot simultaneously during an upgrade.
-                      - Must be an integer value, typically between 1 and 100, indicating the proportion of APs to upgrade at a time.
+                      - Supported in Cisco Catalyst version 2.3.7.6 and later.
+                      - Must be one of the permissible values - 5, 15, or 25, representing the proportion of APs to reboot at once.


- Must be either 5, 15 or 25 representing the proportion of APs to reboot at once.

5 may mislead to -5

syed-khadeerahmed added 10 commits October 4, 2024 08:42

Coding started

117e3cd

Merge remote-tracking branch 'madhansansel/main' into provision_workf…

015504f

…low_feature

added parameters for new wireless provision

c3fba6f

re-provision pending for version 2.3.7.6

4d96b31

provision code compleated

5731350

Merge remote-tracking branch 'madhansansel/main' into provision_workf…

a7aeddf

…low_feature

bug fixed testing need to be done

72c9329

tests compleated for the wireless reprovision

cdd4fe5

testing compleated

1016c17

bug fixed

fda98a4

syed-khadeerahmed requested a review from madhansansel as a code owner October 22, 2024 05:21

sanity fixed

30f7566

madhansansel reviewed Oct 23, 2024

View reviewed changes

syed-khadeerahmed added 2 commits October 23, 2024 16:39

review comments fixed

9be6cda

review comments fixed

f2725e9

madhansansel reviewed Oct 23, 2024

View reviewed changes

syed-khadeerahmed and others added 3 commits October 24, 2024 11:18

addressed review comments

f0dd351

Merge branch 'main' into provision_workflow_feature

065184f

minor fix in inventory

1614d71

madhansansel reviewed Oct 24, 2024

View reviewed changes

review comments fixed

e02447e

madhansansel reviewed Oct 24, 2024

View reviewed changes

review comments fixed

b111f3b

madhansansel approved these changes Oct 24, 2024

View reviewed changes

madhansansel merged commit c56556c into madhansansel:main Oct 24, 2024
5 of 6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Provision workflow feature #440

Provision workflow feature #440

syed-khadeerahmed commented Oct 22, 2024 •

edited

Loading

madhansansel Oct 23, 2024

madhansansel Oct 23, 2024

madhansansel Oct 23, 2024

madhansansel Oct 23, 2024

madhansansel Oct 23, 2024

madhansansel Oct 23, 2024

madhansansel Oct 23, 2024

madhansansel Oct 23, 2024

madhansansel Oct 23, 2024

madhansansel Oct 23, 2024

syed-khadeerahmed Oct 24, 2024

madhansansel Oct 24, 2024

madhansansel Oct 24, 2024

Provision workflow feature #440

Provision workflow feature #440

Conversation

syed-khadeerahmed commented Oct 22, 2024 • edited Loading

Description

Type of Change

Checklist

Ansible Best Practices

Documentation

Screenshots (if applicable)

Notes to Reviewers

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

syed-khadeerahmed commented Oct 22, 2024 •

edited

Loading