cisco.catalystcenter.security_rogue_additional_details_v1 module -- Resource module for Security Rogue Additional Details V1

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

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

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

New in cisco.catalystcenter 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.

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

Default: :ansible-option-default:`443`

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

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

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

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

Default: :ansible-option-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 CATALYST Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

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 CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST 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.catalystcenter.security_rogue_additional_details_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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

catalystcenter_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"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)