cisco.dnac.threat_detail module – Resource module for Threat Detail

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

New in version 3.1.0: of cisco.dnac

Synopsis

  • Manage operation create of the resource Threat Detail.

  • The details for the Rogue and aWIPS threats.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

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”

endTime

integer

End Time.

isNewThreat

boolean

Is New Threat.

Choices:

  • no

  • yes

limit

integer

Limit.

offset

integer

Offset.

siteId

list / elements=string

Site Id.

startTime

integer

Start Time.

threatLevel

list / elements=string

Threat Level.

threatType

list / elements=string

Threat Type.

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 devices.Devices.threat_details,

  • Paths used are post /dna/intent/api/v1/security/threats/details,

  • 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

Examples

- name: Create
  cisco.dnac.threat_detail:
    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}}"
    endTime: 0
    isNewThreat: true
    limit: 0
    offset: 0
    siteId:
    - string
    startTime: 0
    threatLevel:
    - string
    threatType:
    - 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 \”response\”: [\n {\n \”macAddress\”: \”string\”,\n \”updatedTime\”: 0,\n \”vendor\”: \”string\”,\n \”threatType\”: \”string\”,\n \”threatLevel\”: \”string\”,\n \”apName\”: \”string\”,\n \”ssid\”: \”string\”,\n \”siteNameHierarchy\”: \”string\”\n }\n ],\n \”totalCount\”: 0,\n \”version\”: \”string\”\n}\n”

Authors

  • Rafael Campos (@racampos)