/ home / cisco / cisco.dnac / 6.13.3 / module / wireless_sensor_test_results_info

cisco.dnac.wireless_sensor_test_results_info (6.13.3) — module

Information module for Wireless Sensor Test Results

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Wireless Sensor Test Results.

Intent API to get SENSOR test result summary.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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: "{{my_headers | from_json}}"
    siteId: string
    startTime: 0
    endTime: 0
    testFailureBy: string
  register: result

Inputs

    
siteId:
    description:
    - SiteId query parameter. Assurance site UUID.
    type: str

endTime:
    description:
    - EndTime query parameter. The epoch time in milliseconds.
    type: int

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

startTime:
    description:
    - StartTime query parameter. The epoch time in milliseconds.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

testFailureBy:
    description:
    - TestFailureBy query parameter. Obtain failure statistics group by "area", "building",
      or "floor".
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"summary\": {\n    \"totalTestCount\": 0,\n    \"ONBOARDING\": {\n\
    \      \"AUTH\": {\n        \"passCount\": 0,\n        \"failCount\": 0\n    \
    \  },\n      \"DHCP\": {\n        \"passCount\": 0,\n        \"failCount\": 0\n\
    \      },\n      \"ASSOC\": {\n        \"passCount\": 0,\n        \"failCount\"\
    : 0\n      }\n    },\n    \"PERFORMANCE\": {\n      \"IPSLASENDER\": {\n     \
    \   \"passCount\": 0,\n        \"failCount\": 0\n      }\n    },\n    \"NETWORK_SERVICES\"\
    : {\n      \"DNS\": {\n        \"passCount\": 0,\n        \"failCount\": 0\n \
    \     }\n    },\n    \"APP_CONNECTIVITY\": {\n      \"HOST_REACHABILITY\": {\n\
    \        \"passCount\": 0,\n        \"failCount\": 0\n      },\n      \"WEBSERVER\"\
    : {\n        \"passCount\": 0,\n        \"failCount\": 0\n      },\n      \"FILETRANSFER\"\
    : {\n        \"passCount\": 0,\n        \"failCount\": 0\n      }\n    },\n  \
    \  \"RF_ASSESSMENT\": {\n      \"DATA_RATE\": {\n        \"passCount\": 0,\n \
    \       \"failCount\": 0\n      },\n      \"SNR\": {\n        \"passCount\": 0,\n\
    \        \"failCount\": 0\n      }\n    },\n    \"EMAIL\": {\n      \"MAILSERVER\"\
    : {\n        \"passCount\": 0,\n        \"failCount\": 0\n      }\n    }\n  },\n\
    \  \"failureStats\": [\n    {\n      \"errorCode\": 0,\n      \"errorTitle\":\
    \ \"string\",\n      \"testType\": \"string\",\n      \"testCategory\": \"string\"\
    \n    }\n  ]\n}\n"
  type: dict