cisco.catalystcenter.sda_fabric_devices_layer2_handoffs_info module -- Information module for Sda Fabricdevices Layer2handoffs

Note

This module is part of the cisco.catalystcenter collection (version 2.2.1).

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

New in cisco.catalystcenter 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.

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catc_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

fabricId

string

FabricId query parameter. ID of the fabric this device belongs to.

headers

dictionary

Additional headers.

limit

float

Limit query parameter. Maximum number of records to return. The maximum number of objects supported in a single request is 500.

networkDeviceId

string

NetworkDeviceId query parameter. Network device ID of the fabric device.

offset

float

Offset query parameter. Starting record for pagination.

validate_response_schema

boolean

Flag for Cisco Catalyst 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 uses the embedded connection manager from Cisco CATALYST SDK

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.catalystcenter.sda_fabricDevices_layer2Handoffs_info:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_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

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": [{"externalVlanId": 0, "fabricId": "string", "id": "string", "interfaceName": "string", "internalVlanId": 0, "networkDeviceId": "string"}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)