Creating an Alarm Masking Rule

Function

This interface is used to create an alarm masking rule.

Syntax

Operation type: PATCH

URL: https://device_ip/redfish/v1/Systems/Alarm/AlarmShield/Increase

Request header:

X-Auth-Token: auth_value

Request message body:

{
    "AlarmShieldMessages": [
        {
            "UniquelyIdentifies": Identifies,
            "AlarmId": Id,
            "PerceivedSeverity": PerceivedSeverity,
            "AlarmInstance": AlarmInstance
        }
    ]
}

Request Parameters

**Table 1** Request parameters
Parameter	Mandatory/Optional	Description	Value
AlarmShieldMessages	Mandatory	Alarm masking information collection.	The value is an array containing 1 to 256 characters.
UniquelyIdentifies	Mandatory	Unique identifier.	The value is a string of 1 to 32 characters, including uppercase and lowercase letters (a to z and A to Z) and digits (0 to 9).
AlarmId	Mandatory	Alarm ID.	The value is a string of 1 to 32 characters, including uppercase and lowercase letters (a to z and A to Z) and digits (0 to 9).
PerceivedSeverity	Mandatory	Severity.	Character string. The value ranges from 0 to 9.
AlarmInstance	Mandatory	Alarm object.	The value is a string of 1 to 32 characters, including uppercase and lowercase letters (a to z and A to Z), digits (0 to 9), other characters (_.-), and spaces.

Usage Guidelines

None

Example

Request:

PATCH https://10.10.10.10/redfish/v1/Systems/Alarm/AlarmShield/Increase

Request header:

X-Auth-Token: auth_value

Request message body:

{
    "AlarmShieldMessages": [
        {
            "UniquelyIdentifies": "a000000001",
            "AlarmId": "00000001",
            "PerceivedSeverity": "2",
            "AlarmInstance": "M.2"
        }
    ]
}

Response:

{
    "error": {
        "code": "Base.1.0.Success",
        "message": "Operation success. See ExtendedInfo for more information.",
        "@Message.ExtendedInfo": [
            {
                "@odata.type": "#MessageRegistry.v1_0_0.MessageRegistry",
                "Description": "Indicates that no error has occurred.",
                "Message": "Increase alarm shield successfully.",
                "Severity": "OK",
                "NumberOfArgs": null,
                "ParamTypes": null,
                "Resolution": "None"
            }
        ]
    }
}

Response code: 200

Output Description

**Table 2** Operation output description
Field	Type	Description
code	String	A string indicating the specific message ID in the message registry.
message	String	A readable message corresponding to a message in the message registry.
@odata.type	String	OData description of a message resource.
Description	String	Detailed description of a message resource.
Message	String	Detailed information about a message resource.
Severity	String	Severity. OK Warning Critical
NumberOfArgs	Number	Number of parameters in a message description.
ParamTypes	Array	Parameter type list.
Resolution	String	Event handling suggestions.

Parent topic: System Monitoring