cisco.catalystcenter.sites_wireless_settings_ssids_v1_info module -- Information module for Sites Wireless Settings Ssids V1
Note
This module is part of the cisco.catalystcenter collection (version 2.1.4).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.sites_wireless_settings_ssids_v1_info.
New in cisco.catalystcenter 6.15.0
Synopsis
Get all Sites Wireless Settings Ssids V1.
Get Sites Wireless Settings Ssids V1 by id.
This API allows the user to get all SSIDs Service Set Identifier at the given site.
This API allows the user to get an SSID Service Set Identifier by ID at the given site.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 2.3.7.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
The Cisco CATALYST Center port. Default: :ansible-option-default:`443` |
|
Flag for Cisco CATALYST Center SDK to enable debugging. Choices: |
|
The Cisco CATALYST Center hostname. |
|
The Cisco CATALYST Center password to authenticate. |
|
The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
AuthType query parameter. Auth Type. |
|
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 CATALYST 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},
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 CATALYST SDK
The parameters starting with catalystCenter_ are used by the Cisco CATALYST 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 V1
cisco.catalystcenter.sites_wireless_settings_ssids_v1_info:
_host: "{{ _host }}"
_username: "{{ _username }}"
_password: "{{ _password }}"
_verify: "{{ _verify }}"
_api_port: "{{ _api_port }}"
_version: "{{ _version }}"
_debug: "{{ _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 V1 by id
cisco.catalystcenter.sites_wireless_settings_ssids_v1_info:
_host: "{{ _host }}"
_username: "{{ _username }}"
_password: "{{ _password }}"
_verify: "{{ _verify }}"
_api_port: "{{ _api_port }}"
_version: "{{ _version }}"
_debug: "{{ _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 |
|---|---|