cisco.dnac.icap_clients_id_stats module – Resource module for Icap Clients Id Stats

Note

This module is part of the cisco.dnac collection (version 6.31.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

New in cisco.dnac 6.17.0

Synopsis

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

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • 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: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

endTime

integer

End Time.

filters

list / elements=dictionary

Icap Clients Id Stats’s filters.

key

string

Key.

operator

string

Operator.

value

integer

Value.

headers

dictionary

Additional headers.

id

string

Id path parameter. Id is the client mac address. It can be specified in one of the notational conventions 01 23 45 67 89 AB or 01-23-45-67-89-AB or 0123.4567.89AB and is case insensitive.

page

dictionary

Icap Clients Id Stats’s page.

limit

integer

Limit.

offset

integer

Offset.

timeSortOrder

string

Time Sort Order.

startTime

integer

Start Time.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are sensors.Sensors.retrieves_specific_client_statistics_over_specified_period_of_time_v1,

  • Paths used are post /dna/data/api/v1/icap/clients/{id}/stats,

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

Complete reference of the RetrievesSpecificClientStatisticsOverSpecifiedPeriodOfTimeV1 API.

Examples

- name: Create
  cisco.dnac.icap_clients_id_stats:
    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}}"
    endTime: 0
    filters:
      - key: string
        operator: string
        value: 0
    headers: '{{my_headers | from_json}}'
    id: string
    page:
      limit: 0
      offset: 0
      timeSortOrder: string
    startTime: 0

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: {"page": {"count": 0, "limit": 0, "offset": 0, "timeSortOrder": "string"}, "response": [{"apMac": "string", "band": "string", "clientIp": "string", "clientMac": "string", "id": "string", "radioId": 0, "rssi": 0, "rxBytes": 0, "rxCtrlPackets": 0, "rxDataPackets": 0, "rxMgmtPackets": 0, "rxPackets": 0, "rxRate": 0, "rxRetries": 0, "snr": 0, "ssid": "string", "timestamp": 0, "txBytes": 0, "txCtrlPackets": 0, "txDataPackets": 0, "txMgmtPackets": 0, "txPackets": 0, "txRate": 0, "txUnicastDataPackets": 0}], "version": "string"}

Authors

  • Rafael Campos (@racampos)