PartialMonitoringObject.ScheduleMaintenanceMode Method (DateTime, DateTime, MaintenanceModeReason, String, TraversalDepth)
[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]
Schedules maintenance mode for this object.
Namespace: Microsoft.EnterpriseManagement.Monitoring
Assembly: Microsoft.EnterpriseManagement.OperationsManager (in Microsoft.EnterpriseManagement.OperationsManager.dll)
Usage
'Usage
Dim instance As PartialMonitoringObject
Dim startTime As DateTime
Dim scheduledEndTime As DateTime
Dim reason As MaintenanceModeReason
Dim comments As String
Dim traversalDepth As TraversalDepth
instance.ScheduleMaintenanceMode(startTime, scheduledEndTime, reason, comments, traversalDepth)
Syntax
'Declaration
Public Sub ScheduleMaintenanceMode ( _
startTime As DateTime, _
scheduledEndTime As DateTime, _
reason As MaintenanceModeReason, _
comments As String, _
traversalDepth As TraversalDepth _
)
public void ScheduleMaintenanceMode (
DateTime startTime,
DateTime scheduledEndTime,
MaintenanceModeReason reason,
string comments,
TraversalDepth traversalDepth
)
public:
void ScheduleMaintenanceMode (
DateTime startTime,
DateTime scheduledEndTime,
MaintenanceModeReason reason,
String^ comments,
TraversalDepth traversalDepth
)
public void ScheduleMaintenanceMode (
DateTime startTime,
DateTime scheduledEndTime,
MaintenanceModeReason reason,
String comments,
TraversalDepth traversalDepth
)
public function ScheduleMaintenanceMode (
startTime : DateTime,
scheduledEndTime : DateTime,
reason : MaintenanceModeReason,
comments : String,
traversalDepth : TraversalDepth
)
Parameters
- startTime
The time, in DateTime, to start maintenance mode
- scheduledEndTime
The scheduled time, inDateTime format, to end maintenance mode.
- reason
The reason to start maintenance mode.
- comments
Comments about starting maintenance mode.
- traversalDepth
A value that specifies the scope of the returned results. A value of OneLevel includes only instances of the specified class in the scope of the returned results. A value of Recursive includes instances of the specified class and all instances that are contained by those instances.
Remarks
When a monitoring object is in maintenance mode, the following features are temporarily suspended.
Rules and monitors
Notifications
Diagnostics and recoveries
State changes
New alerts
When maintenance mode starts or stops, by reaching the startTime or scheduledEndTime time, the MaintenanceModeLastModified property is reset
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms
Development Platforms
Windows Vista, Windows Server 2003, and
Target Platforms
See Also
Reference
PartialMonitoringObject Class
PartialMonitoringObject Members
Microsoft.EnterpriseManagement.Monitoring Namespace
UpdateMaintenanceMode