cisco.dnac.sensor (6.13.3) — module

Resource module for Sensor

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
name:
    description: Name.
    type: str

ssids:
    description: Sensor's ssids.
    elements: dict
    suboptions:
      authType:
        description: Auth Type.
        type: str
      categories:
        description: Categories.
        elements: str
        type: list
      profileName:
        description: Profile Name.
        type: str
      psk:
        description: Psk.
        type: str
      qosPolicy:
        description: Qos Policy.
        type: str
      ssid:
        description: Ssid.
        type: str
      tests:
        description: Sensor's tests.
        elements: dict
        suboptions:
          config:
            description: Config.
            elements: dict
            type: list
          name:
            description: Name.
            type: str
        type: list
      thirdParty:
        description: Sensor's thirdParty.
        suboptions:
          selected:
            description: Selected.
            type: bool
        type: dict
    type: list

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

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

apCoverage:
    description: Sensor's apCoverage.
    elements: dict
    suboptions:
      bands:
        description: Bands.
        type: str
      numberOfApsToTest:
        description: Number Of Aps To Test.
        type: str
      rssiThreshold:
        description: Rssi Threshold.
        type: str
    type: list

connection:
    description: Connection.
    type: str

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

modelVersion:
    description: Model Version.
    type: int

templateName:
    description: TemplateName query parameter.
    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

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    ],\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"
  type: dict

See also