cisco.dnac.lan_automation_update_device module -- Resource module for Lan Automation Updatedevice
Note
This module is part of the cisco.dnac collection (version 6.24.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.lan_automation_update_device
.
New in cisco.dnac 6.14.0
Synopsis
Manage operation update of the resource Lan Automation Updatedevice.
Invoke this API to perform a DAY-N update on LAN Automation-related devices. Supported features include Loopback0 IP update, hostname update, link addition, and link deletion.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices: |
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: :ansible-option-default:`443` |
|
The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
Feature query parameter. Feature ID for the update. Supported feature IDs include LOOPBACK0_IPADDRESS_UPDATE, HOSTNAME_UPDATE, LINK_ADD, and LINK_DELETE. |
|
Lan Automation Update Device's hostnameUpdateDevices. |
|
Device Management IP Address. |
|
New hostname for the device. |
|
Lan Automation Update Device's linkUpdate. |
|
Destination Device Interface Name. |
|
Destination Device Management IP Address. |
|
Name of the IP LAN Pool, required for Link Add should be from discovery site of source and destination device. |
|
Source Device Interface Name. |
|
Source Device Management IP Address. |
|
Lan Automation Update Device's loopbackUpdateDeviceList. |
|
Device Management IP Address. |
|
New Loopback0 IP Address from LAN Pool of Device Discovery Site(Shared pool should not be used). |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are lan_automation.LanAutomation.lan_automation_device_update,
Paths used are put /dna/intent/api/v1/lan-automation/updateDevice,
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
See Also
See also
- Cisco DNA Center documentation for LAN Automation LANAutomationDeviceUpdate
Complete reference of the LANAutomationDeviceUpdate API.
Examples
- name: Update all
cisco.dnac.lan_automation_updateDevice:
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}}"
feature: string
hostnameUpdateDevices:
- deviceManagementIPAddress: string
newHostName: string
linkUpdate:
destinationDeviceInterfaceName: string
destinationDeviceManagementIPAddress: string
ipPoolName: string
sourceDeviceInterfaceName: string
sourceDeviceManagementIPAddress: string
loopbackUpdateDeviceList:
- deviceManagementIPAddress: string
newLoopback0IPAddress: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` |