cisco.dnac.lan_automation_update_device module – Resource module for Lan Automation Update Device

Note

This module is part of the cisco.dnac collection (version 6.25.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_device.

New in cisco.dnac 6.14.0

Synopsis

  • This module represents an alias of the module lan_automation_update_device_v1

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

feature

string

Feature query parameter. Feature ID for the update. Supported feature IDs include LOOPBACK0_IPADDRESS_UPDATE, HOSTNAME_UPDATE, LINK_ADD, and LINK_DELETE.

hostnameUpdateDevices

list / elements=dictionary

Lan Automation Update Device’s hostnameUpdateDevices.

deviceManagementIPAddress

string

Device Management IP Address.

newHostName

string

New hostname for the device.

linkUpdate

dictionary

Lan Automation Update Device’s linkUpdate.

destinationDeviceInterfaceName

string

Destination Device Interface Name.

destinationDeviceManagementIPAddress

string

Destination Device Management IP Address.

ipPoolName

string

Name of the IP LAN Pool, required for Link Add should be from discovery site of source and destination device.

sourceDeviceInterfaceName

string

Source Device Interface Name.

sourceDeviceManagementIPAddress

string

Source Device Management IP Address.

loopbackUpdateDeviceList

list / elements=dictionary

Lan Automation Update Device’s loopbackUpdateDeviceList.

deviceManagementIPAddress

string

Device Management IP Address.

newLoopback0IPAddress

string

New Loopback0 IP Address from LAN Pool of Device Discovery Site(Shared pool should not be used).

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are lan_automation.LanAutomation.lan_automation_device_update_v1,

  • Paths used are put /dna/intent/api/v1/lan-automation/updateDevice,

  • It should be noted that this module is an alias of lan_automation_update_device_v1

  • 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 LANAutomationDeviceUpdateV1

Complete reference of the LANAutomationDeviceUpdateV1 API.

Examples

- name: Update all
  cisco.dnac.lan_automation_update_device:
    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

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)