cisco.dnac.sites_site_id_wireless_settings_flex_connect_native_vlan module – Resource module for Sites Site Id Wireless Settings Flex Connect Native Vlan

Note

This module is part of the cisco.dnac collection (version 6.42.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.sites_site_id_wireless_settings_flex_connect_native_vlan.

New in cisco.dnac 6.18.0

Synopsis

  • Manage operations update and delete of the resource Sites Site Id Wireless Settings Flex Connect Native Vlan.

  • This API allows the user to delete a Native VLAN setting at the given site level. - > This API allows the user to update an existing Native VLAN setting at the given site level. The default value of the native VLAN on the device is 1 when nothing is explicitly set.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.10.1

  • 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"

nativeVlanId

integer

Native VLAN ID is used for any untagged frames.Range is 1 to 4094.

removeOverrideInHierarchy

boolean

RemoveOverrideInHierarchy query parameter. If the siteId pertains to a Global or non-Global site (e.g., Global, Area, Building, or Floor) and removeOverrideInHierarchy is set to true, this API will remove the override from the specified siteId and any child sites for the same Native VLAN. If removeOverrideInHierarchy is set to false, the API will only remove the override from the specified siteId only, leaving any overrides for the Native VLAN at child sites unaffected.

Choices:

  • false

  • true

siteId

string

SiteId path parameter. Site Id.

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_native_vlan_settings_by_site, wireless.Wireless.update_native_vlan_settings_by_site,

  • Paths used are delete /dna/intent/api/v1/sites/{siteId}/wirelessSettings/flexConnectNativeVlan, put /dna/intent/api/v1/sites/{siteId}/wirelessSettings/flexConnectNativeVlan,

  • 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 DeleteNativeVlanSettingsBySite

Complete reference of the DeleteNativeVlanSettingsBySite API.

Cisco DNA Center documentation for Wireless UpdateNativeVlanSettingsBySite

Complete reference of the UpdateNativeVlanSettingsBySite API.

Examples

---
- name: Update all
  cisco.dnac.sites_site_id_wireless_settings_flex_connect_native_vlan:
    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
    nativeVlanId: 0
    siteId: string
- name: Delete all
  cisco.dnac.sites_site_id_wireless_settings_flex_connect_native_vlan:
    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
    removeOverrideInHierarchy: true
    siteId: 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)