cisco.catalystcenter.lan_automation_create module -- Resource module for Lan Automation Create

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_create.

New in cisco.catalystcenter 6.0.0

Synopsis

• Manage operation create of the resource Lan Automation Create.

• Invoke this API to start LAN Automation for the given site.

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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
payload list / elements=dictionary	Lan Automation Create's payload.
discoveredDeviceSiteNameHierarchy string	Discovered device site name.
hostNameFileId string	Use /dna/intent/api/v1/file/namespace/nw_orch api to get the file id for the already uploaded file in nw_orch namespace.
hostNamePrefix string	Host name prefix which shall be assigned to the discovered device.
ipPools list / elements=dictionary	Lan Automation Create's ipPools.
ipPoolName string	Name of the IP pool.
ipPoolRole string	Role of the IP pool. Supported roles are MAIN_POOL and PHYSICAL_LINK_POOL.
isisDomainPwd string	IS-IS domain password in plain text.
mulitcastEnabled boolean	To enable underlay native multicast. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
peerDeviceManagmentIPAddress string	Peer seed management IP address.
primaryDeviceInterfaceNames list / elements=string	The list of interfaces on primary seed via which the discovered devices are connected.
primaryDeviceManagmentIPAddress string	Primary seed management IP address.
redistributeIsisToBgp boolean	Advertise LAN Automation summary route into BGP. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are lan_automation.LanAutomation.lan_automation_start,

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

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

Complete reference of the LANAutomationStart API.

Examples

---
- name: Create
  cisco.catalystcenter.lan_automation_create:
    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}}"
    payload:
      - discoveredDeviceSiteNameHierarchy: string
        hostNameFileId: string
        hostNamePrefix: string
        ipPools:
          - ipPoolName: string
            ipPoolRole: string
        isisDomainPwd: string
        mulitcastEnabled: true
        peerDeviceManagmentIPAddress: string
        primaryDeviceInterfaceNames:
          - string
        primaryDeviceManagmentIPAddress: string
        redistributeIsisToBgp: true

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": {"id": "string", "message": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)