cisco.dnac.lan_automation_update_v2 module – Resource module for Lan Automation Update V2
Note
This module is part of the cisco.dnac collection (version 6.18.0).
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.lan_automation_update_v2
.
New in cisco.dnac 6.14.0
Synopsis
Manage operation update of the resource Lan Automation Update V2.
Invoke this API to stop LAN Automation and update device parameters such as Loopback0 IP address and/or hostname discovered in the current session.
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: |
|
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: |
|
Id path parameter. LAN Automation id can be obtained from /dna/intent/api/v1/lan-automation/status. |
|
Lan Automation Update V2’s payload. |
|
Device Management IP Address. |
|
New hostname to be assigned to the device. |
|
New Loopback0 IP Address from LAN pool of Device Discovery Site. |
|
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_stop_and_update_devices_v2,
Paths used are put /dna/intent/api/v2/lan-automation/{id},
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 LANAutomationStopAndUpdateDevicesV2
Complete reference of the LANAutomationStopAndUpdateDevicesV2 API.
Examples
- name: Update by id
cisco.dnac.lan_automation_update_v2:
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}}"
id: string
payload:
- deviceManagementIPAddress: string
newHostName: 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: |