.. 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 .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-entry .. role:: ansible-option-default .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.sensor_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.sensor module -- Resource module for Sensor ++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 5.0.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 :code:`ansible-galaxy collection list`. 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. - 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 :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk == 2.4.5 - python >= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-apCoverage: .. rst-class:: ansible-option-title **apCoverage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Sensor's apCoverage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-apCoverage/bands: .. rst-class:: ansible-option-title **bands** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Bands. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-apCoverage/numberOfApsToTest: .. rst-class:: ansible-option-title **numberOfApsToTest** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Number Of Aps To Test. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-apCoverage/rssiThreshold: .. rst-class:: ansible-option-title **rssiThreshold** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Rssi Threshold. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-connection: .. rst-class:: ansible-option-title **connection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Connection. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.sensor_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-modelVersion: .. rst-class:: ansible-option-title **modelVersion** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Model Version. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids: .. rst-class:: ansible-option-title **ssids** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Sensor's ssids. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids/authType: .. rst-class:: ansible-option-title **authType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Auth Type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids/categories: .. rst-class:: ansible-option-title **categories** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Categories. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids/profileName: .. rst-class:: ansible-option-title **profileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Profile Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids/psk: .. rst-class:: ansible-option-title **psk** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Psk. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids/qosPolicy: .. rst-class:: ansible-option-title **qosPolicy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Qos Policy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids/ssid: .. rst-class:: ansible-option-title **ssid** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Ssid. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids/tests: .. rst-class:: ansible-option-title **tests** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Sensor's tests. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids/tests/config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Config. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids/tests/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids/thirdParty: .. rst-class:: ansible-option-title **thirdParty** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sensor's thirdParty. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-ssids/thirdParty/selected: .. rst-class:: ansible-option-title **selected** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Selected. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-templateName: .. rst-class:: ansible-option-title **templateName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
TemplateName query parameter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
.. Attributes .. Notes 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 \ :literal:`check\_mode`\ - The 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 .. Seealso .. 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: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.sensor_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` "{\\n \\"version\\": \\"string\\",\\n \\"response\\": {\\n \\"\_id\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"version\\": 0,\\n \\"modelVersion\\": 0,\\n \\"startTime\\": 0,\\n \\"lastModifiedTime\\": 0,\\n \\"numAssociatedSensor\\": 0,\\n \\"location\\": {},\\n \\"siteHierarchy\\": {},\\n \\"status\\": \\"string\\",\\n \\"connection\\": \\"string\\",\\n \\"frequency\\": {},\\n \\"rssiThreshold\\": 0,\\n \\"numNeighborAPThreshold\\": 0,\\n \\"scheduleInDays\\": 0,\\n \\"wlans\\": [\\n {}\\n ],\\n \\"ssids\\": [\\n {\\n \\"bands\\": {},\\n \\"ssid\\": \\"string\\",\\n \\"profileName\\": \\"string\\",\\n \\"authType\\": \\"string\\",\\n \\"authTypeRcvd\\": {},\\n \\"psk\\": \\"string\\",\\n \\"username\\": {},\\n \\"password\\": {},\\n \\"eapMethod\\": {},\\n \\"scep\\": true,\\n \\"authProtocol\\": {},\\n \\"certfilename\\": {},\\n \\"certxferprotocol\\": \\"string\\",\\n \\"certstatus\\": \\"string\\",\\n \\"certpassphrase\\": {},\\n \\"certdownloadurl\\": {},\\n \\"numAps\\": 0,\\n \\"numSensors\\": 0,\\n \\"layer3webAuthsecurity\\": {},\\n \\"layer3webAuthuserName\\": {},\\n \\"layer3webAuthpassword\\": {},\\n \\"extWebAuthVirtualIp\\": {},\\n \\"layer3webAuthEmailAddress\\": {},\\n \\"qosPolicy\\": \\"string\\",\\n \\"extWebAuth\\": true,\\n \\"whiteList\\": true,\\n \\"extWebAuthPortal\\": {},\\n \\"extWebAuthAccessUrl\\": {},\\n \\"extWebAuthHtmlTag\\": [\\n {}\\n ],\\n \\"thirdParty\\": {\\n \\"selected\\": true\\n },\\n \\"id\\": 0,\\n \\"wlanId\\": 0,\\n \\"wlc\\": {},\\n \\"validFrom\\": 0,\\n \\"validTo\\": 0,\\n \\"status\\": \\"string\\",\\n \\"tests\\": [\\n {\\n \\"name\\": \\"string\\",\\n \\"config\\": [\\n {}\\n ]\\n }\\n ]\\n }\\n ],\\n \\"testScheduleMode\\": \\"string\\",\\n \\"showWlcUpgradeBanner\\": true,\\n \\"radioAsSensorRemoved\\": true,\\n \\"encryptionMode\\": \\"string\\",\\n \\"runNow\\": \\"string\\",\\n \\"locationInfoList\\": [\\n {}\\n ],\\n \\"schedule\\": {},\\n \\"tests\\": {},\\n \\"sensors\\": [\\n {}\\n ],\\n \\"apCoverage\\": [\\n {\\n \\"bands\\": \\"string\\",\\n \\"numberOfApsToTest\\": 0,\\n \\"rssiThreshold\\": 0\\n }\\n ],\\n \\"testDurationEstimate\\": 0,\\n \\"testTemplate\\": true,\\n \\"legacyTestSuite\\": true,\\n \\"tenantId\\": {}\\n }\\n}\\n" .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors