Alarm Reconfigure Alarm
Reconfigures the alarm properties.
This operation requires access privileges on the entity with which the alarm is associated.
In addition to the Alarm.Edit privilege, may also require the Global.ScriptAction if a RunScriptAction action is specified in the AlarmSpec.
Required privileges: Alarm.Edit
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/Alarm/{moId}/ReconfigureAlarm
COPY
Path Parameters
string
moId
Required
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case Alarm/{moId}.
string
release
Required
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
Request Body
ReconfigureAlarmRequestType of type(s) application/json
Required
{
"spec": {
"_typeName": "string",
"name": "string",
"systemName": "string",
"description": "string",
"enabled": false,
"expression": {
"_typeName": "string"
},
"action": {
"_typeName": "string"
},
"actionFrequency": 0,
"setting": {
"_typeName": "string",
"toleranceRange": 0,
"reportingFrequency": 0
}
}
}
Responses
204
No Content
Operation doesn't return any data structure
500
InvalidName: if the alarm name is empty or too long.
DuplicateName: if an alarm with the name already exists.
InvalidArgument: if the specification is invalid.
Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}