alarm.v2.namespaces.alarms.alarms#
Collection Note
This module is part of the nokia.eda_core_v1 collection. To install the collection, use:
Added in version0.3.0. Synopsis#
- Description will be added soon.
Parameters#
| Parameter | Defaults / Choices | Comments |
|---|---|---|
| action str required | Type of action to take for the alarm. | |
| alarm_name str required | The name of the alarm to delete. | |
| alarm_namespace_and_name list required | The names of the alarms to be deleted. | |
| all bool | Requests all alarms; the default is to filter-out suppressed alarms. Value must be "true" to get information about a suppressed alarm. | |
| auth_token str required | HTTP authentication (Bearer authentication) string in the format of "Bearer TOKEN". Required unless state is cronly. | |
| base_url str required | EDA API URL including the schema and port (if non standard for the provided schema). Example - https://try.eda.demo:9443. Required unless state is cronly. | |
| ca_path str required | A path to the PEM-encoded CA certificate to use for TLS verification. Required unless state is cronly. | |
| duration int | The duration (in milliseconds) for the specified acknowledge or suppress action. | |
| fields str | A comma-separated list of alarm fields to fetch/return. If unspecified, all fields are fetched. If an empty list, only the alarm name and namespace will be returned. | |
| filter str | An EDA-query-language "where" expression that will be used to filter the list of alarms fetched. | |
| ns_name str required | The namespace of the alarm to delete. | |
| state str required | Choices: absent, query, present | State of the requested resource object. |
| tls_skip_verify bool required | A flag to control the TLS verification of the session. Required unless state is cronly. |
Authors#
- Roman Dodin (@hellt)