cisco.dnac.sda_fabric – Manage SdaFabric objects of Sda

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.sda_fabric.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get SDA Fabric Info.

  • Delete SDA Fabric.

  • Add SDA Fabric.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
fabric_name
string / required
Fabric Name.
payload
list / elements=dictionary
An object to send in the Request body.
Required for state create.
fabricName
string
It is the sda fabric's fabricName.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.sda_fabric

The official documentation on the cisco.dnac.plugins.module_utils.definitions.sda_fabric module.

SdaFabric reference

Complete reference of the SdaFabric object model.

SdaFabric reference

SDK reference.

Examples

- name: get_sda_fabric_info
  cisco.dnac.sda_fabric:
    state: query  # required
    fabric_name: SomeValue  # string, required
  register: nm_get_sda_fabric_info

- name: delete_sda_fabric
  cisco.dnac.sda_fabric:
    state: delete  # required
    fabric_name: SomeValue  # string, required

- name: add_fabric
  cisco.dnac.sda_fabric:
    state: create  # required
    payload:  # required
    - fabricName: SomeValue  # string

Return Values

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

Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function

sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
sda.add_fabric


Authors

  • Rafael Campos (@racampos)