cisco.catalystcenter.sites_wireless_settings_ssids_count_info module -- Information module for Sites Wireless Settings Ssids Count

Note

This module is part of the cisco.catalystcenter collection (version 2.11.0).

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

New in cisco.catalystcenter 1.0.0

Synopsis

• Get all Sites Wireless Settings Ssids Count.

• This API allows the user to get count of all SSIDs Service Set Identifier at `siteId`.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.2.3.0.0

• python >= 3.12

Parameters

Parameter	Comments
_inherited boolean	_inherited query parameter. `_inherited` query parameter indicates wether the current SSID count at `siteId` is of the SSID it is inheriting or count of non-inheriting SSIDs. - When `_inherited` is `false` then - Should a request include a non-global `siteId` with the `_inherited` flag set to `false`, the API will respond with a count of all SSIDs that have been explicitly overridden at the specified site identifier (`siteId`). - When `_inherited` is `true` then - In the case where a non-global `siteId` is accompanied by the `_inherited` flag set to true, the API is tasked with returning a count that aggregates the following - The number of SSIDs inherited from the global level. - The number of SSIDs derived from the immediate parent site where an override is present. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
headers dictionary	Additional headers.
siteId string	SiteId path parameter. Site UUID.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are wireless.Wireless.get_ssid_count_by_site,

• Paths used are get /dna/intent/api/v1/sites/{siteId}/wirelessSettings/ssids/count,

• Supports check_mode

• The plugin runs on the control node and does not use any ansible connection plugins,

• but instead uses the embedded connection manager from Cisco CATALYST SDK

• Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Wireless GETSSIDCOUNTBYSITE

Complete reference of the GETSSIDCOUNTBYSITE API.

Examples

---
- name: Get all Sites Wireless Settings Ssids Count
  cisco.catalystcenter.sites_wireless_settings_ssids_count_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    _inherited: true
    siteId: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"count": 0}, "version": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)