cisco.catalystcenter.traffic_steering_firewalls_top_n_analytics_info module -- Information module for Traffic Steering Firewalls Top N Analytics

Note

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

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

New in cisco.catalystcenter 2.11.0

Synopsis

  • Get all Traffic Steering Firewalls Top N Analytics. - > This API retrieves the top firewalls used by traffic steering policies across the network. It provides comprehensive analytics on firewalls that are most frequently utilized in directing and managing network traffic. By accessing this data, network administrators can gain valuable insights into how firewalls are performing, which ones are most active, and how they contribute to overall network security and efficiency. This information is crucial for optimizing network security policies, identifying potential vulnerabilities, and ensuring effective traffic management. The API supports strategic decision-making and resource allocation by highlighting the firewalls that play a key role in maintaining network integrity and performance.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

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

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

headers

dictionary

Additional headers.

limit

integer

Limit query parameter. The number of top records to retrieve.

offset

integer

Offset query parameter. The first record to show for this page; the first record is numbered 1.

order

string

Order query parameter. Whether ascending or descending order should be used to sort the response.

sortBy

string

SortBy query parameter. A property within the response to sort by.

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 security.Security.retrieves_the_top_n_analytics_data_related_to_firewalls,

  • Paths used are get /dna/data/api/v1/trafficSteeringFirewalls/topNAnalytics,

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Security RetrievesTheTopNAnalyticsDataRelatedToFirewalls

Complete reference of the RetrievesTheTopNAnalyticsDataRelatedToFirewalls API.

Examples

---
- name: Get all Traffic Steering Firewalls Top N Analytics
  cisco.catalystcenter.traffic_steering_firewalls_top_n_analytics_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    limit: 5
    offset: 1
    sortBy: policyCount
    order: desc
  register: result

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 Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": [{"firewallIpAddress": "string", "id": "string", "policyCount": 0}], "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)