cisco.dnac.lan_automation_status_info (6.13.3) — module

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Lan Automation Status.

Get Lan Automation Status by id.

Invoke this API to get the LAN Automation session status based on the given Lan Automation session id.

Invoke this API to get the LAN Automation session status.

Requirements

• dnacentersdk >= 2.6.0
• python >= 3.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get all Lan Automation Status
  cisco.dnac.lan_automation_status_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    offset: 0
    limit: 0
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get Lan Automation Status by id
  cisco.dnac.lan_automation_status_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

Inputs

    
id:
    description:
    - Id path parameter. LAN Automation session identifier.
    type: str

limit:
    description:
    - Limit query parameter. Number of LAN Automation sessions to be retrieved. Limit
      value can range between 1 to 10.
    type: int

offset:
    description:
    - Offset query parameter. Starting index of the LAN Automation session. Minimum value
      is 1.
    type: int

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": [\n    {\n      \"id\": \"string\",\n      \"discoveredDeviceSiteNameHierarchy\"\
    : \"string\",\n      \"primaryDeviceManagmentIPAddress\": \"string\",\n      \"\
    ipPoolList\": [\n        {\n          \"ipPoolName\": \"string\",\n          \"\
    ipPoolRole\": \"string\"\n        }\n      ],\n      \"primaryDeviceInterfaceNames\"\
    : [\n        \"string\"\n      ],\n      \"status\": \"string\",\n      \"action\"\
    : \"string\",\n      \"creationTime\": \"string\",\n      \"multicastEnabled\"\
    : true,\n      \"peerDeviceManagmentIPAddress\": \"string\",\n      \"discoveredDeviceList\"\
    : [\n        {\n          \"name\": \"string\",\n          \"serialNumber\": \"\
    string\",\n          \"state\": \"string\",\n          \"ipAddressInUseList\"\
    : [\n            \"string\"\n          ]\n        }\n      ],\n      \"redistributeIsisToBgp\"\
    : true\n    }\n  ],\n  \"version\": \"string\"\n}\n"
  type: dict

See also

• Cisco DNA Center documentation for LAN Automation LANAutomationStatus: Complete reference of the LANAutomationStatus API. link
• Cisco DNA Center documentation for LAN Automation LANAutomationStatusById: Complete reference of the LANAutomationStatusById API. link