cisco.dnac.lan_automation_log_by_serial_number_info module – Information module for Lan Automation Log By Serial Number
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_log_by_serial_number_info
.
New in cisco.dnac 3.1.0
Synopsis
Get Lan Automation Log By Serial Number by id.
Invoke this API to get the LAN Automation session logs for individual devices based on the given LAN Automation session id and device serial number.
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: |
|
Additional headers. |
|
Id path parameter. LAN Automation session identifier. |
|
LogLevel query parameter. Supported levels are ERROR, INFO, WARNING, TRACE, CONFIG and ALL. Specifying ALL will display device specific logs with the exception of CONFIG logs. In order to view CONFIG logs along with the remaining logs, please leave the query parameter blank. |
|
SerialNumber path parameter. Device serial number. |
|
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_logs_for_individual_devices,
Paths used are get /dna/intent/api/v1/lan-automation/log/{id}/{serialNumber},
Supports
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 LANAutomationLogsForIndividualDevices
Complete reference of the LANAutomationLogsForIndividualDevices API.
Examples
- name: Get Lan Automation Log By Serial Number by id
cisco.dnac.lan_automation_log_by_serial_number_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}}"
logLevel: string
id: string
serialNumber: string
register: result
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: |