cisco.dnac.client_proximity_info – Information module for Client Proximity

Note

This plugin is part of the cisco.dnac collection (version 3.1.3).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.client_proximity_info.

New in version 1.0.0: of cisco.dnac

Synopsis

• Get all Client Proximity.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk

Parameters

Parameter	Choices/Defaults	Comments
headers dictionary		Additional headers.
number_days integer		Number_days query parameter. Number of days to track proximity until current date. Defaults and maximum up to 14 days.
time_resolution integer		Time_resolution query parameter. Time interval (in minutes) to measure proximity. Defaults to 15 minutes with a minimum 5 minutes.
username string		Username query parameter. Wireless client username for which proximity information is required.

See Also

See also

Client Proximity reference

Complete reference of the Client Proximity object model.

Examples

- name: Get all Client Proximity
  cisco.dnac.client_proximity_info:
    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}}"
    headers:
      custom: value
    username: string
    number_days: 0
    time_resolution: 0
  register: result

Return Values

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

Key	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "executionId": "string", "executionStatusUrl": "string", "message": "string" }

Authors

• Rafael Campos (@racampos)