cisco.dnac.planned_access_points module -- Resource module for Planned Access Points

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

New in cisco.dnac 6.0.0

Synopsis

  • This module represents an alias of the module planned_access_points_v1

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

attributes

dictionary

Planned Access Points's attributes.

createDate

float

Created date of the planned access point.

domain

string

Service domain to which the planned access point belongs.

heirarchyName

string

Hierarchy name of the planned access point.

id

float

Unique id of the planned access point.

instanceUuid

string

Instance uuid of the planned access point.

macAddress

string

MAC address of the planned access point.

name

string

Display name of the planned access point.

source

string

Source of the data used to create the planned access point.

typeString

string

Type string representation of the planned access point.

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. The instance UUID of the floor hierarchy element.

isSensor

boolean

Indicates that PAP is a sensor.

Choices:

location

dictionary

Planned Access Points's location.

altitude

float

Altitude of the planned access point's location.

lattitude

float

Latitude of the planned access point's location.

longtitude

float

Longitude of the planned access point's location.

plannedAccessPointUuid

string

PlannedAccessPointUuid path parameter. The instance UUID of the planned access point to delete.

position

dictionary

Planned Access Points's position.

x

float

X-coordinate of the planned access point on the map, 0,0 point being the top-left corner.

y

float

Y-coordinate of the planned access point on the map, 0,0 point being the top-left corner.

z

float

Z-coordinate, or height, of the planned access point on the map.

radioCount

integer

Number of radios of the planned access point.

radios

list / elements=dictionary

Planned Access Points's radios.

antenna

dictionary

Planned Access Points's antenna.

azimuthAngle

float

Azimuth angle of the antenna.

elevationAngle

float

Elevation angle of the antenna.

gain

float

Gain of the antenna.

mode

string

Mode of the antenna associated with this radio.

name

string

Name of the antenna.

type

string

Type of the antenna associated with this radio.

attributes

dictionary

Planned Access Points's attributes.

channel

float

Channel in which this radio operates.

channelString

string

Channel string representation.

id

integer

Id of the radio.

ifMode

string

IF mode of the radio.

ifTypeString

string

String representation of native band.

ifTypeSubband

string

Sub band of the radio.

instanceUuid

string

Instance Uuid of the radio.

slotId

float

Slot number in which the radio resides in the parent access point.

txPowerLevel

float

Tx Power at which this radio operates (in dBm).

isSensor

boolean

Determines if it is sensor or not.

Choices:

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 devices.Devices.create_planned_access_point_for_floor_v1, devices.Devices.delete_planned_access_point_for_floor_v1, devices.Devices.update_planned_access_point_for_floor_v1,

  • Paths used are post /dna/intent/api/v1/floors/{floorId}/planned-access-points, delete /dna/intent/api/v1/floors/{floorId}/planned-access-points/{plannedAccessPointUuid}, put /dna/intent/api/v1/floors/{floorId}/planned-access-points,

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

  • 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 Devices CreatePlannedAccessPointForFloorV1

Complete reference of the CreatePlannedAccessPointForFloorV1 API.

Cisco DNA Center documentation for Devices DeletePlannedAccessPointForFloorV1

Complete reference of the DeletePlannedAccessPointForFloorV1 API.

Cisco DNA Center documentation for Devices UpdatePlannedAccessPointForFloorV1

Complete reference of the UpdatePlannedAccessPointForFloorV1 API.

Examples

- name: Update all
  cisco.dnac.planned_access_points:
    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}}"
    state: present
    attributes:
      createDate: 0
      domain: string
      heirarchyName: string
      id: 0
      instanceUuid: string
      macAddress: string
      name: string
      source: string
      typeString: string
    floorId: string
    isSensor: true
    location:
      altitude: 0
      lattitude: 0
      longtitude: 0
    position:
      x: 0
      y: 0
      z: 0
    radioCount: 0
    radios:
    - antenna:
        azimuthAngle: 0
        elevationAngle: 0
        gain: 0
        mode: string
        name: string
        type: string
      attributes:
        channel: 0
        channelString: string
        id: 0
        ifMode: string
        ifTypeString: string
        ifTypeSubband: string
        instanceUuid: string
        slotId: 0
        txPowerLevel: 0
      isSensor: true

- name: Create
  cisco.dnac.planned_access_points:
    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}}"
    state: present
    attributes:
      createDate: 0
      domain: string
      heirarchyName: string
      id: 0
      instanceUuid: string
      macAddress: string
      name: string
      source: string
      typeString: string
    floorId: string
    isSensor: true
    location:
      altitude: 0
      lattitude: 0
      longtitude: 0
    position:
      x: 0
      y: 0
      z: 0
    radioCount: 0
    radios:
    - antenna:
        azimuthAngle: 0
        elevationAngle: 0
        gain: 0
        mode: string
        name: string
        type: string
      attributes:
        channel: 0
        channelString: string
        id: 0
        ifMode: string
        ifTypeString: string
        ifTypeSubband: string
        instanceUuid: string
        slotId: 0
        txPowerLevel: 0
      isSensor: true

- name: Delete by id
  cisco.dnac.planned_access_points:
    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}}"
    state: absent
    floorId: string
    plannedAccessPointUuid: 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: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)