cisco.dnac.floors_floor_id_planned_access_point_positions_bulk_change module – Resource module for Floors Floor Id Planned Access Point Positions Bulk Change

Note

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

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

New in cisco.dnac 6.17.0

Synopsis

  • This module represents an alias of the module floors_floor_id_planned_access_point_positions_bulk_change_v2

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:

  • false ← (default)

  • true

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:

  • false

  • true ← (default)

dnac_version

string

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

Default: "2.3.7.6"

floorId

string

FloorId path parameter. Floor Id.

payload

list / elements=dictionary

Floors Floor Id Planned Access Point Positions Bulk Change’s payload.

id

string

Planned Access Point Id.

macAddress

string

Planned Access Point MAC address.

name

string

Planned Access Point Name.

position

dictionary

Floors Floor Id Planned Access Point Positions Bulk Change’s position.

x

float

Planned Access Point X coordinate in feet.

y

float

Planned Access Point Y coordinate in feet.

z

float

Planned Access Point Z coordinate in feet.

radios

list / elements=dictionary

Floors Floor Id Planned Access Point Positions Bulk Change’s radios.

antenna

dictionary

Floors Floor Id Planned Access Point Positions Bulk Change’s antenna.

azimuth

integer

Angle of the antenna, measured relative to the x axis, clockwise. The azimuth range is from 0 through 360.

elevation

integer

Elevation of the antenna. The elevation range is from -90 through 90.

name

string

Antenna type for this Planned Access Point. Use `/dna/intent/api/v1/maps/supported-acc… to find supported Antennas for a particualr Planned Access Point type.

channel

integer

Channel to be used by the Planned Access Point. In the context of a Planned Access Point, the channel have no bearing on what the real Access Point will actually be, they are just used for Maps visualization feature set.

id

string

Radio Id.

txPower

integer

Transmit power for the channel in Decibel milliwatts (dBm). In the context of a Planned Access Point, the txPower have no bearing on what the real Access Point will actually be, they are just used for Maps visualization feature set.

type

string

Planned Access Point type. Use `dna/intent/api/v1/maps/supported-access-points` to find the supported models.

validate_response_schema

boolean

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

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are site_design.SiteDesign.edit_planned_access_points_positions_v2,

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

  • It should be noted that this module is an alias of floors_floor_id_planned_access_point_positions_bulk_change_v2

  • Does not support 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 EditPlannedAccessPointsPositionsV2

Complete reference of the EditPlannedAccessPointsPositionsV2 API.

Examples

- name: Create
  cisco.dnac.floors_floor_id_planned_access_point_positions_bulk_change:
    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}}"
    floorId: string
    payload:
    - id: string
      macAddress: string
      name: string
      position:
        x: 0
        y: 0
        z: 0
      radios:
      - antenna:
          azimuth: 0
          elevation: 0
          name: string
        channel: 0
        id: string
        txPower: 0
      type: string

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: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)