cisco.dnac.sensor module – Resource module for Sensor
Note
This module is part of the cisco.dnac collection (version 6.6.1).
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.sensor.
New in cisco.dnac 3.1.0
Synopsis
Manage operations create and delete of the resource Sensor.
Intent API to create a SENSOR test template with a new SSID, existing SSID, or both new and existing SSID.
Intent API to delete an existing SENSOR test template.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.5.5
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Sensor’s apCoverage. |
|
Bands. |
|
Number Of Aps To Test. |
|
Rssi Threshold. |
|
Connection. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Model Version. |
|
Name. |
|
Sensor’s ssids. |
|
Auth Type. |
|
Categories. |
|
Profile Name. |
|
Psk. |
|
Qos Policy. |
|
Ssid. |
|
Sensor’s tests. |
|
Config. |
|
Name. |
|
Sensor’s thirdParty. |
|
Selected. Choices:
|
|
TemplateName query parameter. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are sensors.Sensors.create_sensor_test_template, sensors.Sensors.delete_sensor_test,
Paths used are post /dna/intent/api/v1/sensor, delete /dna/intent/api/v1/sensor,
Does not support
check_modeThe 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 CreateSensorTestTemplate
Complete reference of the CreateSensorTestTemplate API.
- Cisco DNA Center documentation for Sensors DeleteSensorTest
Complete reference of the DeleteSensorTest API.
Examples
- name: Create
cisco.dnac.sensor:
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
apCoverage:
- bands: string
numberOfApsToTest: string
rssiThreshold: string
connection: string
modelVersion: 0
name: string
ssids:
- authType: string
categories:
- string
profileName: string
psk: string
qosPolicy: string
ssid: string
tests:
- config:
- {}
name: string
thirdParty:
selected: true
- name: Delete all
cisco.dnac.sensor:
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
templateName: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |