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

Note

This module is part of the cisco.dnac collection (version 6.24.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

• Manage operations create, update and delete of the resource Planned Access Points.

• Allows creation of a new planned access point on an existing floor map including its planned radio and antenna details. Use the Get variant of this API to fetch any existing planned access points for the floor. The payload to create a planned access point is in the same format, albeit a single object instead of a list, of that API.

• Allow to delete a planned access point from an existing floor map including its planned radio and antenna details. Use the Get variant of this API to fetch the existing planned access points for the floor. The instanceUUID listed in each of the planned access point attributes acts as the path param input to this API to delete that specific instance.

• Allows updating a planned access point on an existing floor map including its planned radio and antenna details. Use the Get variant of this API to fetch the existing planned access points for the floor. The payload to update a planned access point is in the same format, albeit a single object instead of a list, of that API.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.7.2

• python >= 3.5

Parameters

Parameter	Comments
attributes dictionary	Planned Access Points's attributes.
createDate integer	Planned Access Points's createDate.
domain string	Planned Access Points's domain.
heirarchyName string	Planned Access Points's heirarchyName.
id float	Planned Access Points's id.
instanceUuid string	Planned Access Points's instanceUuid.
macaddress string	Planned Access Points's macaddress.
name string	Planned Access Points's name.
source string	Planned Access Points's source.
typeString string	Planned Access Points's typeString.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`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: :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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
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	IsSensor flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
location dictionary	Planned Access Points's location.
altitude float	Planned Access Points's altitude.
lattitude float	Planned Access Points's lattitude.
longtitude float	Planned Access Points's longtitude.
plannedAccessPointUuid string	PlannedAccessPointUuid path parameter. The instance UUID of the planned access point to delete.
position dictionary	Planned Access Points's position.
x float	Planned Access Points's x.
y float	Planned Access Points's y.
z float	Planned Access Points's z.
radioCount integer	Planned Access Points's radioCount.
radios list / elements=dictionary	Planned Access Points's radios.
antenna dictionary	Planned Access Points's antenna.
azimuthAngle float	Planned Access Points's azimuthAngle.
elevationAngle float	Planned Access Points's elevationAngle.
gain float	Planned Access Points's gain.
mode string	Planned Access Points's mode.
name string	Planned Access Points's name.
type string	Planned Access Points's type.
attributes dictionary	Planned Access Points's attributes.
channel float	Planned Access Points's channel.
channelString string	Planned Access Points's channelString.
id float	Planned Access Points's id.
ifMode string	Planned Access Points's ifMode.
ifTypeString string	Planned Access Points's ifTypeString.
ifTypeSubband string	Planned Access Points's ifTypeSubband.
instanceUuid string	Planned Access Points's instanceUuid.
slotId float	Planned Access Points's slotId.
isSensor boolean	IsSensor flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
validate_response_schema boolean	Flag for Cisco DNA 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 devices.Devices.create_planned_access_point_for_floor, devices.Devices.delete_planned_access_point_for_floor, devices.Devices.update_planned_access_point_for_floor,

• 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,

• 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 CreatePlannedAccessPointForFloor

Complete reference of the CreatePlannedAccessPointForFloor API.

Cisco DNA Center documentation for Devices DeletePlannedAccessPointForFloor

Complete reference of the DeletePlannedAccessPointForFloor API.

Cisco DNA Center documentation for Devices UpdatePlannedAccessPointForFloor

Complete reference of the UpdatePlannedAccessPointForFloor 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
      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
      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)

Collection links

Issue Tracker Repository (Sources)