cisco.dnac.buildings_planned_access_points_info module – Information module for Buildings Planned Access Points

Note

This module is part of the cisco.dnac collection (version 6.5.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.

To use it in a playbook, specify: cisco.dnac.buildings_planned_access_points_info.

New in version 6.0.0: of cisco.dnac

Synopsis

  • Get all Buildings Planned Access Points.

  • Provides a list of Planned Access Points for the Building it is requested for.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.5.0

  • python >= 3.5

Parameters

Parameter

Comments

buildingId

string

BuildingId path parameter. Building Id.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • no ← (default)

  • yes

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:

  • no

  • yes ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: “2.3.3.0”

headers

dictionary

Additional headers.

limit

integer

Limit query parameter.

offset

integer

Offset query parameter.

radios

boolean

Radios query parameter. Inlcude planned radio details.

Choices:

  • no

  • yes

validate_response_schema

boolean

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

Choices:

  • no

  • yes ← (default)

Notes

Note

  • SDK Method used are devices.Devices.get_planned_access_points_for_building,

  • Paths used are get /dna/intent/api/v1/buildings/{buildingId}/planned-access-points,

  • 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 Devices GetPlannedAccessPointsForBuilding

Complete reference of the GetPlannedAccessPointsForBuilding API.

Examples

- name: Get all Buildings Planned Access Points
  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

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: “{\n \”response\”: [\n {\n \”attributes\”: {\n \”id\”: 0,\n \”instanceUuid\”: \”string\”,\n \”name\”: \”string\”,\n \”typeString\”: \”string\”,\n \”domain\”: \”string\”,\n \”heirarchyName\”: \”string\”,\n \”source\”: \”string\”,\n \”createDate\”: 0,\n \”macaddress\”: {}\n },\n \”location\”: {},\n \”position\”: {\n \”x\”: 0,\n \”y\”: 0,\n \”z\”: 0\n },\n \”radioCount\”: 0,\n \”radios\”: [\n {\n \”attributes\”: {\n \”id\”: 0,\n \”instanceUuid\”: \”string\”,\n \”slotId\”: 0,\n \”ifTypeString\”: \”string\”,\n \”ifTypeSubband\”: \”string\”,\n \”channel\”: {},\n \”channelString\”: {},\n \”ifMode\”: \”string\”\n },\n \”antenna\”: {\n \”name\”: \”string\”,\n \”type\”: \”string\”,\n \”mode\”: \”string\”,\n \”azimuthAngle\”: 0,\n \”elevationAngle\”: 0,\n \”gain\”: 0\n },\n \”isSensor\”: true\n }\n ],\n \”isSensor\”: true\n }\n ],\n \”version\”: 0,\n \”total\”: 0\n}\n”

Authors

  • Rafael Campos (@racampos)