.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.sda_fabric_devices_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.sda_fabric_devices module -- Resource module for Sda Fabricdevices +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.20.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.sda_fabric_devices`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.14.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.sda_fabric_devices_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.7.2 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-deviceroles: .. rst-class:: ansible-option-title **deviceRoles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
DeviceRoles query parameter. Device roles of the fabric device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-fabricid: .. rst-class:: ansible-option-title **fabricId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
FabricId query parameter. ID of the fabric this device belongs to. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. ID of the fabric device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-networkdeviceid: .. rst-class:: ansible-option-title **networkDeviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NetworkDeviceId query parameter. Network device ID of the fabric device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload: .. rst-class:: ansible-option-title **payload** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sda Fabric Devices's payload. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/borderdevicesettings: .. rst-class:: ansible-option-title **borderDeviceSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sda Fabric Devices's borderDeviceSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/borderdevicesettings/bordertypes: .. rst-class:: ansible-option-title **borderTypes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of the border types of the fabric device. Allowed values are LAYER\_2, LAYER\_3. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/borderdevicesettings/layer3settings: .. rst-class:: ansible-option-title **layer3Settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sda Fabric Devices's layer3Settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/borderdevicesettings/layer3settings/borderpriority: .. rst-class:: ansible-option-title **borderPriority** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/borderdevicesettings/layer3settings/importexternalroutes: .. rst-class:: ansible-option-title **importExternalRoutes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Set this to import external routes from other routing protocols (such as BGP) to the fabric control plane. (updating this field is not allowed). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/borderdevicesettings/layer3settings/isdefaultexit: .. rst-class:: ansible-option-title **isDefaultExit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/borderdevicesettings/layer3settings/localautonomoussystemnumber: .. rst-class:: ansible-option-title **localAutonomousSystemNumber** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
BGP Local autonomous system number of the fabric border device. Allowed range is 1 to 4294967295. (updating this field is not allowed). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/borderdevicesettings/layer3settings/prependautonomoussystemcount: .. rst-class:: ansible-option-title **prependAutonomousSystemCount** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Prepend autonomous system count of the fabric border device. Allowed range is 1 to 10. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/deviceroles: .. rst-class:: ansible-option-title **deviceRoles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of the roles of the fabric device. Allowed values are CONTROL\_PLANE\_NODE, EDGE\_NODE, BORDER\_NODE. (updating this field is not allowed). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/fabricid: .. rst-class:: ansible-option-title **fabricId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of the fabric site/zone of this fabric device. (updating this field is not allowed). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of the fabric device. (updating this field is not allowed). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-payload/networkdeviceid: .. rst-class:: ansible-option-title **networkDeviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network device ID of the fabric device. (updating this field is not allowed). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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 .. Seealso See Also -------- .. seealso:: `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 Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.sda_fabric_devices_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors