.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.wireless_access_points_configurations_info module -- Information module for Wireless Access Points Configurations ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.12.0). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.wireless_access_points_configurations_info`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.11.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get all Wireless Access Points Configurations. - \> This API endpoint allows users to query configuration information for one or more access points. Users can filter the results by specifying query parameters such as the Ethernet MAC address of a specific access point. When no query parameters are provided, the API returns details for all access points. If multiple query parameters are included, the API returns only those access points that match all specified filter criteria. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-accesspointjoinprofile: .. rst-class:: ansible-option-title **accessPointJoinProfile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AccessPointJoinProfile query parameter. Filters access points by AP Join Profile name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-ethernetmac: .. rst-class:: ansible-option-title **ethernetMac** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
EthernetMac query parameter. Filters access points by Ethernet MAC address (exact match). Example format \`xx xx xx xx xx xx\`. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-expirytime: .. rst-class:: ansible-option-title **expiryTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
ExpiryTime query parameter. Filters access points by AP LSC certificate expiry time (in days). Use an unquoted integer value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-flexprofile: .. rst-class:: ansible-option-title **flexProfile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
FlexProfile query parameter. Filters access points by Flex Profile name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional headers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-limit: .. rst-class:: ansible-option-title **limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Limit query parameter. The number of records to show for this page. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-locationhierarchy: .. rst-class:: ansible-option-title **locationHierarchy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
LocationHierarchy query parameter. Filters access points by assigned location hierarchy path (site hierarchy), for example \`Global/Area/Building/Floor\`. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-meshrole: .. rst-class:: ansible-option-title **meshRole** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
MeshRole query parameter. Filters access points by mesh role. Supported values \`RAP\` or \`MAP\`. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-mode: .. rst-class:: ansible-option-title **mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode query parameter. Filters access points by AP operating mode. Supported values \`LOCAL\`, \`MONITOR\`, \`FLEXCONNECT\`, \`ROGUE\_DETECTOR\`, \`SNIFFER\`, \`BRIDGE\`, \`SE\_CONNECT\`, \`FLEX\_BRIDGE\`, \`REMOTE\_HYBRID\`, \`SENSOR\`, \`FLEX\_LOCAL\`. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-model: .. rst-class:: ansible-option-title **model** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Model query parameter. Filters access points by AP model name (exact match). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-offset: .. rst-class:: ansible-option-title **offset** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Offset query parameter. The first record to show for this page; the first record is numbered 1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-policytag: .. rst-class:: ansible-option-title **policyTag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
PolicyTag query parameter. Filters access points by policy tag name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-provisioningstatus: .. rst-class:: ansible-option-title **provisioningStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
ProvisioningStatus query parameter. Filters access points by provisioning state in inventory. Set to \`true\` to return only APs that were provisioned from inventory, or \`false\` to return only APs that were not provisioned. If omitted, APs from both states are returned. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-rftag: .. rst-class:: ansible-option-title **rfTag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RfTag query parameter. Filters access points by RF tag name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-sitetag: .. rst-class:: ansible-option-title **siteTag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SiteTag query parameter. Filters access points by configured site tag name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__parameter-wlcipaddress: .. rst-class:: ansible-option-title **wlcIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
WlcIpAddress query parameter. Filters access points by the Wireless LAN Controller (WLC) IP address they are associated with. Accepts either IPv4 or IPv6 format. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are wireless.Wireless.retrieve\_access\_point\_details, - Paths used are get /dna/intent/api/v1/wirelessAccessPoints/configurations, - Supports \ :literal:`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) .. Seealso See Also -------- .. seealso:: `Cisco Catalyst Center documentation for Wireless RetrieveAccessPointDetails `_ Complete reference of the RetrieveAccessPointDetails API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Get all Wireless Access Points Configurations cisco.catalystcenter.wireless_access_points_configurations_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}}" ethernetMac: string wlcIpAddress: str mode: string model: string meshRole: string provisioningStatus: true siteTag: string accessPointJoinProfile: string flexProfile: string rfTag: string policyTag: string locationHierarchy: string expiryTime: 0 offset: 1 limit: 0 register: result .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_access_points_configurations_info_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors