cisco.catalystcenter.floors_floor_id_planned_access_point_positions_info module -- Information module for Floors Floor Id Planned Access Point Positions

Note

This module is part of the cisco.catalystcenter collection (version 2.2.1).

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

New in cisco.catalystcenter 6.17.0

Synopsis

  • Get all Floors Floor Id Planned Access Point Positions.

  • Retrieve all Planned Access Points Positions designated for a specific floor.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catc_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

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

Default: :ansible-option-default:`"2.3.7.6"`

floorId

string

FloorId path parameter. Floor Id.

headers

dictionary

Additional headers.

limit

float

Limit query parameter. The number of records to show for this page;The minimum is 1, and the maximum is 500.

macAddress

string

MacAddress query parameter. Planned Access Point mac address.

name

string

Name query parameter. Planned Access Point name.

offset

float

Offset query parameter. The first record to show for this page; the first record is numbered 1. Minimum 1.

type

string

Type query parameter. Planned Access Point type.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are site_design.SiteDesign.get_planned_access_points_positions_v2,

  • Paths used are get /dna/intent/api/v2/floors/{floorId}/plannedAccessPointPositions,

  • 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

See Also

See also

Cisco DNA Center documentation for Site Design GetPlannedAccessPointsPositionsV2

Complete reference of the GetPlannedAccessPointsPositionsV2 API.

Examples

---
- name: Get all Floors Floor Id Planned Access Point
    Positions
  cisco.catalystcenter.floors_floor_id_planned_access_point_positions_info:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    headers: "{{my_headers | from_json}}"
    name: string
    macAddress: string
    type: string
    offset: 0
    limit: 0
    floorId: 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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": [{"id": "string", "macAddress": "string", "name": "string", "position": {"x": 0, "y": 0, "z": 0}, "radios": [{"antenna": {"azimuth": 0, "elevation": 0, "name": "string"}, "bands": [0], "channel": 0, "id": "string", "txPower": 0}], "type": "string"}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)