cisco.dnac.sensor_test_template_edit module -- Resource module for Sensor Test Template Edit

Note

This module is part of the cisco.dnac collection (version 6.24.0).

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 3.1.0

Synopsis

  • Manage operation update of the resource Sensor Test Template Edit.

  • Intent API to deploy, schedule, or edit and 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.7.2

  • python >= 3.5

Parameters

Parameter

Comments

_id

string

The sensor test template unique identifier, generated at test creation time.

actionInProgress

string

Indication of inprogress action.

apCoverage

list / elements=dictionary

Sensor Test Template Edit's apCoverage.

bands

string

The WIFI bands.

numberOfApsToTest

integer

Number of APs to test.

rssiThreshold

integer

RSSI threshold.

connection

string

Connection type of test WIRED, WIRELESS, BOTH.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

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: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

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

Default: :ansible-option-default:`"2.3.7.6"`

encryptionMode

string

Encryption mode.

frequency

dictionary

Sensor Test Template Edit's frequency.

unit

string

Unit of the time value (NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS).

value

integer

Value of the unit.

lastModifiedTime

integer

Last modify time.

location

string

Location string.

locationInfoList

list / elements=dictionary

Sensor Test Template Edit's locationInfoList.

allSensors

boolean

Use all sensors in the site for test.

Choices:

customManagementVlan

boolean

Custom Management VLAN.

Choices:

locationId

string

Site UUID.

locationType

string

Site type.

macAddressList

list / elements=string

MAC addresses.

managementVlan

string

Management VLAN.

siteHierarchy

string

Site name hierarhy.

modelVersion

integer

Test template object model version (must be 2).

name

string

The sensor test template name, which is the same as in 'templateName'.

numAssociatedSensor

integer

Number of associated sensor.

numNeighborAPThreshold

integer

Number of neighboring AP threshold.

profiles

list / elements=dictionary

Sensor Test Template Edit's profiles.

authProtocol

string

Auth protocol.

authType

string

Authentication type OPEN, WPA2_PSK, WPA2_EAP, WEB_AUTH, MAB, DOT1X, OTHER.

certdownloadurl

string

Certificate download URL.

certfilename

string

Auth certificate file name.

certpassphrase

string

Certificate password phrase.

certstatus

string

Certificate status INACTIVE or ACTIVE.

certxferprotocol

string

Certificate transfering protocol HTTP or HTTPS.

deviceType

string

Device Type.

eapMethod

string

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.

extWebAuth

boolean

Indication of using external WEB Auth.

Choices:

extWebAuthAccessUrl

string

External WEB Auth access URL.

extWebAuthHtmlTag

list / elements=dictionary

Sensor Test Template Edit's extWebAuthHtmlTag.

label

string

Label.

tag

string

Tag.

value

string

Value.

extWebAuthPortal

string

External authentication portal.

extWebAuthVirtualIp

string

External WEB Auth virtual IP.

locationVlanList

list / elements=dictionary

Sensor Test Template Edit's locationVlanList.

locationId

string

Site UUID.

vlans

list / elements=string

Array of VLANs.

password

string

Password string for onboarding SSID.

passwordType

string

SSID password type ASCII or HEX.

profileName

string

Profile name.

psk

string

Password of SSID when passwordType is ASCII.

qosPolicy

string

QoS policy PlATINUM, GOLD, SILVER, BRONZE.

scep

boolean

Secure certificate enrollment protocol true or false or null for not applicable.

Choices:

tests

list / elements=dictionary

Sensor Test Template Edit's tests.

config

list / elements=dictionary

Sensor Test Template Edit's config.

direction

string

IPerf direction (UPLOAD, DOWNLOAD, BOTH).

domains

list / elements=string

DNS domain name.

downlinkTest

boolean

Downlink test.

Choices:

endPort

integer

IPerf end port.

exitCommand

string

Exit command.

finalPrompt

string

Final prompt.

ndtServer

string

NDT server.

ndtServerPath

string

NDT server path.

ndtServerPort

string

NDT server port.

numPackets

integer

Number of packets.

password

string

Password.

passwordPrompt

string

Password prompt.

pathToDownload

string

File path for file transfer.

port

integer

Radius or WEB server port.

probeType

string

Probe type.

protocol

string

Protocol used by file transfer, IPerf, mail server, and radius (TCP, UDP, FTP, POP3, IMAP, CHAP, PAP).

proxyPassword

string

Proxy password.

proxyPort

string

Proxy port.

proxyServer

string

Proxy server.

proxyUserName

string

Proxy user name.

server

string

Ping, file transfer, mail, radius, ssh, or telnet server.

servers

list / elements=string

IPerf server list.

sharedSecret

string

Shared secret.

startPort

integer

IPerf start port.

transferType

string

File transfer type (UPLOAD, DOWNLOAD, BOTH).

udpBandwidth

integer

IPerf UDP bandwidth.

uplinkTest

boolean

Uplink test.

Choices:

url

string

URL.

userName

string

User name.

userNamePrompt

string

User name prompt.

name

string

Name of the test.

username

string

User name string for onboarding SSID.

vlan

string

VLAN.

whiteList

boolean

Indication of being on allowed list.

Choices:

radioAsSensorRemoved

boolean

Radio as sensor removed.

Choices:

rssiThreshold

integer

RSSI threshold.

runNow

string

Run now (YES, NO).

scheduleInDays

integer

Bit-wise value of scheduled test days.

sensors

list / elements=dictionary

Sensor Test Template Edit's sensors.

allSensorAddition

boolean

Is all sensor addition.

Choices:

assigned

boolean

Is assigned.

Choices:

configUpdated

string

Configuration updated YES, NO.

hostName

string

Host name.

id

string

Sensor ID.

ipAddress

string

IP address.

iPerfInfo

dictionary

A string-stringList iPerf information.

locationId

string

Site UUID.

macAddress

string

MAC address.

markedForUninstall

boolean

Is marked for uninstall.

Choices:

name

string

Sensor name.

runNow

string

Run now YES, NO.

sensorType

string

Sensor type.

servicePolicy

string

Service policy.

status

string

Sensor device status UP, DOWN, REBOOT.

switchMac

string

Switch MAC address.

switchSerialNumber

string

Switch serial number.

switchUuid

string

Switch device UUID.

targetAPs

list / elements=string

Array of target APs.

testMacAddresses

dictionary

A string-string test MAC address.

wiredApplicationMessage

string

Wired application message.

wiredApplicationStatus

string

Wired application status.

xorSensor

boolean

Is XOR sensor.

Choices:

showWlcUpgradeBanner

boolean

Show WLC upgrade banner.

Choices:

siteHierarchy

string

Site hierarchy.

ssids

list / elements=dictionary

Sensor Test Template Edit's ssids.

authProtocol

string

Auth protocol.

authType

string

Authentication type OPEN, WPA2_PSK, WPA2_EAP, WEB_AUTH, MAB, DOT1X, OTHER.

bands

string

WIFI bands 2.4GHz or 5GHz.

certdownloadurl

string

Certificate download URL.

certfilename

string

Auth certificate file name.

certpassphrase

string

Certificate password phrase.

certstatus

string

Certificate status INACTIVE or ACTIVE.

certxferprotocol

string

Certificate transfering protocol HTTP or HTTPS.

eapMethod

string

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.

extWebAuth

boolean

Indication of using external WEB Auth.

Choices:

extWebAuthAccessUrl

string

External WEB Auth access URL.

extWebAuthHtmlTag

list / elements=dictionary

Sensor Test Template Edit's extWebAuthHtmlTag.

label

string

Label.

tag

string

Tag.

value

string

Value.

extWebAuthPortal

string

External authentication portal.

extWebAuthVirtualIp

string

External WEB Auth virtual IP.

id

integer

Identification number.

layer3webAuthEmailAddress

string

Layer 3 WEB Auth email address.

layer3webAuthpassword

string

Layer 3 WEB Auth password.

layer3webAuthsecurity

string

Layer 3 WEB Auth security.

layer3webAuthuserName

string

Layer 3 WEB Auth user name.

numAps

integer

Number of APs in the test.

numSensors

integer

Number of Sensors in the test.

password

string

Password string for onboarding SSID.

passwordType

string

SSID password type ASCII or HEX.

profileName

string

The SSID profile name string.

proxyPassword

string

Proxy server password.

proxyPort

string

Proxy server port.

proxyServer

string

Proxy server for onboarding SSID.

proxyUserName

string

Proxy server user name.

psk

string

Password of SSID when passwordType is ASCII.

qosPolicy

string

QoS policy PlATINUM, GOLD, SILVER, BRONZE.

scep

boolean

Secure certificate enrollment protocol true or false or null for not applicable.

Choices:

ssid

string

The SSID string.

status

string

WLAN status ENABLED or DISABLED.

tests

list / elements=dictionary

Sensor Test Template Edit's tests.

config

list / elements=dictionary

Sensor Test Template Edit's config.

direction

string

IPerf direction (UPLOAD, DOWNLOAD, BOTH).

domains

list / elements=string

DNS domain name.

downlinkTest

boolean

Downlink test.

Choices:

endPort

integer

IPerf end port.

exitCommand

string

Exit command.

finalPrompt

string

Final prompt.

ndtServer

string

NDT server.

ndtServerPath

string

NDT server path.

ndtServerPort

string

NDT server port.

numPackets

integer

Number of packets.

password

string

Password.

passwordPrompt

string

Password prompt.

pathToDownload

string

File path for file transfer.

port

integer

Radius or WEB server port.

probeType

string

Probe type.

protocol

string

Protocol used by file transfer, IPerf, mail server, and radius (TCP, UDP, FTP, POP3, IMAP, CHAP, PAP).

proxyPassword

string

Proxy password.

proxyPort

string

Proxy port.

proxyServer

string

Proxy server.

proxyUserName

string

Proxy user name.

server

string

Ping, file transfer, mail, radius, ssh, or telnet server.

servers

list / elements=string

IPerf server list.

sharedSecret

string

Shared secret.

startPort

integer

IPerf start port.

transferType

string

File transfer type (UPLOAD, DOWNLOAD, BOTH).

udpBandwidth

integer

IPerf UDP bandwidth.

uplinkTest

boolean

Uplink test.

Choices:

url

string

URL.

userName

string

User name.

userNamePrompt

string

User name prompt.

name

string

Name of the test.

thirdParty

dictionary

Sensor Test Template Edit's thirdParty.

selected

boolean

True the SSID is third party.

Choices:

username

string

User name string for onboarding SSID.

validFrom

integer

Valid From UTC timestamp.

validTo

integer

Valid To UTC timestamp.

whiteList

boolean

Indication of being on allowed list.

Choices:

wlanId

integer

WLAN ID.

wlc

string

WLC IP addres.

startTime

integer

Start time.

status

string

Status of the test (RUNNING, NOTRUNNING).

templateName

string

The test template name that is to be edited.

testScheduleMode

string

Test schedule mode (ONDEMAND, DEDICATED, SCHEDULED, CONTINUOUS, RUNNOW).

validate_response_schema

boolean

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

Choices:

version

integer

The sensor test template version (must be 2).

wlans

list / elements=string

WLANs list.

Notes

Note

  • SDK Method used are sensors.Sensors.edit_sensor_test_template,

  • Paths used are put /dna/intent/api/v1/AssuranceScheduleSensorTest,

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

Complete reference of the EditSensorTestTemplate API.

Examples

- name: Update all
  cisco.dnac.sensor_test_template_edit:
    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}}"
    _id: string
    actionInProgress: string
    apCoverage:
    - bands: string
      numberOfApsToTest: 0
      rssiThreshold: 0
    connection: string
    encryptionMode: string
    frequency:
      unit: string
      value: 0
    lastModifiedTime: 0
    location: string
    locationInfoList:
    - allSensors: true
      customManagementVlan: true
      locationId: string
      locationType: string
      macAddressList:
      - string
      managementVlan: string
      siteHierarchy: string
    modelVersion: 0
    name: string
    numAssociatedSensor: 0
    numNeighborAPThreshold: 0
    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: 0
          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
    radioAsSensorRemoved: true
    rssiThreshold: 0
    runNow: string
    scheduleInDays: 0
    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
    showWlcUpgradeBanner: true
    siteHierarchy: string
    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: 0
          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
    startTime: 0
    status: string
    templateName: string
    testScheduleMode: string
    version: 0
    wlans:
    - 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: :ansible-rv-sample-value:`{"response": {"\_id": "string", "actionInProgress": "string", "apCoverage": [{"bands": "string", "numberOfApsToTest": 0, "rssiThreshold": 0}], "connection": "string", "encryptionMode": "string", "frequency": {"unit": "string", "value": 0}, "lastModifiedTime": 0, "location": "string", "locationInfoList": [{"allSensors": true, "customManagementVlan": true, "locationId": "string", "locationType": "string", "macAddressList": ["string"], "managementVlan": "string", "siteHierarchy": "string"}], "modelVersion": 0, "name": "string", "numAssociatedSensor": 0, "numNeighborAPThreshold": 0, "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": 0, "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}], "radioAsSensorRemoved": true, "rssiThreshold": 0, "runNow": "string", "scheduleInDays": 0, "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}], "showWlcUpgradeBanner": true, "siteHierarchy": "string", "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": 0, "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"}], "startTime": 0, "status": "string", "testScheduleMode": "string", "version": 0, "wlans": ["string"]}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)