cisco.dnac.sda_fabric_site – Manage SdaFabricSite 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_site.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Delete Site from SDA Fabric.

  • Get Site info from SDA Fabric.

  • Add Site in 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
payload
list / elements=dictionary
An object to send in the Request body.
Required for state create.
fabricName
string
It is the sda fabric site's fabricName.
siteNameHierarchy
string
It is the sda fabric site's siteNameHierarchy.
site_name_hierarchy
string / required
Site Name Hierarchy.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.sda_fabric_site

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

SdaFabricSite reference

Complete reference of the SdaFabricSite object model.

SdaFabricSite reference

SDK reference.

Examples

- name: delete_site
  cisco.dnac.sda_fabric_site:
    state: delete  # required
    site_name_hierarchy: SomeValue  # string, required

- name: get_site
  cisco.dnac.sda_fabric_site:
    state: query  # required
    site_name_hierarchy: SomeValue  # string, required
  register: nm_get_site

- name: add_site
  cisco.dnac.sda_fabric_site:
    state: create  # required
    payload:  # required
    - fabricName: SomeValue  # string
      siteNameHierarchy: 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_site


Authors

  • Rafael Campos (@racampos)