StorageAlarm

StorageAlarm
StorageAlarm

This data object represents the storage alarm.

This structure may be used only with operations rendered under /sms.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "alarmId": 0,
    "alarmType": "string",
    "containerId": "string",
    "objectId": "string",
    "objectType": "string",
    "status": "string",
    "alarmTimeStamp": "string",
    "messageId": "string",
    "parameterList": [
        {
            "_typeName": "string",
            "parameterName": "string",
            "parameterValue": "string"
        }
    ],
    "alarmObject": {
        "_typeName": "string"
    }
}
integer As int64 As int64
alarmId
Required

Monotonically increasing sequence number which VP will maintain.

string
alarmType
Required

The type of Alarm.

Must be one of the string values from AlarmTypeEnum Note that for VMODL VP implemenation this field must be populated with one of the values from vasa.data.notification.AlarmType

string
containerId
Optional

Container identifier

string
objectId
Optional

The unique identifier of the object impacted by the Alarm.

From VASA version 3 onwards, a non-null alarmObject will override this member. This field is made optional from VASA3. Either this or alarmObject must be set.

string
objectType
Required

The type of object impacted by the Alarm.

Must be one of the string values from SmsEntityTypeEnum Note that for VMODL VP implemenation this field must be populated with one of the values from vasa.data.notification.EntityType

string
status
Required

Current status of the object.

Must be one of the string values from SmsAlarmStatusEnum

string As date-time As date-time
alarmTimeStamp
Required

Time-stamp when the alarm occurred in VP context

string
messageId
Required

Pre-defined message for system-defined event

parameterList
Optional

List of parameters (name/value) to be passed as input for message

alarmObject
Optional

The base of all data types. Not to be used directly on the wire.