cisco.dnac.sensor module – Resource module for Sensor

Note

This module is part of the cisco.dnac collection (version 6.5.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 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.

  • 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 action plugin.

Requirements

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

  • dnacentersdk >= 2.5.0

  • python >= 3.5

Parameters

Parameter

Comments

apCoverage

list / elements=dictionary

Sensor’s apCoverage.

bands

string

Bands.

numberOfApsToTest

string

Number Of Aps To Test.

rssiThreshold

string

Rssi Threshold.

connection

string

Connection.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • no ← (default)

  • yes

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: “admin”

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • no

  • yes ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: “2.3.3.0”

modelVersion

integer

Model Version.

name

string

Name.

ssids

list / elements=dictionary

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

Sensor’s tests.

config

list / elements=dictionary

Config.

name

string

Name.

thirdParty

dictionary

Sensor’s thirdParty.

selected

boolean

Selected.

Choices:

  • no

  • yes

templateName

string

TemplateName query parameter.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • no

  • yes ← (default)

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 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

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

- 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

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

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”

Authors

  • Rafael Campos (@racampos)