.. Document meta
:orphan:
.. Anchors
.. _ansible_collections.cisco.dnac.sensor_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.dnac.sensor -- Resource module for Sensor
+++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This plugin is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 3.1.2).
To install it use: :code:`ansible-galaxy collection install cisco.dnac`.
To use it in a playbook, specify: :code:`cisco.dnac.sensor`.
.. version_added
.. versionadded:: 1.0.0 of cisco.dnac
.. contents::
:local:
:depth: 1
.. Deprecated
Synopsis
--------
.. Description
- Manage operations create and delete of the resource Sensor.
.. note::
This module has a corresponding :ref:`action plugin <action_plugins>`.
.. Aliases
.. Requirements
Requirements
------------
The below requirements are needed on the host that executes this module.
- dnacentersdk
.. Options
Parameters
----------
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="3">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-apCoverage"></div>
<b>apCoverage</b>
<a class="ansibleOptionLink" href="#parameter-apCoverage" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Sensor's apCoverage.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-apCoverage/bands"></div>
<b>bands</b>
<a class="ansibleOptionLink" href="#parameter-apCoverage/bands" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Bands.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-apCoverage/numberOfApsToTest"></div>
<b>numberOfApsToTest</b>
<a class="ansibleOptionLink" href="#parameter-apCoverage/numberOfApsToTest" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Number Of Aps To Test.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-apCoverage/rssiThreshold"></div>
<b>rssiThreshold</b>
<a class="ansibleOptionLink" href="#parameter-apCoverage/rssiThreshold" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Rssi Threshold.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-connection"></div>
<b>connection</b>
<a class="ansibleOptionLink" href="#parameter-connection" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Connection.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-modelVersion"></div>
<b>modelVersion</b>
<a class="ansibleOptionLink" href="#parameter-modelVersion" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Model Version.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-name"></div>
<b>name</b>
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-ssids"></div>
<b>ssids</b>
<a class="ansibleOptionLink" href="#parameter-ssids" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Sensor's ssids.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-ssids/authType"></div>
<b>authType</b>
<a class="ansibleOptionLink" href="#parameter-ssids/authType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Auth Type.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-ssids/categories"></div>
<b>categories</b>
<a class="ansibleOptionLink" href="#parameter-ssids/categories" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Categories.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-ssids/profileName"></div>
<b>profileName</b>
<a class="ansibleOptionLink" href="#parameter-ssids/profileName" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Profile Name.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-ssids/psk"></div>
<b>psk</b>
<a class="ansibleOptionLink" href="#parameter-ssids/psk" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Psk.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-ssids/qosPolicy"></div>
<b>qosPolicy</b>
<a class="ansibleOptionLink" href="#parameter-ssids/qosPolicy" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Qos Policy.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-ssids/ssid"></div>
<b>ssid</b>
<a class="ansibleOptionLink" href="#parameter-ssids/ssid" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Ssid.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-ssids/tests"></div>
<b>tests</b>
<a class="ansibleOptionLink" href="#parameter-ssids/tests" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Sensor's tests.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-ssids/tests/config"></div>
<b>config</b>
<a class="ansibleOptionLink" href="#parameter-ssids/tests/config" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">list</span>
/ <span style="color: purple">elements=string</span> </div>
</td>
<td>
</td>
<td>
<div>Config.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-ssids/tests/name"></div>
<b>name</b>
<a class="ansibleOptionLink" href="#parameter-ssids/tests/name" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Name.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-ssids/thirdParty"></div>
<b>thirdParty</b>
<a class="ansibleOptionLink" href="#parameter-ssids/thirdParty" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>Sensor's thirdParty.</div>
</td>
</tr>
<tr>
<td class="elbow-placeholder"></td>
<td class="elbow-placeholder"></td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-ssids/thirdParty/selected"></div>
<b>selected</b>
<a class="ansibleOptionLink" href="#parameter-ssids/thirdParty/selected" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Selected.</div>
</td>
</tr>
<tr>
<td colspan="3">
<div class="ansibleOptionAnchor" id="parameter-templateName"></div>
<b>templateName</b>
<a class="ansibleOptionLink" href="#parameter-templateName" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>TemplateName query parameter.</div>
</td>
</tr>
</table>
<br/>
.. Notes
.. Seealso
See Also
--------
.. seealso::
`Sensor reference <https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary>`_
Complete reference of the Sensor object model.
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- 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
.. Facts
.. Return values
Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Key</th>
<th>Returned</th>
<th width="100%">Description</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-dnac_response"></div>
<b>dnac_response</b>
<a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>always</td>
<td>
<div>A dictionary or list with the response returned by the Cisco DNAC Python SDK</div>
<br/>
<div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{
"version": "string",
"response": {
"_id": "string",
"name": "string",
"version": 0,
"modelVersion": 0,
"startTime": 0,
"lastModifiedTime": 0,
"numAssociatedSensor": 0,
"location": {},
"siteHierarchy": {},
"status": "string",
"connection": "string",
"frequency": {},
"rssiThreshold": 0,
"numNeighborAPThreshold": 0,
"scheduleInDays": 0,
"wlans": [],
"ssids": [
{
"bands": {},
"ssid": "string",
"profileName": "string",
"authType": "string",
"authTypeRcvd": {},
"psk": "string",
"username": {},
"password": {},
"eapMethod": {},
"scep": true,
"authProtocol": {},
"certfilename": {},
"certxferprotocol": "string",
"certstatus": "string",
"certpassphrase": {},
"certdownloadurl": {},
"numAps": 0,
"numSensors": 0,
"layer3webAuthsecurity": {},
"layer3webAuthuserName": {},
"layer3webAuthpassword": {},
"extWebAuthVirtualIp": {},
"layer3webAuthEmailAddress": {},
"qosPolicy": "string",
"extWebAuth": true,
"whiteList": true,
"extWebAuthPortal": {},
"extWebAuthAccessUrl": {},
"extWebAuthHtmlTag": [],
"thirdParty": {
"selected": true
},
"id": 0,
"wlanId": 0,
"wlc": {},
"validFrom": 0,
"validTo": 0,
"status": "string",
"tests": [
{
"name": "string",
"config": []
}
]
}
],
"testScheduleMode": "string",
"showWlcUpgradeBanner": true,
"radioAsSensorRemoved": true,
"encryptionMode": "string",
"runNow": "string",
"locationInfoList": [],
"schedule": {},
"tests": {},
"sensors": [],
"apCoverage": [
{
"bands": "string",
"numberOfApsToTest": 0,
"rssiThreshold": 0
}
],
"testDurationEstimate": 0,
"testTemplate": true,
"legacyTestSuite": true,
"tenantId": {}
}
}</div>
</td>
</tr>
</table>
<br/><br/>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Rafael Campos (@racampos)
.. Parsing errors