OV_ExternalNode::SetOutage()
OV_ExternalNode::SetOutage_Trans()
- void SetOutage(
- [in] sint32 IsInOutage,
- [in] boolean IsScheduled,
- [in, optional] sint32 DeleteMessageInOutage)
- void SetOutage_Trans(
- [in] string TransId,
- [in] sint32 IsInOutage,
- [in] boolean IsScheduled,
- [in, optional] sint32 DeleteMessageInOutage)
Parameters
- TransId
- Transaction ID returned from OV_Transaction::Start().
- IsInOutage
- Changes/sets external node mode (scheduled outage or
maintenance). Valid enumeration type values are KEEP, ON, OFF, or
TOGGLE. KEEP does not change the outage mode, ON enables and OFF
disables the outage mode, and TOGGLE changes the outage mode from
ON to OFF, or from OFF to ON. If this parameter has an invalid
value, the method fails with MDLAPI_E_INVALID_PARAMETER.
- IsScheduled
- Flag for scheduled outage or maintenance mode. If this
parameter is set to true, the external node is in scheduled outage
mode. Otherwise (false), it is in unplanned maintenance mode.
- DeleteMessageInOutage
- Flag that indicates whether the node message is removed. Valid
enumeration type values are KEEP, ON, OFF, or TOGGLE. Default is
KEEP. If this parameter has an invalid value, the method fails with
MDLAPI_E_INVALID_PARAMETER.
Calling Convention
These methods can be called only from a WMI instance object.
Description
Sets scheduled outage/maintenance mode properties of this
external node.
Only administrators and operators with special rights can
execute this method. Otherwise, the method fails with
MDLAPI_E_NO_OPERATION_RIGHTS
Return Value
None.
Extended Status Codes
- MDLAPI_E_INVALID_PARAMETER
- Parameter is not valid.
- MDLAPI_E_NO_OPERATION_RIGHTS
- User has no rights to execute this operation.
- MDLAPI_E_TRANSACTION_NOT_EXIST
- Transaction with the specified ID does not exist.