| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
defaultExpression* P | AlarmExpression[] |
|
description P | AlarmDescription |
|
Methods
Methods defined in this Managed Object |
---|
AcknowledgeAlarm, AreAlarmActionsEnabled, ClearTriggeredAlarms, CreateAlarm, DisableAlarm, EnableAlarm, EnableAlarmActions, GetAlarm, GetAlarmState |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
alarm P | ManagedObjectReference
to a Alarm |
Since vSphere API 4.0 |
entity P | ManagedObjectReference
to a ManagedEntity |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
entity P | ManagedObjectReference
to a ManagedEntity |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
xsd:boolean |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
filter P | AlarmFilterSpec |
Since vSphere API 6.7 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
entity P | ManagedObjectReference
to a ManagedEntity |
Since null |
spec P | AlarmSpec |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Alarm |
Faults
Type | Description |
---|---|
DuplicateName | |
InvalidName | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
alarm P | ManagedObjectReference
to a Alarm |
Since vSphere API 6.9.1 |
entity P | ManagedObjectReference
to a ManagedEntity |
Since vSphere API 6.9.1 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
alarm P | ManagedObjectReference
to a Alarm |
Since vSphere API 6.9.1 |
entity P | ManagedObjectReference
to a ManagedEntity |
Since vSphere API 6.9.1 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
entity P | ManagedObjectReference
to a ManagedEntity |
Since vSphere API 4.0 |
enabled P | xsd:boolean |
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
entity* P | ManagedObjectReference
to a ManagedEntity |
Since null |
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a Alarm[] |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
entity P | ManagedObjectReference
to a ManagedEntity |
Since null |
Return Value
Type | Description |
---|---|
AlarmState[] |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |