HP Operations Manager for Windows

OV_Service::SetOutage()
OV_Service::SetOutage_Trans()


void SetOutage(
[in] sint32 IsInOutage,
[in] boolean IsScheduled,
[in, optional] sint32 DeleteMessageInOutage,
[in, optional] boolean IncludeAllSubordinate)
void SetOutage_Trans(
[in] string TransId,
[in] sint32 IsInOutage,
[in] boolean IsScheduled,
[in, optional] sint32 DeleteMessageInOutage,
[in, optional] boolean IncludeAllSubordinate)

Parameters

TransId
Transaction ID returned from OV_Transaction::Start().
IsInOutage
Changes or sets the service mode (scheduled outage or maintenance). Valid enumeration type values are KEEP, ON, OFF, or TOGGLE. KEEP does not change the service outage mode, ON enables and OFF disables the service outage mode, and TOGGLE changes the service 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 service is set to scheduled outage mode. Otherwise (false), the service is set to unplanned maintenance mode.
DeleteMessageInOutage
Flag that indicates whether node messages should be removed. Valid enumeration type values are KEEP, ON, OFF, or TOGGLE. Default is KEEP. If the parameter has an invalid value, the method fails with MDLAPI_E_INVALID_PARAMETER.
IncludeAllSubordinate
This flag indicates that child services are included. Optional parameter. Default value is false. 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 service.

If the service is hosted on a node group, the scheduled outage and maintenance mode are not set for the service. 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.