cisco.catalystcenter.lan_automation_update_device module -- Resource module for Lan Automation Update Device

Note

This module is part of the cisco.catalystcenter collection (version 2.2.2).

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

To use it in a playbook, specify: cisco.catalystcenter.lan_automation_update_device.

New in cisco.catalystcenter 6.14.0

Synopsis

  • Manage operation update of the resource Lan Automation Update Device. - > 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.

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

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

Default: :ansible-option-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. It is optional for Link Delete.

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 Catalyst 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 uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for LAN Automation LANAutomationDeviceUpdate

Complete reference of the LANAutomationDeviceUpdate API.

Examples

---
- name: Update all
  cisco.catalystcenter.lan_automation_update_device:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)