cisco.catalystcenter.floors_floor_id_access_point_positions_bulk_change module -- Resource module for Floors Floor Id Access Point Positions Bulk Change

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

New in cisco.catalystcenter 6.17.0

Synopsis

• This module represents an alias of the module floors_floor_id_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.

• 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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_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 Access Point Positions Bulk Change's payload.
id string	Access Point Id.
position dictionary	Floors Floor Id Access Point Positions Bulk Change's position.
x float	Access Point X coordinate in feet.
y float	Access Point Y coordinate in feet.
z float	Access Point Z coordinate in feet.
radios list / elements=dictionary	Floors Floor Id Access Point Positions Bulk Change's radios.
antenna dictionary	Floors Floor Id 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 Access Point. Use `/dna/intent/api/v1/maps/supported-access-points` to find supported Antennas for a particualr Access Point model.
id string	Radio Id.
validate_response_schema boolean	Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are site_design.SiteDesign.edit_the_access_points_positions_v2,

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

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

Complete reference of the EditTheAccessPointsPositionsV2 API.

Examples

- name: Create
  cisco.catalystcenter.floors_floor_id_access_point_positions_bulk_change:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    floorId: string
    payload:
      - id: string
        position:
          x: 0
          y: 0
          z: 0
        radios:
          - antenna:
              azimuth: 0
              elevation: 0
              name: string
            id: 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)

Collection links

Issue Tracker Repository (Sources)