cisco.dnac.wireless_sensor_test_results_info – Information module for Wireless Sensor Test Results

Note

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

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.

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

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get all Wireless Sensor Test Results.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.3.3"
Informs the SDK which version of Cisco DNA Center to use.
endTime
integer
EndTime query parameter. The epoch time in milliseconds.
headers
dictionary
Additional headers.
siteId
string
SiteId query parameter. Assurance site UUID.
startTime
integer
StartTime query parameter. The epoch time in milliseconds.
testFailureBy
string
TestFailureBy query parameter. Obtain failure statistics group by "area", "building", or "floor".
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

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

Wireless Sensor Test Results reference

Complete reference of the Wireless Sensor Test Results object model.

Examples

- name: Get all Wireless Sensor Test Results
  cisco.dnac.wireless_sensor_test_results_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
    siteId: string
    startTime: 0
    endTime: 0
    testFailureBy: string
  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:
{ "summary": { "totalTestCount": 0, "ONBOARDING": { "AUTH": { "passCount": 0, "failCount": 0 }, "DHCP": { "passCount": 0, "failCount": 0 }, "ASSOC": { "passCount": 0, "failCount": 0 } }, "PERFORMANCE": { "IPSLASENDER": { "passCount": 0, "failCount": 0 } }, "NETWORK_SERVICES": { "DNS": { "passCount": 0, "failCount": 0 } }, "APP_CONNECTIVITY": { "HOST_REACHABILITY": { "passCount": 0, "failCount": 0 }, "WEBSERVER": { "passCount": 0, "failCount": 0 }, "FILETRANSFER": { "passCount": 0, "failCount": 0 } }, "RF_ASSESSMENT": { "DATA_RATE": { "passCount": 0, "failCount": 0 }, "SNR": { "passCount": 0, "failCount": 0 } }, "EMAIL": { "MAILSERVER": { "passCount": 0, "failCount": 0 } } }, "failureStats": [ { "errorCode": 0, "errorTitle": "string", "testType": "string", "testCategory": "string" } ] }


Authors

  • Rafael Campos (@racampos)