cisco.dnac.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.dnac collection (version 6.27.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

New in cisco.dnac 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.

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • 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: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

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

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:

  • false

  • 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 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_v1:
    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: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)