cisco.dnac.sensor_test_template_edit (6.13.3) — module

Resource module for Sensor Test Template Edit

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3


Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Manage operation update of the resource Sensor Test Template Edit.

Intent API to deploy, schedule, or edit and existing SENSOR test template.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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}}"
    locationInfoList:
    - allSensors: true
      locationId: string
      locationType: string
      siteHierarchy: string
    schedule:
      frequency:
        unit: string
        value: 0
      scheduleRange:
      - day: string
        timeRange:
        - frequency:
            unit: string
            value: 0
          from: string
          to: string
      testScheduleMode: string
    templateName: string

Inputs

    
schedule:
    description: Sensor Test Template Edit's schedule.
    suboptions:
      frequency:
        description: Sensor Test Template Edit's frequency.
        suboptions:
          unit:
            description: Unit.
            type: str
          value:
            description: Value.
            type: int
        type: dict
      scheduleRange:
        description: Sensor Test Template Edit's scheduleRange.
        elements: dict
        suboptions:
          day:
            description: Day.
            type: str
          timeRange:
            description: Sensor Test Template Edit's timeRange.
            elements: dict
            suboptions:
              frequency:
                description: Sensor Test Template Edit's frequency.
                suboptions:
                  unit:
                    description: Unit.
                    type: str
                  value:
                    description: Value.
                    type: int
                type: dict
              from:
                description: From.
                type: str
              to:
                description: To.
                type: str
            type: list
        type: list
      testScheduleMode:
        description: Test Schedule Mode.
        type: str
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

templateName:
    description: Template Name.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

locationInfoList:
    description: Sensor Test Template Edit's locationInfoList.
    elements: dict
    suboptions:
      allSensors:
        description: All Sensors.
        type: bool
      locationId:
        description: Location Id.
        type: str
      locationType:
        description: Location Type.
        type: str
      siteHierarchy:
        description: Site Hierarchy.
        type: str
    type: list

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: 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        \"locationId\"\
    : \"string\",\n        \"locationType\": \"string\",\n        \"allSensors\":\
    \ true,\n        \"siteHierarchy\": \"string\",\n        \"macAddressList\": [\n\
    \          {}\n        ]\n      }\n    ],\n    \"schedule\": {\n      \"testScheduleMode\"\
    : \"string\",\n      \"scheduleRange\": [\n        {\n          \"timeRange\"\
    : [\n            {\n              \"from\": \"string\",\n              \"to\"\
    : \"string\",\n              \"frequency\": {\n                \"value\": 0,\n\
    \                \"unit\": \"string\"\n              }\n            }\n      \
    \    ],\n          \"day\": \"string\"\n        }\n      ],\n      \"startTime\"\
    : 0,\n      \"frequency\": {\n        \"value\": 0,\n        \"unit\": \"string\"\
    \n      }\n    },\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\"\
    : \"string\"\n  }\n}\n"
  type: dict

See also