cisco.catalystcenter.endpoint_analytics_profiling_rules_count_v1_info module -- Information module for Endpoint Analytics Profiling Rules Count 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.endpoint_analytics_profiling_rules_count_v1_info.

New in cisco.catalystcenter 6.16.0

Synopsis

• Get all Endpoint Analytics Profiling Rules Count V1.

• This API fetches the count of profiling rules based on the filter values provided in the query parameters. The filter parameters are same as that of 'GET /profiling-rules' API, excluding the pagination and sort parameters.

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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
headers dictionary	Additional headers.
includeDeleted boolean	IncludeDeleted query parameter. Flag to indicate whether deleted rules should be part of the records fetched. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
ruleType string	RuleType query parameter. Use comma-separated list of rule types to filter the data. Defaults to 'Custom Rule'.
validate_response_schema boolean	Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are a_i_endpoint_analytics.AIEndpointAnalytics.get_count_of_profiling_rules_v1,

• Paths used are get /dna/intent/api/v1/endpoint-analytics/profiling-rules/count,

• Supports 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

Examples

- name: Get all Endpoint Analytics Profiling Rules Count V1
  cisco.catalystcenter.endpoint_analytics_profiling_rules_count_v1_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    headers: "{{my_headers | from_json}}"
    ruleType: string
    includeDeleted: 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 DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"count": 0}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)