cisco.catalystcenter.sda_fabrics_vlan_to_ssids_fabric_id_v1 module -- Resource module for Sda Fabrics Vlan To Ssids Fabric Id V1

Note

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

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

New in cisco.catalystcenter 6.15.0

Synopsis

• Manage operation update of the resource Sda Fabrics Vlan To Ssids Fabric Id V1.

• Add, update, or remove SSID mappings to a VLAN. If the payload doesn't contain a 'vlanName' which has SSIDs mapping done earlier then all the mapped SSIDs of the 'vlanName' is cleared. The request must include all SSIDs currently mapped to a VLAN, as determined by the response from the GET operation for the same fabricId used in the request. If an already-mapped SSID is not included in the payload, its mapping will be removed by this API. Conversely, if a new SSID is provided, it will be added to the Mapping. Ensure that any new SSID added is a Fabric SSID. This API can also be used to add a VLAN and associate the relevant SSIDs with it. The 'vlanName' must be 'Fabric Wireless Enabled' and should be part of the Fabric Site representing 'Fabric ID' specified in the API request.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
fabricId string	FabricId path parameter. The 'fabricId' represents the Fabric ID of a particular Fabric Site.
payload list / elements=dictionary	Sda Fabrics Vlan To Ssids Fabric Id's payload.
ssidDetails list / elements=dictionary	Sda Fabrics Vlan To Ssids Fabric Id's ssidDetails.
name string	Name of the SSID.
securityGroupTag string	Represents the name of the Security Group. Example Auditors, BYOD, Developers, etc.
vlanName string	Vlan Name.
validate_response_schema boolean	Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are fabric_wireless.FabricWireless.add_update_or_remove_ssid_mapping_to_a_vlan_v1,

• Paths used are put /dna/intent/api/v1/sda/fabrics/{fabricId}/vlanToSsids,

• 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 CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Fabric Wireless AddUpdateOrRemoveSSIDMappingToAVLANV1

Complete reference of the AddUpdateOrRemoveSSIDMappingToAVLANV1 API.

Examples

- name: Update all
  cisco.catalystcenter.sda_fabrics_vlan_to_ssids_fabric_id_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    fabricId: string
    payload:
      - ssidDetails:
          - name: string
            securityGroupTag: string
        vlanName: string

Return Values

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

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)