Alarm Manager Create Alarm
Creates an alarm.
In addition to the Alarm.Create privilege, may also require the Global.ScriptAction if a RunScriptAction action is specified in the AlarmSpec.
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 AlarmManager/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"entity": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"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
}
}
}
A reference to the Alarm object created by the operation.
{
"_typeName": "string",
"type": "string",
"value": "string"
}
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.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}