.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. 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 `_ (version 3.2.0). 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:: 3.1.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 `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk >= 2.3.1 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
apCoverage
list / elements=string
Sensor's apCoverage.
bands
string
Bands.
numberOfApsToTest
string
Number Of Aps To Test.
rssiThreshold
string
Rssi Threshold.
connection
string
Connection.
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.2.3"
Informs the SDK which version of Cisco DNA Center to use.
modelVersion
integer
Model Version.
name
string
Name.
ssids
list / elements=string
Sensor's ssids.
authType
string
Auth Type.
categories
list / elements=string
Categories.
profileName
string
Profile Name.
psk
string
Psk.
qosPolicy
string
Qos Policy.
ssid
string
Ssid.
tests
list / elements=string
Sensor's tests.
config
list / elements=string
Config.
name
string
Name.
thirdParty
dictionary
Sensor's thirdParty.
selected
boolean
    Choices:
  • no
  • yes
Selected.
templateName
string
TemplateName query parameter.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

.. Attributes .. Notes Notes ----- .. note:: - Does not support ``check_mode`` .. Seealso See Also -------- .. seealso:: `Sensor reference `_ 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 `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "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": {} } }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors