cisco.dnac.sda_fabrics_vlan_to_ssids_fabric_id module -- Resource module for Sda Fabrics Vlan To Ssids Fabric Id

Note

This module is part of the cisco.dnac collection (version 6.30.2).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 6.15.0

Synopsis

• This module represents an alias of the module sda_fabrics_vlan_to_ssids_fabric_id_v1

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.9

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: :ansible-option-default:`443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA 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 DNA 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,

• It should be noted that this module is an alias of sda_fabrics_vlan_to_ssids_fabric_id_v1

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

• The parameters starting with dnac_ are used by the Cisco DNAC 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.dnac.sda_fabrics_vlan_to_ssids_fabric_id:
    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
    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
dnac_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)