cisco.dnac.device_interface_v1_info module – Information module for Device Interface V1
Note
This module is part of the cisco.dnac collection (version 6.31.3).
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.device_interface_v1_info.
New in cisco.dnac 3.1.0
Synopsis
Get all Device Interface V1.
Get Device Interface V1 by id.
Returns all available interfaces. This endpoint can return a maximum of 500 interfaces.
Returns the interface for the given interface ID.
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 |
|---|---|
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. Interface ID. |
|
LastInputTime query parameter. Last Input Time. |
|
LastOutputTime query parameter. Last Output Time. |
|
Limit query parameter. The number of records to show for this page. Min 1, Max 500. |
|
Offset query parameter. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are devices.Devices.get_all_interfaces_v1, devices.Devices.get_interface_by_id_v1,
Paths used are get /dna/intent/api/v1/interface, get /dna/intent/api/v1/interface/{id},
Supports
check_modeThe 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 Devices GetAllInterfacesV1
Complete reference of the GetAllInterfacesV1 API.
- Cisco DNA Center documentation for Devices GetInterfaceByIdV1
Complete reference of the GetInterfaceByIdV1 API.
Examples
- name: Get all Device Interface V1
cisco.dnac.device_interface_v1_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
lastInputTime: string
lastOutputTime: string
register: result
- name: Get Device Interface V1 by id
cisco.dnac.device_interface_v1_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
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: |