cisco.dnac.sensor module – Resource module for Sensor
Note
This module is part of the cisco.dnac collection (version 6.16.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.
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.7.1
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Sensor’s apCoverage. |
|
The WIFI bands. |
|
Number of APs to test. |
|
RSSI threshold. |
|
Connection type of test WIRED, WIRELESS, BOTH. |
|
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: |
|
Encryption mode. |
|
Sensor’s locationInfoList. |
|
Use all sensors in the site for test. Choices:
|
|
Custom Management VLAN. Choices:
|
|
Site UUID. |
|
Site type. |
|
MAC addresses. |
|
Management VLAN. |
|
Site name hierarhy. |
|
Test template object model version (must be 2). |
|
The sensor test template name. |
|
Sensor’s profiles. |
|
Auth protocol. |
|
Authentication type OPEN, WPA2_PSK, WPA2_EaP, WEB_AUTH, MAB, DOT1X, OTHER. |
|
Certificate download URL. |
|
Auth certificate file name. |
|
Certificate password phrase. |
|
Certificate status INACTIVE or ACTIVE. |
|
Certificate transfering protocol HTTP or HTTPS. |
|
Device Type. |
|
WPA2_EAP methods EAP-FAST, PEAP-MSCHAPv2, EAP-TLS, PEAP-TLS, EAP-TTLS-MSCHAPv2, EAP-TTLS-PAP, EAP-TTLS-CHAP, EAP-FAST-GTC, EAP-PEAP-GTC. |
|
Indication of using external WEB Auth. Choices:
|
|
External WEB Auth access URL. |
|
Sensor’s extWebAuthHtmlTag. |
|
Label. |
|
Tag. |
|
Value. |
|
External authentication portal. |
|
External WEB Auth virtual IP. |
|
Sensor’s locationVlanList. |
|
Site UUID. |
|
Array of VLANs. |
|
Password string for onboarding SSID. |
|
SSID password type ASCII or HEX. |
|
Profile name. |
|
Password of SSID when passwordType is ASCII. |
|
QoS policy PlATINUM, GOLD, SILVER, BRONZE. |
|
Secure certificate enrollment protocol true or false or null for not applicable. Choices:
|
|
Sensor’s tests. |
|
Sensor’s config. |
|
IPerf direction (UPLOAD, DOWNLOAD, BOTH). |
|
DNS domain name. |
|
Downlink test. Choices:
|
|
IPerf end port. |
|
Exit command. |
|
Final prompt. |
|
NDT server. |
|
NDT server path. |
|
NDT server port. |
|
Number of packets. |
|
Password. |
|
Password prompt. |
|
File path for file transfer. |
|
Radius or WEB server port. |
|
Probe type. |
|
Protocol used by file transfer, IPerf, mail server, and radius (TCP, UDP, FTP, POP3, IMAP, CHAP, PAP). |
|
Proxy password. |
|
Proxy port. |
|
Proxy server. |
|
Proxy user name. |
|
Ping, file transfer, mail, radius, ssh, or telnet server. |
|
IPerf server list. |
|
Shared secret. |
|
IPerf start port. |
|
File transfer type (UPLOAD, DOWNLOAD, BOTH). |
|
IPerf UDP bandwidth. |
|
Uplink test. Choices:
|
|
URL. |
|
User name. |
|
User name prompt. |
|
Name of the test. |
|
User name string for onboarding SSID. |
|
VLAN. |
|
Indication of being on allowed list. Choices:
|
|
Run now (YES, NO). |
|
Sensor’s sensors. |
|
Is all sensor addition. Choices:
|
|
Is assigned. Choices:
|
|
Configuration updated YES, NO. |
|
Host name. |
|
Sensor ID. |
|
IP address. |
|
A string-stringList iPerf information. |
|
Site UUID. |
|
MAC address. |
|
Is marked for uninstall. Choices:
|
|
Sensor name. |
|
Run now YES, NO. |
|
Sensor type. |
|
Service policy. |
|
Sensor device status UP, DOWN, REBOOT. |
|
Switch MAC address. |
|
Switch serial number. |
|
Switch device UUID. |
|
Array of target APs. |
|
A string-string test MAC address. |
|
Wired application message. |
|
Wired application status. |
|
Is XOR sensor. Choices:
|
|
Sensor’s ssids. |
|
Auth protocol. |
|
Authentication type OPEN, WPA2_PSK, WPA2_EaP, WEB_AUTH, MAB, DOT1X, OTHER. |
|
WIFI bands 2.4GHz or 5GHz. |
|
Certificate download URL. |
|
Auth certificate file name. |
|
Certificate password phrase. |
|
Certificate status INACTIVE or ACTIVE. |
|
Certificate transfering protocol HTTP or HTTPS. |
|
WPA2_EAP methods EAP-FAST, PEAP-MSCHAPv2, EAP-TLS, PEAP-TLS, EAP-TTLS-MSCHAPv2, EAP-TTLS-PAP, EAP-TTLS-CHAP, EAP-FAST-GTC, EAP-PEAP-GTC. |
|
Indication of using external WEB Auth. Choices:
|
|
External WEB Auth access URL. |
|
Sensor’s extWebAuthHtmlTag. |
|
Label. |
|
Tag. |
|
Value. |
|
External authentication portal. |
|
External WEB Auth virtual IP. |
|
Layer 3 WEB Auth email address. |
|
Layer 3 WEB Auth password. |
|
Layer 3 WEB Auth security. |
|
Layer 3 WEB Auth user name. |
|
Password string for onboarding SSID. |
|
SSID password type ASCII or HEX. |
|
The SSID profile name string. |
|
Proxy server password. |
|
Proxy server port. |
|
Proxy server for onboarding SSID. |
|
Proxy server user name. |
|
Password of SSID when passwordType is ASCII. |
|
QoS policy PlATINUM, GOLD, SILVER, BRONZE. |
|
Secure certificate enrollment protocol true or false or null for not applicable. Choices:
|
|
The SSID string. |
|
Sensor’s tests. |
|
Sensor’s config. |
|
IPerf direction (UPLOAD, DOWNLOAD, BOTH). |
|
DNS domain name. |
|
Downlink test. Choices:
|
|
IPerf end port. |
|
Exit command. |
|
Final prompt. |
|
NDT server. |
|
NDT server path. |
|
NDT server port. |
|
Number of packets. |
|
Password. |
|
Password prompt. |
|
File path for file transfer. |
|
Radius or WEB server port. |
|
Probe type. |
|
Protocol used by file transfer, IPerf, mail server, and radius (TCP, UDP, FTP, POP3, IMAP, CHAP, PAP). |
|
Proxy password. |
|
Proxy port. |
|
Proxy server. |
|
Proxy user name. |
|
Ping, file transfer, mail, radius, ssh, or telnet server. |
|
IPerf server list. |
|
Shared secret. |
|
IPerf start port. |
|
File transfer type (UPLOAD, DOWNLOAD, BOTH). |
|
IPerf UDP bandwidth. |
|
Uplink test. Choices:
|
|
URL. |
|
User name. |
|
User name prompt. |
|
Name of the test. |
|
Sensor’s thirdParty. |
|
True the SSID is third party. Choices:
|
|
User name string for onboarding SSID. |
|
Indication of being on allowed list. Choices:
|
|
WLAN ID. |
|
WLC IP addres. |
|
TemplateName query parameter. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
The sensor test template version (must be 2). |
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: 0
rssiThreshold: 0
connection: string
encryptionMode: string
locationInfoList:
- allSensors: true
customManagementVlan: true
locationId: string
locationType: string
macAddressList:
- string
managementVlan: string
siteHierarchy: string
modelVersion: 0
name: string
profiles:
- authProtocol: string
authType: string
certdownloadurl: string
certfilename: string
certpassphrase: string
certstatus: string
certxferprotocol: string
deviceType: string
eapMethod: string
extWebAuth: true
extWebAuthAccessUrl: string
extWebAuthHtmlTag:
- label: string
tag: string
value: string
extWebAuthPortal: string
extWebAuthVirtualIp: string
locationVlanList:
- locationId: string
vlans:
- string
password: string
passwordType: string
profileName: string
psk: string
qosPolicy: string
scep: true
tests:
- config:
- direction: string
domains:
- string
downlinkTest: true
endPort: 0
exitCommand: string
finalPrompt: string
ndtServer: string
ndtServerPath: string
ndtServerPort: string
numPackets: 0
password: string
passwordPrompt: string
pathToDownload: string
port: 0
probeType: string
protocol: string
proxyPassword: string
proxyPort: string
proxyServer: string
proxyUserName: string
server: string
servers:
- string
sharedSecret: string
startPort: 0
transferType: string
udpBandwidth: 0
uplinkTest: true
url: string
userName: string
userNamePrompt: string
name: string
username: string
vlan: string
whiteList: true
runNow: string
sensors:
- allSensorAddition: true
assigned: true
configUpdated: string
hostName: string
iPerfInfo: {}
id: string
ipAddress: string
locationId: string
macAddress: string
markedForUninstall: true
name: string
runNow: string
sensorType: string
servicePolicy: string
status: string
switchMac: string
switchSerialNumber: string
switchUuid: string
targetAPs:
- string
testMacAddresses: {}
wiredApplicationMessage: string
wiredApplicationStatus: string
xorSensor: true
ssids:
- authProtocol: string
authType: string
bands: string
certdownloadurl: string
certfilename: string
certpassphrase: string
certstatus: string
certxferprotocol: string
eapMethod: string
extWebAuth: true
extWebAuthAccessUrl: string
extWebAuthHtmlTag:
- label: string
tag: string
value: string
extWebAuthPortal: string
extWebAuthVirtualIp: string
layer3webAuthEmailAddress: string
layer3webAuthpassword: string
layer3webAuthsecurity: string
layer3webAuthuserName: string
password: string
passwordType: string
profileName: string
proxyPassword: string
proxyPort: string
proxyServer: string
proxyUserName: string
psk: string
qosPolicy: string
scep: true
ssid: string
tests:
- config:
- direction: string
domains:
- string
downlinkTest: true
endPort: 0
exitCommand: string
finalPrompt: string
ndtServer: string
ndtServerPath: string
ndtServerPort: string
numPackets: 0
password: string
passwordPrompt: string
pathToDownload: string
port: 0
probeType: string
protocol: string
proxyPassword: string
proxyPort: string
proxyServer: string
proxyUserName: string
server: string
servers:
- string
sharedSecret: string
startPort: 0
transferType: string
udpBandwidth: 0
uplinkTest: true
url: string
userName: string
userNamePrompt: string
name: string
thirdParty:
selected: true
username: string
whiteList: true
wlanId: 0
wlc: string
version: 0
- 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: |