OV_NodeGroup::SetOutage()
OV_NodeGroup::SetOutage_Trans()
- void SetOutage(
- [in] sint32 IsInOutage,
- [in] boolean IsScheduled,
- [in, optional] sint32 DeleteMessageInOutage,
- [in, optional] sint32 DisableHeartBeatPolingInOutage,
- [in, optional] sint32 RemovePolicyInMaintenance,
- [in, optional] boolean IncludeAllSubordinate)
- void SetOutage_Trans(
- [in] string TransId,
- [in] sint32 IsInOutage,
- [in] boolean IsScheduled,
- [in, optional] sint32 DeleteMessageInOutage,
- [in, optional] sint32 DisableHeartBeatPolingInOutage,
- [in, optional] sint32 RemovePolicyInMaintenance,
- [in, optional] boolean IncludeAllSubordinate)
Parameters
- TransId
- Transaction ID returned from OV_Transaction::Start().
- IsInOutage
- Changes/sets the node mode (scheduled outage or maintenance).
Valid enumeration type values are KEEP, ON, OFF, or TOGGLE. KEEP
does not change the node outage mode, ON enables and OFF disables
the node outage mode, and TOGGLE changes the node outage mode from
ON to OFF, or from OFF to ON. If this parameter has 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 node is in scheduled outage mode.
Otherwise (false), the node is in unplanned maintenance mode.
- DeleteMessageInOutage
- Flag that indicates if the node messages is removed or not.
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.
- DisableHeartBeatPolingInOutage
- Flag that indicates whether node heart beat polling is
disabled. 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.
- RemovePolicyInMaintenance
- Flag that indicates whether policies are removed from the node.
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.
- IncludeAllSubordinate
- Indicates whether the node to set outage is also searched in
child groups (recursive). Optional parameter. Default value is
false.
Calling Convention
These methods can be called only from a WMI instance object.
Description
Sets scheduled outage/maintenance mode properties of nodes
belonging to this node group.
Also services hosted on these nodes are affected (according to
new node mode). If node subgroups are included, you need to remove
duplicate nodes from the node list. 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.