cisco.dnac.sensor – Resource module for Sensor

Note

This plugin is part of the cisco.dnac collection (version 3.2.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.sensor.

New in version 3.1.0: of cisco.dnac

Synopsis

  • Manage operations create and delete of the resource Sensor.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.3.3

  • python >= 3.5

Parameters

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=dictionary
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.

Notes

Note

  • Does not support 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

See Also

See also

Sensor reference

Complete reference of the Sensor object model.

Examples

- name: Create
  cisco.dnac.sensor:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    apCoverage:
    - bands: string
      numberOfApsToTest: 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

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


Authors

  • Rafael Campos (@racampos)