W3cubDocs

/Ansible

cisco.dnac.security_rogue_additional_details_v1 module – Resource module for Security Rogue Additional Details V1

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 6.16.0

Synopsis

  • Manage operation create of the resource Security Rogue Additional Details V1.
  • This API provides additional information of the rogue threats with details at BSSID level. The additional information includes Switch Port details in case of Rogue on Wire, first time when the rogue is seen in the network etc.

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:

  • false ← (default)
  • true

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:

  • false
  • true ← (default)

dnac_version

string

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

Default: "2.3.7.6"

endTime

float

This is the epoch end time in milliseconds upto which data need to be fetched. Default value is current time.

limit

float

The maximum number of entries to return. Default value is 1000.

offset

float

The offset of the first item in the collection to return. Default value is 1.

siteId

list / elements=string

Filter Rogues by location. Site IDs information can be fetched from “Get Site” API.

startTime

float

This is the epoch start time in milliseconds from which data need to be fetched. Default value is 24 hours earlier to endTime.

threatLevel

list / elements=string

Filter Rogues by Threat Level. Threat Level information can be fetched from “Get Threat Levels” API.

threatType

list / elements=string

Filter Rogues by Threat Type. Threat Type information can be fetched from “Get Threat Types” API.

validate_response_schema

boolean

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

Choices:

  • false
  • true ← (default)

Notes

Note

  • SDK Method used are devices.Devices.rogue_additional_details_v1,
  • Paths used are post /dna/intent/api/v1/security/rogue/additional/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

See Also

See also

Cisco DNA Center documentation for Devices RogueAdditionalDetailsV1

Complete reference of the RogueAdditionalDetailsV1 API.

Examples

- name: Create
  cisco.dnac.security_rogue_additional_details_v1:
    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
    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: {"response": [{"apName": "string", "channelNumber": "string", "containment": "string", "controllerIp": "string", "controllerName": "string", "createdTime": 0, "detectingAPMac": "string", "encryption": "string", "macAddress": "string", "mldMacAddress": "string", "portDescription": "string", "radioType": "string", "siteNameHierarchy": "string", "ssid": "string", "switchIp": "string", "switchName": "string", "threatLevel": "string", "threatType": "string", "updatedTime": 0}], "totalCount": 0, "version": "string"}

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/security_rogue_additional_details_v1_module.html