/ home / cisco / cisco.dnac / 6.13.3 / module / planned_access_points_info

cisco.dnac.planned_access_points_info (6.13.3) — module

Information module for Planned Access Points

| "added in version" 6.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Planned Access Points.

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

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Planned Access Points
  cisco.dnac.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
    floorId: string
  register: result

Inputs

    
limit:
    description:
    - Limit query parameter.
    type: int

offset:
    description:
    - Offset query parameter.
    type: int

radios:
    description:
    - Radios query parameter. Inlcude planned radio details.
    type: bool

floorId:
    description:
    - FloorId path parameter. Floor Id.
    type: str

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: 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"
  type: dict