ClearAlarmsCreate

Task resource for clear alarms operation. Skippable properties: These are properties not required to create the clearAlarms object: state, clearedAlarm, alarmClearedTime

Properties

array of Alarm

alarmPattern Required

Alarm patterns to match target alarms. An alarm will match if an attribute in any of the patterns is equal to the corresponding attribute of the alarm. The attributes which are supported with matching are - id, alarmType, alarmedObjectType, perceivedSeverity, plannedOutageIndicator and state.

string

clearSystemId Required

Name of the clearing system

string as date-time

alarmClearedTime Optional

Time of the alarm clearing

string

clearUserId Optional

Name of the clearing user

array of AlarmRefOrValue

clearedAlarm Optional

The successfully cleared alarms

string

state Optional

Current state of the operation task

JSON Example

Show optional properties

{
    "alarmPattern": [
        {
            "alarmedObjectType": "Container",
            "state": "ACTIVE"
        },
        {
            "id": "Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"
        }
    ],
    "clearSystemId": "postman-api"
}

{
    "alarmPattern": [
        {
            "alarmedObjectType": "Container",
            "state": "ACTIVE"
        },
        {
            "id": "Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"
        }
    ],
    "clearSystemId": "postman-api",
    "clearUserId": "admin"
}

[{"label":"Latest (2.0.1)","version":"latest"}]

telco-cloud-service-assurance

Parameter To

Create Clear Alarms

ClearAlarmsCreate

Properties

JSON Example

Parameter To

Was this page helpful?