cisco.dnac.swim_intent module – Intent module for SWIM related functions
Note
This module is part of the cisco.dnac collection (version 6.6.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
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 uploads 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 |
|---|---|
List of details of SWIM image being managed |
|
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. |
|
ActivateLowerImageVersion flag. Choices:
|
|
Device hostname where the image needs to be activated |
|
Device IP address where the image needs to be activated |
|
Device MAC address where the image needs to be activated |
|
Device serial number where the image needs to be activated |
|
Swim Trigger Activation’s deviceUpgradeMode. |
|
DistributeIfNeeded flag. Choices:
|
|
SWIM image’s name |
|
ScheduleValidate query parameter. ScheduleValidate, validates data before schedule (Optional). Choices:
|
|
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 hostname where the image needs to be distributed |
|
Device IP address where the image needs to be distributed |
|
Device MAC address where the image needs to be distributed |
|
Device serial number where the image needs to be distributed |
|
SWIM image’s name |
|
Details of image being imported |
|
The source of import (Currently support vis URL). |
|
URL details for SWIM import |
|
Swim Import Via Url’s payload. |
|
Swim Import Via Url’s applicationType. |
|
Swim Import Via Url’s imageFamily. |
|
Swim Import Via Url’s sourceURL. |
|
ThirdParty flag. Choices:
|
|
Swim Import Via Url’s vendor. |
|
ScheduleAt query parameter. Epoch Time (The number of milli-seconds since January 1 1970 UTC) at which the distribution should be scheduled (Optional). |
|
ScheduleDesc query parameter. Custom Description (Optional). |
|
ScheduleOrigin query parameter. Originator of this call (Optional). |
|
Details for tagging or untagging an image as golden |
|
Device family name |
|
Device Role. Permissible Values ALL, UNKNOWN, ACCESS, BORDER ROUTER, DISTRIBUTION and CORE. |
|
SWIM image name which will be tagged or untagged as golden. |
|
Site name for which SWIM image will be tagged/untagged as golden. If not provided, SWIM image will be mapped to global site. |
|
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:
|
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
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:
|
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
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_modeThe 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, 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:
- importImageDetails:
type: string
urlDetails:
payload:
- sourceURL: string
isThirdParty: bool
imageFamily: string
vendor: string
applicationType: string
scheduleAt: string
scheduleDesc: string
scheduleOrigin: string
taggingDetails:
imageName: string
deviceRole: string
deviceFamilyName: string
siteName: string
tagging: bool
imageDistributionDetails:
imageName: string
deviceSerialNumber: string
imageActivationDetails:
scheduleValidate: bool
activateLowerImageVersion: bool
distributeIfNeeded: bool
deviceSerialNumber: string
imageName: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary with activation details as returned by the DNAC Python SDK Returned: always Sample: |
Authors
Madhan Sankaranarayanan (@madhansansel) Rishita Chowdhary (@rishitachowdhary)