cisco.catalystcenter.sda_fabric_site module -- Resource module for Sda Fabric Site

Note

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

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

New in cisco.catalystcenter 3.1.0

Synopsis

  • Manage operations create and delete of the resource Sda Fabric Site.

  • Add Site in SDA Fabric.

  • Delete Site from SDA Fabric.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catc_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

fabricName

string

added in cisco.catalystcenter 4.0.0

Warning - Starting DNA Center 2.2.3.5 release, this field has been deprecated. SD-Access Fabric does not need it anymore. It will be removed in future DNA Center releases.

fabricType

string

Type of SD-Access Fabric. Allowed values are "FABRIC_SITE" or "FABRIC_ZONE". Default value is "FABRIC_SITE".

siteNameHierarchy

string

SiteNameHierarchy query parameter. Site Name Hierarchy.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are sda.Sda.add_site, sda.Sda.delete_site,

  • Paths used are post /dna/intent/api/v1/business/sda/fabric-site, delete /dna/intent/api/v1/business/sda/fabric-site,

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for SDA AddSiteInSDAFabric

Complete reference of the AddSiteInSDAFabric API.

Cisco DNA Center documentation for SDA DeleteSiteFromSDAFabric

Complete reference of the DeleteSiteFromSDAFabric API.

Examples

---
- name: Delete all
  cisco.catalystcenter.sda_fabric_site:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: absent
    siteNameHierarchy: string
- name: Create
  cisco.catalystcenter.sda_fabric_site:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: present
    fabricName: string
    fabricType: string
    siteNameHierarchy: 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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "string"}`

Authors

  • Rafael Campos (@racampos)