cisco.dnac.wireless_controllers_primary_managed_ap_locations_info module – Information module for Wireless Controllers Primary Managed Ap Locations Info

Note

This module is part of the cisco.dnac collection (version 6.27.0).

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

New in cisco.dnac 6.15.0

Synopsis

• This module represents an alias of the module wireless_controllers_primary_managed_ap_locations_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
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: false ← (default) true
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: "admin"
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: false true ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: "2.3.7.6"
headers dictionary	Additional headers.
limit float	Limit query parameter. The number of records to show for this page. Default is 500 if not specified. Maximum allowed limit is 500.
networkDeviceId string	NetworkDeviceId path parameter. Obtain the network device ID value by using the API call GET /dna/intent/api/v1/network-device/ip-address/${ipAddress}.
offset float	Offset query parameter. The first record to show for this page; the first record is numbered 1.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: false true ← (default)

Notes

Note

• SDK Method used are wireless.Wireless.get_primary_managed_ap_locations_for_specific_wireless_controller_v1,

• Paths used are get /dna/intent/api/v1/wirelessControllers/{networkDeviceId}/primaryManagedApLocations,

• It should be noted that this module is an alias of wireless_controllers_primary_managed_ap_locations_v1_info

• Supports check_mode

• The 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 GetPrimaryManagedAPLocationsForSpecificWirelessControllerV1

Complete reference of the GetPrimaryManagedAPLocationsForSpecificWirelessControllerV1 API.

Examples

- name: Get all Wireless Controllers Primary Managed Ap Locations Info
  cisco.dnac.wireless_controllers_primary_managed_ap_locations_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
    networkDeviceId: string
  register: result

Return Values

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

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: {"response": [{"managedApLocations": [{"siteId": "string", "siteNameHierarchy": "string"}]}], "version": "string"}

Authors

• Rafael Campos (@racampos)

Collection links

• Issue Tracker
• Repository (Sources)