cisco.dnac.floors_floor_id_access_point_positions_v2_info module -- Information module for Floors Floor Id Access Point Positions V2

Note

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

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

New in cisco.dnac 6.17.0

Synopsis

  • Get all Floors Floor Id Access Point Positions V2.

  • Retrieve all Access Points positions assigned 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.

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

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: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

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

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Informs the SDK which version of Cisco DNA 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. Access Point mac address.

model

string

Model query parameter. Access Point model.

name

string

Name query parameter. 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. Access Point type.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are site_design.SiteDesign.get_access_points_positions_v2,

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

  • 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 Site Design GetAccessPointsPositionsV2

Complete reference of the GetAccessPointsPositionsV2 API.

Examples

- name: Get all Floors Floor Id Access Point Positions V2
  cisco.dnac.floors_floor_id_access_point_positions_v2_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}}"
    name: string
    macAddress: string
    type: string
    model: 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 DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": [{"id": "string", "macAddress": "string", "model": "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)