.. 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-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.sensor_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.sensor module -- Resource module for Sensor ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.3.1). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.sensor`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 3.1.0 .. 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 .. _ansible_collections.cisco.catalystcenter.sensor_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.1.6.0.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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=dictionary` .. raw:: html
- .. raw:: html
Sensor's apCoverage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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
The WIFI bands. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-apcoverage/numberofapstotest: .. rst-class:: ansible-option-title **numberOfApsToTest** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of APs to test. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-apcoverage/rssithreshold: .. rst-class:: ansible-option-title **rssiThreshold** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
RSSI threshold. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-catalystcenter_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-catalystcenter_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-catalystcenter_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-catalystcenter_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-catalystcenter_username: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst 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.catalystcenter.sensor_module__parameter-catalystcenter_verify: .. rst-class:: ansible-option-title **catalystcenter_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:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-catalystcenter_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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 type of test WIRED, WIRELESS, BOTH. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-encryptionmode: .. rst-class:: ansible-option-title **encryptionMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Encryption mode. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-locationinfolist: .. rst-class:: ansible-option-title **locationInfoList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sensor's locationInfoList. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-locationinfolist/allsensors: .. rst-class:: ansible-option-title **allSensors** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Use all sensors in the site for test. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-locationinfolist/custommanagementvlan: .. rst-class:: ansible-option-title **customManagementVlan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Custom Management VLAN. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-locationinfolist/locationid: .. rst-class:: ansible-option-title **locationId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Site UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-locationinfolist/locationtype: .. rst-class:: ansible-option-title **locationType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Site type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-locationinfolist/macaddresslist: .. rst-class:: ansible-option-title **macAddressList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
MAC addresses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-locationinfolist/managementvlan: .. rst-class:: ansible-option-title **managementVlan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Management VLAN. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-locationinfolist/sitehierarchy: .. rst-class:: ansible-option-title **siteHierarchy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Site name hierarhy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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
Test template object model version (must be 2). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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
The sensor test template name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles: .. rst-class:: ansible-option-title **profiles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sensor's profiles. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/authprotocol: .. rst-class:: ansible-option-title **authProtocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Auth protocol. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/authtype: .. rst-class:: ansible-option-title **authType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Authentication type OPEN, WPA2\_PSK, WPA2\_EaP, WEB\_AUTH, MAB, DOT1X, OTHER. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/certdownloadurl: .. rst-class:: ansible-option-title **certdownloadurl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Certificate download URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/certfilename: .. rst-class:: ansible-option-title **certfilename** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Auth certificate file name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/certpassphrase: .. rst-class:: ansible-option-title **certpassphrase** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Certificate password phrase. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/certstatus: .. rst-class:: ansible-option-title **certstatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Certificate status INACTIVE or ACTIVE. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/certxferprotocol: .. rst-class:: ansible-option-title **certxferprotocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Certificate transfering protocol HTTP or HTTPS. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/devicetype: .. rst-class:: ansible-option-title **deviceType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/eapmethod: .. rst-class:: ansible-option-title **eapMethod** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/extwebauth: .. rst-class:: ansible-option-title **extWebAuth** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indication of using external WEB Auth. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/extwebauthaccessurl: .. rst-class:: ansible-option-title **extWebAuthAccessUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
External WEB Auth access URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/extwebauthhtmltag: .. rst-class:: ansible-option-title **extWebAuthHtmlTag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sensor's extWebAuthHtmlTag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/extwebauthhtmltag/label: .. rst-class:: ansible-option-title **label** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Label. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/extwebauthhtmltag/tag: .. rst-class:: ansible-option-title **tag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Tag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/extwebauthhtmltag/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/extwebauthportal: .. rst-class:: ansible-option-title **extWebAuthPortal** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
External authentication portal. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/extwebauthvirtualip: .. rst-class:: ansible-option-title **extWebAuthVirtualIp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
External WEB Auth virtual IP. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/locationvlanlist: .. rst-class:: ansible-option-title **locationVlanList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sensor's locationVlanList. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/locationvlanlist/locationid: .. rst-class:: ansible-option-title **locationId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Site UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/locationvlanlist/vlans: .. rst-class:: ansible-option-title **vlans** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Array of VLANs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password string for onboarding SSID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/passwordtype: .. rst-class:: ansible-option-title **passwordType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SSID password type ASCII or HEX. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/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.catalystcenter.sensor_module__parameter-profiles/psk: .. rst-class:: ansible-option-title **psk** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password of SSID when passwordType is ASCII. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/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 PlATINUM, GOLD, SILVER, BRONZE. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/scep: .. rst-class:: ansible-option-title **scep** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Secure certificate enrollment protocol true or false or null for not applicable. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests: .. rst-class:: ansible-option-title **tests** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sensor's tests. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/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
Sensor's config. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/direction: .. rst-class:: ansible-option-title **direction** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IPerf direction (UPLOAD, DOWNLOAD, BOTH). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/domains: .. rst-class:: ansible-option-title **domains** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
DNS domain name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/downlinktest: .. rst-class:: ansible-option-title **downlinkTest** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Downlink test. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/endport: .. rst-class:: ansible-option-title **endPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
IPerf end port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/exitcommand: .. rst-class:: ansible-option-title **exitCommand** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Exit command. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/finalprompt: .. rst-class:: ansible-option-title **finalPrompt** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Final prompt. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/ndtserver: .. rst-class:: ansible-option-title **ndtServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NDT server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/ndtserverpath: .. rst-class:: ansible-option-title **ndtServerPath** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NDT server path. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/ndtserverport: .. rst-class:: ansible-option-title **ndtServerPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NDT server port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/numpackets: .. rst-class:: ansible-option-title **numPackets** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Number of packets. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/passwordprompt: .. rst-class:: ansible-option-title **passwordPrompt** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password prompt. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/pathtodownload: .. rst-class:: ansible-option-title **pathToDownload** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
File path for file transfer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Radius or WEB server port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/probetype: .. rst-class:: ansible-option-title **probeType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Probe type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol used by file transfer, IPerf, mail server, and radius (TCP, UDP, FTP, POP3, IMAP, CHAP, PAP). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/proxypassword: .. rst-class:: ansible-option-title **proxyPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/proxyport: .. rst-class:: ansible-option-title **proxyPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/proxyserver: .. rst-class:: ansible-option-title **proxyServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/proxyusername: .. rst-class:: ansible-option-title **proxyUserName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy user name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/server: .. rst-class:: ansible-option-title **server** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Ping, file transfer, mail, radius, ssh, or telnet server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/servers: .. rst-class:: ansible-option-title **servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IPerf server list. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/sharedsecret: .. rst-class:: ansible-option-title **sharedSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Shared secret. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/startport: .. rst-class:: ansible-option-title **startPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
IPerf start port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/transfertype: .. rst-class:: ansible-option-title **transferType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
File transfer type (UPLOAD, DOWNLOAD, BOTH). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/udpbandwidth: .. rst-class:: ansible-option-title **udpBandwidth** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
IPerf UDP bandwidth. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/uplinktest: .. rst-class:: ansible-option-title **uplinkTest** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Uplink test. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/url: .. rst-class:: ansible-option-title **url** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/username: .. rst-class:: ansible-option-title **userName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
User name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/tests/config/usernameprompt: .. rst-class:: ansible-option-title **userNamePrompt** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
User name prompt. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/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 of the test. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
User name string for onboarding SSID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/vlan: .. rst-class:: ansible-option-title **vlan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
VLAN. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-profiles/whitelist: .. rst-class:: ansible-option-title **whiteList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indication of being on allowed list. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-runnow: .. rst-class:: ansible-option-title **runNow** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Run now (YES, NO). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors: .. rst-class:: ansible-option-title **sensors** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sensor's sensors. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/allsensoraddition: .. rst-class:: ansible-option-title **allSensorAddition** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Is all sensor addition. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/assigned: .. rst-class:: ansible-option-title **assigned** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Is assigned. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/configupdated: .. rst-class:: ansible-option-title **configUpdated** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configuration updated YES, NO. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/hostname: .. rst-class:: ansible-option-title **hostName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Host name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sensor ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/ipaddress: .. rst-class:: ansible-option-title **ipAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/iperfinfo: .. rst-class:: ansible-option-title **iPerfInfo** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sensor's iPerfInfo. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/locationid: .. rst-class:: ansible-option-title **locationId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Site UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/macaddress: .. rst-class:: ansible-option-title **macAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
MAC address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/markedforuninstall: .. rst-class:: ansible-option-title **markedForUninstall** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Is marked for uninstall. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sensor name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/runnow: .. rst-class:: ansible-option-title **runNow** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Run now YES, NO. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/sensortype: .. rst-class:: ansible-option-title **sensorType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sensor type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/servicepolicy: .. rst-class:: ansible-option-title **servicePolicy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Service policy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/status: .. rst-class:: ansible-option-title **status** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sensor device status UP, DOWN, REBOOT. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/switchmac: .. rst-class:: ansible-option-title **switchMac** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Switch MAC address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/switchserialnumber: .. rst-class:: ansible-option-title **switchSerialNumber** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Switch serial number. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/switchuuid: .. rst-class:: ansible-option-title **switchUuid** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Switch device UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/targetaps: .. rst-class:: ansible-option-title **targetAPs** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Array of target APs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/testmacaddresses: .. rst-class:: ansible-option-title **testMacAddresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Sensor's testMacAddresses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/wiredapplicationmessage: .. rst-class:: ansible-option-title **wiredApplicationMessage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Wired application message. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/wiredapplicationstatus: .. rst-class:: ansible-option-title **wiredApplicationStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Wired application status. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-sensors/xorsensor: .. rst-class:: ansible-option-title **xorSensor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Is XOR sensor. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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=dictionary` .. raw:: html
- .. raw:: html
Sensor's ssids. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/authprotocol: .. rst-class:: ansible-option-title **authProtocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Auth protocol. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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
Authentication type OPEN, WPA2\_PSK, WPA2\_EaP, WEB\_AUTH, MAB, DOT1X, OTHER. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/bands: .. rst-class:: ansible-option-title **bands** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
WIFI bands 2.4GHz or 5GHz. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/certdownloadurl: .. rst-class:: ansible-option-title **certdownloadurl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Certificate download URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/certfilename: .. rst-class:: ansible-option-title **certfilename** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Auth certificate file name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/certpassphrase: .. rst-class:: ansible-option-title **certpassphrase** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Certificate password phrase. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/certstatus: .. rst-class:: ansible-option-title **certstatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Certificate status INACTIVE or ACTIVE. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/certxferprotocol: .. rst-class:: ansible-option-title **certxferprotocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Certificate transfering protocol HTTP or HTTPS. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/eapmethod: .. rst-class:: ansible-option-title **eapMethod** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/extwebauth: .. rst-class:: ansible-option-title **extWebAuth** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indication of using external WEB Auth. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/extwebauthaccessurl: .. rst-class:: ansible-option-title **extWebAuthAccessUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
External WEB Auth access URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/extwebauthhtmltag: .. rst-class:: ansible-option-title **extWebAuthHtmlTag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sensor's extWebAuthHtmlTag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/extwebauthhtmltag/label: .. rst-class:: ansible-option-title **label** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Label. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/extwebauthhtmltag/tag: .. rst-class:: ansible-option-title **tag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Tag. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/extwebauthhtmltag/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/extwebauthportal: .. rst-class:: ansible-option-title **extWebAuthPortal** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
External authentication portal. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/extwebauthvirtualip: .. rst-class:: ansible-option-title **extWebAuthVirtualIp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
External WEB Auth virtual IP. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Identification number. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/layer3webauthemailaddress: .. rst-class:: ansible-option-title **layer3webAuthEmailAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Layer 3 WEB Auth email address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/layer3webauthpassword: .. rst-class:: ansible-option-title **layer3webAuthpassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Layer 3 WEB Auth password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/layer3webauthsecurity: .. rst-class:: ansible-option-title **layer3webAuthsecurity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Layer 3 WEB Auth security. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/layer3webauthusername: .. rst-class:: ansible-option-title **layer3webAuthuserName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Layer 3 WEB Auth user name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/numaps: .. rst-class:: ansible-option-title **numAps** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of APs in the test. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/numsensors: .. rst-class:: ansible-option-title **numSensors** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of Sensors in the test. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password string for onboarding SSID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/passwordtype: .. rst-class:: ansible-option-title **passwordType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SSID password type ASCII or HEX. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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
The SSID profile name string. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/proxypassword: .. rst-class:: ansible-option-title **proxyPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy server password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/proxyport: .. rst-class:: ansible-option-title **proxyPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy server port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/proxyserver: .. rst-class:: ansible-option-title **proxyServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy server for onboarding SSID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/proxyusername: .. rst-class:: ansible-option-title **proxyUserName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy server user name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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
Password of SSID when passwordType is ASCII. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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 PlATINUM, GOLD, SILVER, BRONZE. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/scep: .. rst-class:: ansible-option-title **scep** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Secure certificate enrollment protocol true or false or null for not applicable. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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
The SSID string. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/status: .. rst-class:: ansible-option-title **status** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
WLAN status ENABLED or DISABLED. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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=dictionary` .. raw:: html
- .. raw:: html
Sensor's tests. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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
Sensor's config. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/direction: .. rst-class:: ansible-option-title **direction** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IPerf direction (UPLOAD, DOWNLOAD, BOTH). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/domains: .. rst-class:: ansible-option-title **domains** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
DNS domain name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/downlinktest: .. rst-class:: ansible-option-title **downlinkTest** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Downlink test. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/endport: .. rst-class:: ansible-option-title **endPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
IPerf end port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/exitcommand: .. rst-class:: ansible-option-title **exitCommand** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Exit command. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/finalprompt: .. rst-class:: ansible-option-title **finalPrompt** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Final prompt. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/ndtserver: .. rst-class:: ansible-option-title **ndtServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NDT server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/ndtserverpath: .. rst-class:: ansible-option-title **ndtServerPath** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NDT server path. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/ndtserverport: .. rst-class:: ansible-option-title **ndtServerPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NDT server port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/numpackets: .. rst-class:: ansible-option-title **numPackets** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Number of packets. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/passwordprompt: .. rst-class:: ansible-option-title **passwordPrompt** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password prompt. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/pathtodownload: .. rst-class:: ansible-option-title **pathToDownload** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
File path for file transfer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Radius or WEB server port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/probetype: .. rst-class:: ansible-option-title **probeType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Probe type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Protocol used by file transfer, IPerf, mail server, and radius (TCP, UDP, FTP, POP3, IMAP, CHAP, PAP). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/proxypassword: .. rst-class:: ansible-option-title **proxyPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/proxyport: .. rst-class:: ansible-option-title **proxyPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/proxyserver: .. rst-class:: ansible-option-title **proxyServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/proxyusername: .. rst-class:: ansible-option-title **proxyUserName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Proxy user name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/server: .. rst-class:: ansible-option-title **server** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Ping, file transfer, mail, radius, ssh, or telnet server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/servers: .. rst-class:: ansible-option-title **servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
IPerf server list. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/sharedsecret: .. rst-class:: ansible-option-title **sharedSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Shared secret. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/startport: .. rst-class:: ansible-option-title **startPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
IPerf start port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/transfertype: .. rst-class:: ansible-option-title **transferType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
File transfer type (UPLOAD, DOWNLOAD, BOTH). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/udpbandwidth: .. rst-class:: ansible-option-title **udpBandwidth** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
IPerf UDP bandwidth. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/uplinktest: .. rst-class:: ansible-option-title **uplinkTest** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Uplink test. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/url: .. rst-class:: ansible-option-title **url** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/username: .. rst-class:: ansible-option-title **userName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
User name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/tests/config/usernameprompt: .. rst-class:: ansible-option-title **userNamePrompt** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
User name prompt. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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 of the test. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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.catalystcenter.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
true the SSID is third party. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
User name string for onboarding SSID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/validfrom: .. rst-class:: ansible-option-title **validFrom** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Valid From UTC timestamp. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/validto: .. rst-class:: ansible-option-title **validTo** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Valid To UTC timestamp. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/whitelist: .. rst-class:: ansible-option-title **whiteList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indication of being on allowed list. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/wlanid: .. rst-class:: ansible-option-title **wlanId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
WLAN ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-ssids/wlc: .. rst-class:: ansible-option-title **wlc** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
WLC IP addres. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.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.catalystcenter.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 Catalyst 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:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sensor_module__parameter-version: .. rst-class:: ansible-option-title **version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The sensor test template version (must be 2). .. 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 uses the embedded connection manager from Cisco CATALYST SDK .. Seealso See Also -------- .. seealso:: `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 Examples -------- .. code-block:: yaml+jinja --- - name: Delete all cisco.catalystcenter.sensor: catalystcenter_host: "{{catalystcenter_host}}" catalystcenter_username: "{{catalystcenter_username}}" catalystcenter_password: "{{catalystcenter_password}}" catalystcenter_verify: "{{catalystcenter_verify}}" catalystcenter_port: "{{catalystcenter_port}}" catalystcenter_version: "{{catalystcenter_version}}" catalystcenter_debug: "{{catalystcenter_debug}}" state: absent templateName: string - name: Create cisco.catalystcenter.sensor: catalystcenter_host: "{{catalystcenter_host}}" catalystcenter_username: "{{catalystcenter_username}}" catalystcenter_password: "{{catalystcenter_password}}" catalystcenter_verify: "{{catalystcenter_verify}}" catalystcenter_port: "{{catalystcenter_port}}" catalystcenter_version: "{{catalystcenter_version}}" catalystcenter_debug: "{{catalystcenter_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: string 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 id: 0 layer3webAuthEmailAddress: string layer3webAuthpassword: string layer3webAuthsecurity: string layer3webAuthuserName: string numAps: 0 numSensors: 0 password: string passwordType: string profileName: string proxyPassword: string proxyPort: string proxyServer: string proxyUserName: string psk: string qosPolicy: string scep: true ssid: string status: string tests: - config: - direction: string domains: - string downlinkTest: true endPort: 0 exitCommand: string finalPrompt: string ndtServer: string ndtServerPath: string ndtServerPort: string numPackets: string 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 validFrom: 0 validTo: 0 whiteList: true wlanId: 0 wlc: string version: 0 .. 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.catalystcenter.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:` :ansible-rv-sample-value:`{"response": {"status": "string", "templateName": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors