dcnm_bootflash module

[allenrobel]

Summary

This PR provides the following:

• dcnm_bootflash module
  • Ability to list files in the root directory of flash devices on NX-OS switches via NDFC.
  • Ability to delete files in the root directory of flash devices on NX-OS switches via NDFC.
  • Supports filename globbing using PurePosixPath for listing/deleting matching files so users do not need to explicitly specify each file.
• Unit and Integration tests for the dcnm_bootflash module.

Branch

dcnm_bootflash created off of branch dcnm_fabric_v2

Unit test coverage

• 99% bootflash_files.py
• 100% bootflash_info.py
• 100% convert_file_info_to_target.py
• 100% convert_target_to_params.py
• 89% dcnm_bootflash.py

Integration test coverage

Roles

• dcnm_bootflash_deleted_specific.yaml
• dcnm_bootflash_deleted_wildcard.yaml
• dcnm_bootflash_query_specific.yaml
• dcnm_bootflash_query_wildcard.yaml

Playbooks

There didn't seem to be a good way to use a Role within dcnm_bootflash to create files, since that role would use ndfc as the host rather than the switches themselves (create_files.yaml uses cisco.nxos.nxos_command to create the test files directly on the switches, since NDFC doesn't offer a way to create files on a switch, other than to create an image_policy and upload large images, which is way too heavy-weight for this task).

Instead, we are using a separate playbook to create the test files. Or the person running the integration tests can manually create the files on the switch using switch CLI e.g.: switch# echo foo > bootflash:/air.ndfc_ut.

• playbooks/roles/dcnm_bootflash/create_files.yaml
  • reads vars from playbooks/roles/dcnm_bootflash/nxos_vars.yaml

New files

• modules/dcnm_bootflash.py - main module code implementing deleted and query states.
• module_utils/common/api/v1/imagemanagement/rest/discovery/discovery.py - endpoint definition for bootflash-discovery.
• module_utils/common/api/v1/imagemanagement/rest/imagemgnt/bootflash/bootflash.py - endpoint definitions for bootflash-files and bootflash-info.
• module_utils/bootflash/bootflash_info.py - list files on the root directory of all flash devices (partitions) on a switch.
• module_utils/bootflash/bootflash_files.py - delete files on the root directory of a specific switch, partition, supervisor
• modules_utils/bootflash/convert_file_info_to_target.py - Convert a file_info dict (retrieved from NDFC) into a target dict (which fixes the leading space in ipAddr in NDFC's file_info dict, and constructs a filepath from e.g. partition, fileName, and filePath in the info_dict which can be easily matched using PurePosixPath()). target also includes ip_address and serial_number to give users complete information about files matched and/or deleted.
• module_utils/bootflash/convert_target_to_params.py - Class to parse partition:/filepath/filename into constituent API parameters.
• playbooks/roles/dcnm_bootflash/create_files.yaml
• playbooks/roles/dcnm_bootflash/dcnm_hosts.yaml
• playbooks/roles/dcnm_bootflash/dcnm_tests.yaml
• playbooks/roles/dcnm_bootflash/nxos_vars.yaml
• tests/integration/targets/dcnm_bootflash/*
• tests/unit/modules/dcnm/dcnm_bootflash/*

Example Playbooks

Query all text files on bootflash on the active supervisor of switches 192.168.1.1 and 192.168.1.2

- name: QUERY - TEST - Query files
  cisco.dcnm.dcnm_bootflash:
      state: query
      config:
        targets:
          - filepath: bootflash:/*.txt
            supervisor: active
        switches:
          - ip_address: 192.168.1.1
          - ip_address: 192.168.1.2

deleted state

• On 192.168.1.1, delete from all flash devices on the standby supervisor all log files with names indicating they are circa July 2024.
• On 192.168.1.2, delete foo.txt from the bootflash on the active supervisor, and delete bar.txt from the bootflash on the standby supervisor.

- name: Delete files
  cisco.dcnm.dcnm_bootflash:
      state: deleted
      config:
        targets:
          - filepath: *:/202407??.txt
            supervisor: standby
        switches:
          - ip_address: 192.168.1.1
          - ip_address: 192.168.1.2
            targets:
              - filepath: bootflash:/foo.txt
                supervisor: active
              - filepath: bootflash:/bar.txt
                supervisor: standby

[mikewiebe]

@allenrobel I generated and added the docs for this module to the PR