cisco.catalystcenter.floors_floor_id_planned_access_point_positions_bulk module -- Resource module for Floors Floor Id Planned Access Point Positions Bulk

Note

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

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

New in cisco.catalystcenter 6.17.0

Synopsis

  • This module represents an alias of the module floors_floor_id_planned_access_point_positions_bulk_v2

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

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

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

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

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

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

payload

list / elements=dictionary

Floors Floor Id Planned Access Point Positions Bulk's payload.

macAddress

string

Planned Access Point MAC address.

name

string

Planned Access Point Name.

position

dictionary

Floors Floor Id Planned Access Point Positions Bulk'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's radios.

antenna

dictionary

Floors Floor Id Planned Access Point Positions Bulk'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.

bands

list / elements=float

Radio frequencies in GHz. Radio frequencies are expected to be 2.4, 5, and 6. MinItems 1; MaxItems 3.

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.

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 CATALYST Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are site_design.SiteDesign.add_planned_access_points_positions_v2,

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

  • It should be noted that this module is an alias of floors_floor_id_planned_access_point_positions_bulk_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 CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Site Design AddPlannedAccessPointsPositionsV2

Complete reference of the AddPlannedAccessPointsPositionsV2 API.

Examples

- name: Create
  cisco.catalystcenter.floors_floor_id_planned_access_point_positions_bulk:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    floorId: string
    payload:
      - macAddress: string
        name: string
        position:
          x: 0
          y: 0
          z: 0
        radios:
          - antenna:
              azimuth: 0
              elevation: 0
              name: string
            bands:
              - 0
            channel: 0
            txPower: 0
        type: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

catalystcenter_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)