cisco.dnac.sda_fabric_devices_layer2_handoffs_info module – Information module for Sda Fabricdevices Layer2handoffs
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.sda_fabric_devices_layer2_handoffs_info
.
New in cisco.dnac 6.14.0
Synopsis
Get all Sda Fabricdevices Layer2handoffs.
Returns a list of layer 2 handoffs of fabric devices that match the provided query parameters.
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: |
|
FabricId query parameter. ID of the fabric this device belongs to. |
|
Additional headers. |
|
Limit query parameter. Maximum number of records to return. |
|
NetworkDeviceId query parameter. Network device ID of the fabric device. |
|
Offset query parameter. Starting record for pagination. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are sda.Sda.get_fabric_devices_layer2_handoffs,
Paths used are get /dna/intent/api/v1/sda/fabricDevices/layer2Handoffs,
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 SDA GetFabricDevicesLayer2Handoffs
Complete reference of the GetFabricDevicesLayer2Handoffs API.
Examples
- name: Get all Sda Fabricdevices Layer2handoffs
cisco.dnac.sda_fabric_devices_layer2_handoffs_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}}"
fabricId: string
networkDeviceId: string
offset: 0
limit: 0
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: |