cisco.dnac.buildings_planned_access_points_info module – Information module for Buildings Planned Access Points 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.buildings_planned_access_points_info.
New in cisco.dnac 6.0.0
Synopsis
This module represents an alias of the module buildings_planned_access_points_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 |
|---|---|
BuildingId path parameter. The instance UUID of the building hierarchy element. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Additional headers. |
|
Limit query parameter. The number of records to show for this page;The minimum is 1, and the maximum is 500. |
|
Offset query parameter. The page offset for the response. E.g. If limit=100, offset=0 will return first 100 records, offset=1 will return next 100 records, etc. |
|
Radios query parameter. Whether to include the planned radio details of the planned access points. Choices:
|
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are devices.Devices.get_planned_access_points_for_building_v1,
Paths used are get /dna/intent/api/v1/buildings/{buildingId}/planned-access-points,
It should be noted that this module is an alias of buildings_planned_access_points_v1_info
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 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 Devices GetPlannedAccessPointsForBuildingV1
Complete reference of the GetPlannedAccessPointsForBuildingV1 API.
Examples
- name: Get all Buildings Planned Access Points Info
cisco.dnac.buildings_planned_access_points_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
radios: True
buildingId: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |