cisco.catalystcenter.assurance_events_info module -- Information module for Assurance Events
Note
This module is part of the cisco.catalystcenter collection (version 2.12.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_info.
New in cisco.catalystcenter 1.0.0
Synopsis
Get all Assurance Events.
Get Assurance Events by id.
API to fetch the details of an assurance event using event `id`. For detailed.
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 |
|---|---|
ApMac query parameter. MAC address of the access point. This parameter is applicable for `Unified AP` and `Wireless Client` events. This field supports wildcard (`*`) character-based search. Ex `*50 0F*` or `50 0F*` or `*50 0F` Examples `apMac=50 0F 80 0F F7 E0` (single apMac requested) `apMac=50 0F 80 0F F7 E0&apMac=18 80 90 AB 7E A0` (multiple apMac requested). |
|
Attribute query parameter. The list of attributes that needs to be included in the response. If this parameter is not provided, then basic attributes (`id`, `name`, `timestamp`, `details`, `messageType`, `siteHierarchyId`, `siteHierarchy`, `deviceFamily`, `networkDeviceId`, `networkDeviceName`, `managementIpAddress`) would be part of the response. Examples `attribute=name` (single attribute requested) `attribute=name&attribute=networkDeviceName` (multiple attribute requested). |
|
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"` |
|
ClientMac query parameter. MAC address of the client. This parameter is applicable for `Wired Client` and `Wireless Client` events. This field supports wildcard (`*`) character-based search. Ex `*66 2B*` or `66 2B*` or `*66 2B` Examples `clientMac=66 2B B8 D2 01 56` (single clientMac requested) `clientMac=66 2B B8 D2 01 56&clientMac=DC A6 32 F5 5A 89` (multiple clientMac requested). |
|
DeviceFamily query parameter. Device family. Please note that multiple families across network device type and client type is not allowed. For example, choosing `Routers` along with `Wireless Client` or `Unified AP` is not supported. Examples `deviceFamily=Switches and Hubs` (single deviceFamily requested) `deviceFamily=Switches and Hubs&deviceFamily=Routers` (multiple deviceFamily requested). |
|
EndTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If `endTime` is not provided, API will default to current time. |
|
Additional headers. |
|
Id path parameter. Unique identifier for the event. |
|
Limit query parameter. Maximum number of records to return. |
|
MessageType query parameter. Message type for the event. Examples `messageType=Syslog` (single messageType requested) `messageType=Trap&messageType=Syslog` (multiple messageType requested). |
|
NetworkDeviceId query parameter. The list of Network Device Uuids. (Ex. `6bef213c-19ca-4170-8375-b694e251101c`) Examples `networkDeviceId=6bef213c-19ca-4170-8375-b694e251101c` (single networkDeviceId requested) `networkDeviceId=6bef213c-19ca-4170-8375- b694e251101c&networkDeviceId=32219612-819e-4b5e-a96b-cf22aca13dd9&networkDeviceId=2541e9a7-b80d-4955- 8aa2-79b233318ba0` (multiple networkDeviceId with & separator). |
|
NetworkDeviceName query parameter. Network device name. This parameter is applicable for network device related families. This field supports wildcard (`*`) character-based search. Ex `*Branch*` or `Branch*` or `*Branch` Examples `networkDeviceName=Branch-3-Gateway` (single networkDeviceName requested) `networkDeviceName=Branch-3-Gateway&networkDeviceName=Branch-3-Switch` (multiple networkDeviceName requested). |
|
Offset query parameter. Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1. |
|
Order query parameter. The sort order of the field ascending or descending. |
|
Severity query parameter. Severity of the event between 0 and 6. This is applicable only for events related to network devices (other than AP) and `Wired Client` events. | Value | Severity | | ----- | ----------- | | 0 | Emergency | | 1 | Alert | | 2 | Critical | | 3 | Error | | 4 | Warning | | 5 | Notice | | 6 | Info | Examples `severity=0` (single severity requested) `severity=0&severity=1` (multiple severity requested). |
|
SiteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`) This field supports wildcard asterisk (`*`) character search support. E.g. `*uuid*, *uuid, uuid*` Examples `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteH ierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2 /floorUuid2` (multiple siteHierarchyId requested). |
|
SiteId query parameter. The UUID of the site. (Ex. `flooruuid`) Examples `?siteId=id1` (single siteId requested) `?siteId=id1&siteId=id2&siteId=id3` (multiple siteId requested). |
|
SortBy query parameter. A field within the response to sort by. |
|
StartTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. If `startTime` is not provided, API will default to current time minus 24 hours. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
|
View query parameter. The list of events views. Please refer to `EventViews` for the supported list Examples `view=network` (single view requested) `view=network&view=ap` (multiple view requested). |
Notes
Note
SDK Method used are devices.Devices.get_details_of_a_single_assurance_event, devices.Devices.query_assurance_events,
Paths used are get /dna/data/api/v1/assuranceEvents, get /dna/data/api/v1/assuranceEvents/{id},
Supports
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 GetDetailsOfASingleAssuranceEvent
Complete reference of the GetDetailsOfASingleAssuranceEvent API.
- Cisco Catalyst Center documentation for Devices QueryAssuranceEvents
Complete reference of the QueryAssuranceEvents API.
Examples
---
- name: Get all Assurance Events
cisco.catalystcenter.assurance_events_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}}"
deviceFamily: string
startTime: 0
endTime: 0
messageType: string
severity: 0
siteId: string
siteHierarchyId: string
networkDeviceName: string
networkDeviceId: string
apMac: string
clientMac: string
attribute: string
view: string
offset: 0
limit: 0
sortBy: string
order: string
register: result
- name: Get Assurance Events by id
cisco.catalystcenter.assurance_events_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}}"
attribute: string
view: string
id: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|