cisco.catalystcenter.system_issue_definitions_count_info module -- Information module for System Issue Definitions Count

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

New in cisco.catalystcenter 1.0.0

Synopsis

  • Get all System Issue Definitions Count.

  • Get the count of system defined issue definitions based on provided filters.

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

deviceType

string

DeviceType query parameter. These are the device families/types supported for system issue definitions. If no input is made on device type, all device types are considered.

headers

dictionary

Additional headers.

id

string

Id query parameter. The definition identifier. Examples id=015d9cba-4f53-4087-8317-7e49e5ffef46 (single entity id request) id=015d9cba-4f53-4087-8317-7e49e5ffef46&id=015d9cba-4f53-4087-8317-7e49e5ffef47 (multiple ids in the query param).

issueEnabled

boolean

IssueEnabled query parameter. The enablement status of the issue definition, either true or false.

Choices:

name

string

Name query parameter. The list of system defined issue names. (Ex."BGP_Down") Examples name=BGP_Down (single entity uuid requested) name=BGP_Down&name=BGP_Flap (multiple issue names separated by & operator).

priority

string

Priority query parameter. Issue priority, possible values are P1, P2, P3, P4. `P1` A critical issue that needs immediate attention and can have a wide impact on network operations. `P2` A major issue that can potentially impact multiple devices or clients. `P3` A minor issue that has a localized or minimal impact. `P4` A warning issue that may not be an immediate problem but addressing it can optimize the network performance.

profileId

string

ProfileId query parameter. The profile identier to fetch the profile associated issue defintions. The default is `global`. Please refer Network design profiles documentation for more details.

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 issues.Issues.get_the_count_of_system_defined_issue_definitions_based_on_provided_filters,

  • Paths used are get /dna/intent/api/v1/systemIssueDefinitions/count,

  • 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 Issues GetTheCountOfSystemDefinedIssueDefinitionsBasedOnProvidedFilters

Complete reference of the GetTheCountOfSystemDefinedIssueDefinitionsBasedOnProvidedFilters API.

Examples

---
- name: Get all System Issue Definitions Count
  cisco.catalystcenter.system_issue_definitions_count_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}}"
    deviceType: string
    profileId: string
    id: string
    name: string
    priority: string
    issueEnabled: true
  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": {"count": 0}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)