cisco.catalystcenter.assurance_events_query module -- Resource module for Assurance Events Query
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.assurance_events_query.
New in cisco.catalystcenter 1.0.0
Synopsis
Manage operation create of the resource Assurance Events Query.
Returns the list of events discovered by Catalyst Center, determined by the.
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 |
|---|---|
Assurance Events Query's attributes. |
|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Assurance Events Query's deviceFamily. |
|
Assurance Events Query's endTime. |
|
Assurance Events Query's filters. |
|
Assurance Events Query's key. |
|
Assurance Events Query's operator. |
|
Assurance Events Query's value. |
|
Additional headers. |
|
Assurance Events Query's page. |
|
Assurance Events Query's limit. |
|
Assurance Events Query's offset. |
|
Assurance Events Query's sortBy. |
|
Assurance Events Query's name. |
|
Assurance Events Query's order. |
|
Assurance Events Query's startTime. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
|
Assurance Events Query's views. |
Notes
Note
SDK Method used are devices.Devices.query_assurance_events_with_filters,
Paths used are post /dna/data/api/v1/assuranceEvents/query,
Does not support
check_modeThe 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 Devices QueryAssuranceEventsWithFilters
Complete reference of the QueryAssuranceEventsWithFilters API.
Examples
---
- name: Create
cisco.catalystcenter.assurance_events_query:
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}}"
attributes:
- string
deviceFamily:
- string
endTime: 0
filters:
- key: string
operator: string
value: string
headers: '{{my_headers | from_json}}'
page:
limit: 0
offset: 0
sortBy:
- name: string
order: string
startTime: 0
views:
- string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|