cisco.dnac.sites_wireless_settings_ssids_info module – Information module for Sites Wireless Settings Ssids Info
Note
This module is part of the cisco.dnac collection (version 6.31.3).
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_wireless_settings_ssids_info.
New in cisco.dnac 6.15.0
Synopsis
This module represents an alias of the module sites_wireless_settings_ssids_v1_info
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 |
|---|---|
AuthType query parameter. Auth Type. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Additional headers. |
|
Id path parameter. SSID ID. |
|
L3authType query parameter. L3 Auth Type. |
|
Limit query parameter. The number of records to show for this page. Default is 500 if not specified. Maximum allowed limit is 500. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. |
|
SiteId path parameter. Site UUID. |
|
Ssid query parameter. SSID Name. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
WlanType query parameter. Wlan Type. |
Notes
Note
SDK Method used are wireless.Wireless.get_ssid_by_id_v1, wireless.Wireless.get_ssid_by_site_v1,
Paths used are get /dna/intent/api/v1/sites/{siteId}/wirelessSettings/ssids, get /dna/intent/api/v1/sites/{siteId}/wirelessSettings/ssids/{id},
It should be noted that this module is an alias of sites_wireless_settings_ssids_v1_info
Supports
check_modeThe 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 GetSSIDByIDV1
Complete reference of the GetSSIDByIDV1 API.
- Cisco DNA Center documentation for Wireless GetSSIDBySiteV1
Complete reference of the GetSSIDBySiteV1 API.
Examples
- name: Get all Sites Wireless Settings Ssids Info
cisco.dnac.sites_wireless_settings_ssids_info:
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}}"
headers: "{{my_headers | from_json}}"
limit: 0
offset: 0
ssid: string
wlanType: string
authType: string
l3authType: string
siteId: string
register: result
- name: Get Sites Wireless Settings Ssids Info by id
cisco.dnac.sites_wireless_settings_ssids_info:
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}}"
headers: "{{my_headers | from_json}}"
siteId: string
id: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |