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.
Request
URI
POST
https://{api_host}/sdk/vim25/{release}/AlarmManager/{moId}/CreateAlarm
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 AlarmManager/{moId}.
string
release
Required
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
Request Body
CreateAlarmRequestType
of type(s)
application/json
Required
"CreateAlarmRequestType Object"
object
spec
Required
Parameters for alarm creation.
Responses
200
A reference to the Alarm object created by the operation.
Returns
MoRefAlarm
of type(s)
application/json
"MoRefAlarm Object"
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:
InlineVimFault0
"VimFault Object"Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/AlarmManager/{moId}/CreateAlarm
On This Page
Alarm Manager Operations
POST
Alarm Manager Acknowledge Alarm
POST
Alarm Manager Clear Triggered Alarms
POST
Alarm Manager Create Alarm
POST
Alarm Manager Disable Alarm
POST
Alarm Manager Enable Alarm
POST
Alarm Manager Get Alarm
POST
Alarm Manager Are Alarm Actions Enabled
POST
Alarm Manager Get Alarm State
POST
Alarm Manager Enable Alarm Actions
GET
Alarm Manager Get Default Expression
GET
Alarm Manager Get Description