State

Leafs

class System.Alarms.Alarm.State

Bases: Entity

Class Hierarchy: System Alarms Alarm State

This class represents state data.

Operational state data for a device alarm

id

Unique ID for the alarm – this will not be a configurable parameter on many implementations

type: str

config: False

resource

The item that is under alarm within the device. The resource may be a reference to an item which is defined elsewhere in the model. For example, it may be a platform/component, interfaces/interface, terminal-device/logical-channels/channel, etc. In this case the system should match the name of the referenced item exactly. The referenced item could alternatively be the path of the item within the model

type: str

config: False

text

The string used to inform operators about the alarm. This MUST contain enough information for an operator to be able to understand the problem. If this string contains structure, this format should be clearly documented for programs to be able to parse that information

type: str

config: False

time_created

The time at which the alarm was raised by the system. This value is expressed as nanoseconds since the Unix Epoch

type: int

range: 0..18446744073709551615

config: False

severity

The severity level indicating the criticality and impact of the alarm

type: one of the below values: UNKNOWN

config: False

type_id

The abbreviated name of the alarm, for example LOS, EQPT, or OTS. Also referred to in different systems as condition type, alarm identifier, or alarm mnemonic. It is recommended to use the OPENCONFIG_ALARM_TYPE_ID identities where possible and only use the string type when the desired identityref is not yet defined

type: union of the below types:

type: str

type: OPENCONFIGALARMTYPEID

config: False