cisco.dnac.sda_fabric_devices module – Resource module for Sda Fabricdevices

Note

This module is part of the cisco.dnac collection (version 6.24.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.

New in cisco.dnac 6.14.0

Synopsis

• Manage operations create, update and delete of the resource Sda Fabricdevices.

• Adds fabric devices based on user input.

• Deletes a fabric device based on id.

• Deletes fabric devices based on user input.

• Updates fabric devices 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.

• dnacentersdk >= 2.7.2

• python >= 3.5

Parameters

Parameter	Comments
deviceRoles string	DeviceRoles query parameter. Device roles of the fabric device.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: false ← (default) true
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: "admin"
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: false true ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. 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 fabric device.
networkDeviceId string	NetworkDeviceId query parameter. Network device ID of the fabric device.
payload list / elements=dictionary	Sda Fabric Devices’s payload.
borderDeviceSettings dictionary	Sda Fabric Devices’s borderDeviceSettings.
borderTypes list / elements=string	List of the border types of the fabric device. Allowed values are LAYER_2, LAYER_3.
layer3Settings dictionary	Sda Fabric Devices’s layer3Settings.
borderPriority integer	Border priority of the fabric border device. Allowed range is 1-9. A lower value indicates higher priority. E.g., a priority of 1 takes precedence over 5. Default priority would be set to 10.
importExternalRoutes boolean	Set this to import external routes from other routing protocols (such as BGP) to the fabric control plane. (updating this field is not allowed). Choices: false true
isDefaultExit boolean	Set this to make the fabric border device the gateway of last resort for this site. Any unknown traffic will be sent to this fabric border device from edge nodes. (updating this field is not allowed). Choices: false true
localAutonomousSystemNumber string	BGP Local autonomous system number of the fabric border device. Allowed range is 1 to 4294967295. (updating this field is not allowed).
prependAutonomousSystemCount integer	Prepend autonomous system count of the fabric border device. Allowed range is 1 to 10.
deviceRoles list / elements=string	List of the roles of the fabric device. Allowed values are CONTROL_PLANE_NODE, EDGE_NODE, BORDER_NODE. (updating this field is not allowed).
fabricId string	ID of the fabric site/zone of this fabric device. (updating this field is not allowed).
id string	ID of the fabric device. (updating this field is not allowed).
networkDeviceId string	Network device ID of the fabric device. (updating this field is not allowed).
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: false true ← (default)

Notes

Note

• SDK Method used are sda.Sda.add_fabric_devices, sda.Sda.delete_a_fabric_device_by_id, sda.Sda.update_fabric_devices,

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

• 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 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 AddFabricDevices

Complete reference of the AddFabricDevices API.

Cisco DNA Center documentation for SDA DeleteAFabricDeviceById

Complete reference of the DeleteAFabricDeviceById API.

Cisco DNA Center documentation for SDA DeleteFabricDevices

Complete reference of the DeleteFabricDevices API.

Cisco DNA Center documentation for SDA UpdateFabricDevices

Complete reference of the UpdateFabricDevices API.

Examples

- name: Update all
  cisco.dnac.sda_fabric_devices:
    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}}"
    state: present
    payload:
    - borderDeviceSettings:
        borderTypes:
        - string
        layer3Settings:
          borderPriority: 0
          importExternalRoutes: true
          isDefaultExit: true
          localAutonomousSystemNumber: string
          prependAutonomousSystemCount: 0
      deviceRoles:
      - string
      fabricId: string
      id: string
      networkDeviceId: string

- name: Delete all
  cisco.dnac.sda_fabric_devices:
    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}}"
    state: absent
    deviceRoles: string
    fabricId: string
    networkDeviceId: string

- name: Create
  cisco.dnac.sda_fabric_devices:
    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}}"
    state: present
    payload:
    - borderDeviceSettings:
        borderTypes:
        - string
        layer3Settings:
          borderPriority: 0
          importExternalRoutes: true
          isDefaultExit: true
          localAutonomousSystemNumber: string
          prependAutonomousSystemCount: 0
      deviceRoles:
      - string
      fabricId: string
      networkDeviceId: string

- name: Delete by id
  cisco.dnac.sda_fabric_devices:
    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}}"
    state: absent
    id: string

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 DNAC Python SDK Returned: always Sample: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

• Rafael Campos (@racampos)

Collection links

• Issue Tracker
• Repository (Sources)