cisco.catalystcenter.sda_fabric_devices_layer2_handoffs_v1 module -- Resource module for Sda Fabric Devices Layer2 Handoffs V1

Note

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

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

New in cisco.catalystcenter 6.14.0

Synopsis

• Manage operations create, update and delete of the resource Sda Fabric Devices Layer2 Handoffs V1.

• Adds layer 2 handoffs in fabric devices based on user input.

• Deletes a layer 2 handoff of a fabric device based on id.

• Deletes layer 2 handoffs of a fabric device based on user input.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_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.
id string	Id path parameter. ID of the layer 2 handoff of a fabric device.
networkDeviceId string	NetworkDeviceId query parameter. Network device ID of the fabric device.
payload list / elements=dictionary	Sda Fabric Devices Layer2 Handoffs's payload.
externalVlanId integer	External VLAN number into which the fabric must be extended. Allowed VLAN range is 2-4094 except for reserved vlans (1, 1002-1005, 2046, 4094).
fabricId string	ID of the fabric this device is assigned to.
interfaceName string	Interface name of the layer 2 handoff. E.g., GigabitEthernet1/0/4.
internalVlanId integer	VLAN number associated with this fabric. Allowed VLAN range is 2-4094 except for reserved vlans (1, 1002-1005, 2046, 4094).
networkDeviceId string	Network device ID of the fabric device.
validate_response_schema boolean	Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are sda.Sda.add_fabric_devices_layer2_handoffs_v1, sda.Sda.delete_fabric_device_layer2_handoff_by_id_v1,

• Paths used are post /dna/intent/api/v1/sda/fabricDevices/layer2Handoffs, delete /dna/intent/api/v1/sda/fabricDevices/layer2Handoffs, delete /dna/intent/api/v1/sda/fabricDevices/layer2Handoffs/{id},

• Does not support 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 CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for SDA AddFabricDevicesLayer2HandoffsV1

Complete reference of the AddFabricDevicesLayer2HandoffsV1 API.

Cisco DNA Center documentation for SDA DeleteFabricDeviceLayer2HandoffByIdV1

Complete reference of the DeleteFabricDeviceLayer2HandoffByIdV1 API.

Cisco DNA Center documentation for SDA DeleteFabricDeviceLayer2HandoffsV1

Complete reference of the DeleteFabricDeviceLayer2HandoffsV1 API.

Examples

- name: Delete all
  cisco.catalystcenter.sda_fabric_devices_layer2_handoffs_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    fabricId: string
    networkDeviceId: string
- name: Create
  cisco.catalystcenter.sda_fabric_devices_layer2_handoffs_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    payload:
      - externalVlanId: 0
        fabricId: string
        interfaceName: string
        internalVlanId: 0
        networkDeviceId: string
- name: Delete by id
  cisco.catalystcenter.sda_fabric_devices_layer2_handoffs_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    id: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)