cisco.dnac.swim_intent module – Intent module for SWIM related functions

Note

This module is part of the cisco.dnac collection (version 6.10.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.swim_intent.

New in cisco.dnac 6.6.0

Synopsis

• Manage operation related to image importation, distribution, activation and tagging image as golden

• API to fetch a software image from remote file system using URL for HTTP/FTP and upload it to DNA Center. Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

• API to fetch a software image from local file system and upload it to DNA Center Supported image files extensions are bin, img, tar, smu, pie, aes, iso, ova, tar_gz and qcow2.

• API to tag/untag image as golen for a given family of devices

• API to distribute a software image on a given device. Software image must be imported successfully into DNA Center before it can be distributed.

• API to activate a software image on a given device. Software image must be present in the device flash.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk == 2.4.5

• python >= 3.5

Parameters

Parameter	Comments
config list / elements=dictionary / required	List of details of SWIM image being managed
image_activation_details dictionary	Details for SWIM image activation. Device on which the image needs to activated can be speciifed using any of the following parameters - deviceSerialNumber, deviceIPAddress, deviceHostname or deviceMacAddress.
activate_lower_image_version boolean	ActivateLowerImageVersion flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
device_family_name string	Device family name
device_hostname string	Device hostname where the image needs to be activated
device_ip_address string	Device IP address where the image needs to be activated
device_mac_address string	Device MAC address where the image needs to be activated
device_role string	Device Role. Permissible Values ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE.
device_serial_number string	Device serial number where the image needs to be activated
device_upgrade_mode string	Swim Trigger Activation’s deviceUpgradeMode.
distributeIfNeeded boolean	DistributeIfNeeded flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
image_name string	SWIM image’s name
schedule_validate boolean	ScheduleValidate query parameter. ScheduleValidate, validates data before schedule (Optional). Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
site_name string	Used to get device details associated to this site.
image_distribution_details dictionary	Details for SWIM image distribution. Device on which the image needs to distributed can be speciifed using any of the following parameters - deviceSerialNumber, deviceIPAddress, deviceHostname or deviceMacAddress.
device_family_name string	Device family name
device_hostname string	Device hostname where the image needs to be distributed
device_ip_address string	Device IP address where the image needs to be distributed
device_mac_address string	Device MAC address where the image needs to be distributed
device_role string	Device Role. Permissible Values ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE.
device_serial_number string	Device serial number where the image needs to be distributed
image_name string	SWIM image’s name
site_name string	Used to get device details associated to this site.
import_image_details dictionary	Details of image being imported
local_image_details dictionary	Details of the local path of the image to be imported.
file_path string	File absolute path.
is_third_party boolean	IsThirdParty query parameter. Third party Image check. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
third_party_application_type string	ThirdPartyApplicationType query parameter. Third Party Application Type.
third_party_image_family string	ThirdPartyImageFamily query parameter. Third Party image family.
third_party_vendor string	ThirdPartyVendor query parameter. Third Party Vendor.
type string	The source of import, supports url import or local import.
url_details dictionary	URL details for SWIM import
payload list / elements=dictionary	Swim Import Via Url’s payload.
application_type string	Swim Import Via Url’s applicationType.
image_family string	Swim Import Via Url’s imageFamily.
source_url string	Swim Import Image Via Url.
third_party boolean	ThirdParty flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
vendor string	Swim Import Via Url’s vendor.
schedule_at string	ScheduleAt query parameter. Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional).
schedule_desc string	ScheduleDesc query parameter. Custom Description (Optional).
schedule_origin string	ScheduleOrigin query parameter. Originator of this call (Optional).
tagging_details dictionary	Details for tagging or untagging an image as golden
device_family_name string	Device family name(Eg Switches and Hubs)
device_role string	Device Role. Permissible Values ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE.
device_type string	Type of the device (Eg Cisco Catalyst 9300 Switch)
image_name string	SWIM image name which will be tagged or untagged as golden.
site_name string	Site name for which SWIM image will be tagged/untagged as golden. If not provided, SWIM image will be mapped to global site.
tagging boolean	Booelan value to tag/untag SWIM image as golden If True then the given image will be tagged as golden. If False then the given image will be un-tagged as golden. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The Cisco DNA Center hostname.
dnac_log boolean	Flag for logging playbook execution details. If set to true the log file will be created at the location of the execution with the name dnac.log Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port string	The Cisco DNA Center port. Default: :ansible-option-default:`"443"`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.2.3.3"`
state string	The state of DNAC after module completion. Choices: :ansible-option-choices-entry-default:`"merged"` ← (default)
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are software_image_management_swim.SoftwareImageManagementSwim.import_software_image_via_url, software_image_management_swim.SoftwareImageManagementSwim.tag_as_golden_image, software_image_management_swim.SoftwareImageManagementSwim.trigger_software_image_distribution, software_image_management_swim.SoftwareImageManagementSwim.trigger_software_image_activation,

• Paths used are post /dna/intent/api/v1/image/importation/source/url, post /dna/intent/api/v1/image/importation/golden, post /dna/intent/api/v1/image/distribution, post /dna/intent/api/v1/image/activation/device,

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

• The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

Examples

- name: Import an image from a URL, tag it as golden and load it on device
  cisco.dnac.swim_intent:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    config:
    - import_image_details:
        type: string
        urlDetails:
          payload:
          - source_url: string
            is_third_party: bool
            image_family: string
            vendor: string
            application_type: string
          schedule_at: string
          schedule_desc: string
          schedule_origin: string
      tagging_details:
        image_name: string
        device_role: string
        device_family_name: string
        site_name: string
        tagging: bool
      image_distribution_details:
        image_name: string
        device_serial_number: string
      image_activation_details:
        schedule_validate: bool
        activate_lower_image_version: bool
        distribute_if_needed: bool
        device_serial_number: string
        image_name: string

- name: Tag the given image as golden and load it on device
  cisco.dnac.swim_intent:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    config:
    - tagging_details:
        image_name: string
        device_role: string
        device_family_name: string
        device_type: string
        site_name: string
        tagging: bool

- name: Distribute the given image on devices associated to that site with specified role.
  cisco.dnac.swim_intent:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    config:
    - image_distribution_details:
        image_name: string
        site_name: string
        device_role: string
        device_family_name: string

- name: Activate the given image on devices associated to that site with specified role.
  cisco.dnac.swim_intent:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    config:
    - image_activation_details:
        image_name: string
        site_name: string
        device_role: string
        device_family_name: string
        scehdule_validate: bool
        activate_lower_image_version: bool
        distribute_if_needed: bool

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

response dictionary

A dictionary with activation details as returned by the DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`"{\\n \\"response\\": {\\n \\"additionalStatusURL\\": String,\\n \\"data\\": String,\\n \\"endTime\\": 0,\\n \\"id\\": String,\\n \\"instanceTenantId\\": String,\\n \\"isError\\": bool,\\n \\"lastUpdate\\": 0,\\n \\"progress\\": String,\\n \\"rootId\\": String,\\n \\"serviceType\\": String,\\n \\"startTime\\": 0,\\n \\"version\\": 0\\n },\\n \\"msg\\": String\\n}\\n"`

Authors

• Madhan Sankaranarayanan (@madhansansel) Rishita Chowdhary (@rishitachowdhary) Abhishek Maheshwari (@abmahesh)

Collection links

Issue Tracker Repository (Sources)