cisco.dnac.wireless_profiles_id_site_tags_site_tag_id module – Resource module for Wireless Profiles Id Site Tags Site Tag Id

Note

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

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

New in cisco.dnac 6.17.0

Synopsis

  • This module represents an alias of the module wireless_profiles_id_site_tags_site_tag_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

apProfileName

string

Ap Profile Name.

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"

flexProfileName

string

Flex Profile Name.

id

string

Id path parameter. Wireless Profile Id.

siteIds

list / elements=string

Site Ids.

siteTagId

string

SiteTagId path parameter. Site Tag Id.

siteTagName

string

Use English letters, numbers, special characters except <, /, ‘.*’, ? and leading/trailing space.

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 wireless.Wireless.delete_a_specific_site_tag_from_a_wireless_profile_v1, wireless.Wireless.update_a_specific_site_tag_for_a_wireless_profile_v1,

  • Paths used are delete /dna/intent/api/v1/wirelessProfiles/{id}/siteTags/{siteTagId}, put /dna/intent/api/v1/wirelessProfiles/{id}/siteTags/{siteTagId},

  • It should be noted that this module is an alias of wireless_profiles_id_site_tags_site_tag_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 Wireless DeleteASpecificSiteTagFromAWirelessProfileV1

Complete reference of the DeleteASpecificSiteTagFromAWirelessProfileV1 API.

Cisco DNA Center documentation for Wireless UpdateASpecificSiteTagForAWirelessProfileV1

Complete reference of the UpdateASpecificSiteTagForAWirelessProfileV1 API.

Examples

- name: Update by id
  cisco.dnac.wireless_profiles_id_site_tags_site_tag_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
    apProfileName: string
    flexProfileName: string
    id: string
    siteIds:
    - string
    siteTagId: string
    siteTagName: string

- name: Delete by id
  cisco.dnac.wireless_profiles_id_site_tags_site_tag_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: absent
    id: string
    siteTagId: 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)