cisco.catalystcenter.wireless_access_points_configurations_count_info module -- Information module for Wireless Access Points Configurations Count

Note

This module is part of the cisco.catalystcenter collection (version 2.12.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.wireless_access_points_configurations_count_info.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Get all Wireless Access Points Configurations Count. - > This API retrieves the total count of access points in the inventory. By default, it returns the count of all access points if no filters are applied. If filters are provided, the API returns the count of access points that match the specified criteria.

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

accessPointJoinProfile

string

AccessPointJoinProfile query parameter. Filters access points by AP Join Profile name.

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

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:

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

ethernetMac

string

EthernetMac query parameter. Filters access points by Ethernet MAC address (exact match). Example format `xx xx xx xx xx xx`.

expiryTime

integer

ExpiryTime query parameter. Filters access points by AP LSC certificate expiry time (in days). Use an unquoted integer value.

flexProfile

string

FlexProfile query parameter. Filters access points by Flex Profile name.

headers

dictionary

Additional headers.

locationHierarchy

string

LocationHierarchy query parameter. Filters access points by assigned location hierarchy path (site hierarchy), for example `Global/Area/Building/Floor`.

meshRole

string

MeshRole query parameter. Filters access points by mesh role. Supported values `RAP` or `MAP`.

mode

string

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

model

string

Model query parameter. Filters access points by AP model name (exact match).

policyTag

string

PolicyTag query parameter. Filters access points by policy tag name.

provisioningStatus

boolean

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.

Choices:

rfTag

string

RfTag query parameter. Filters access points by RF tag name.

siteTag

string

SiteTag query parameter. Filters access points by configured site tag name.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

wlcIpAddress

string

WlcIpAddress query parameter. Filters access points by the Wireless LAN Controller (WLC) IP address they are associated with. Accepts either IPv4 or IPv6 format.

Notes

Note

  • SDK Method used are wireless.Wireless.retrieve_the_count_of_access_points,

  • Paths used are get /dna/intent/api/v1/wirelessAccessPoints/configurations/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 RetrieveTheCountOfAccessPoints

Complete reference of the RetrieveTheCountOfAccessPoints API.

Examples

---
- name: Get all Wireless Access Points Configurations Count
  cisco.catalystcenter.wireless_access_points_configurations_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}}"
    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
  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)