Stop-SCOMMaintenanceSchedule
Stops an active maintenance schedule.
Syntax
Default (Default)
Stop-SCOMMaintenanceSchedule
[-IDs] <Guid[]>
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[<CommonParameters>]
Description
The Stop-SCOMMaintenanceSchedule stops an active maintenance schedule. If the existing schedule is not active, this cmdlet will return an error. This cmdlet will put all resources connected with this schedule out of maintenance mode.
When a resource is in maintenance mode, Operations Manager suppresses alerts, notifications, rules, monitors, automatic responses, state changes, and new alerts. A maintenance schedule can be used to schedule a set of resources to go into maintenance mode.
By default, this cmdlet uses the active persistent connection to a management group.
Use the SCSession parameter to specify a different persistent connection.
You can create a temporary connection to a management group by using the ComputerName and Credential parameters.
For more information, type Get-Help about_OpsMgr_Connections.
Examples
Example 1: Stop any running maintenance schedules
PS C:\>Get-SCOMMaintenanceScheduleList | Where-Object { $_.Status -eq "Running" } | ForEach-Object {
Write-Output "Stopping Maintenance Schedule: $($_.ScheduleName) ($($_.ScheduleId.Guid))"
Stop-SCOMMaintenanceSchedule -IDs $_.ScheduleId
}
Example showing how to stop all running maintenance schedules.
Example 2: Stop specific maintenance schedule
PS C:\>Get-SCOMMaintenanceSchedule | Where-Object { $_.ScheduleName -eq 'Test Maintenance Schedule' } | ForEach-Object {
Write-Host "Stopping Maintenance Schedule: $($_.ScheduleName) ($($_.ScheduleId))";
Stop-SCOMMaintenanceSchedule -IDs $_.ScheduleId
}
Example showing how to stop all maintenance schedules with name Test Maintenance Schedule.
Parameters
-ComputerName
Specifies an array of names of computers. The cmdlet establishes temporary connections with management groups for these computers. You can use NetBIOS names, IP addresses, or fully qualified domain names (FQDNs). To specify the local computer, type the computer name, localhost, or a dot (.).
The System Center Data Access service must be active on the computer. If you do not specify a computer, the cmdlet uses the computer for the current management group connection.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies a PSCredential object for the management group connection.
To obtain a PSCredential object, use the Get-Credential cmdlet.
For more information, type Get-Help Get-Credential.If you specify a computer in the ComputerName parameter, use an account that has access to that computer.
The default is the current user.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IDs
Specifies an array of GUIDs of the schedules that this cmdlet removes.
Parameter properties
| Type: | Guid[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SCSession
Specifies an array of Connection objects.
Parameter properties
| Type: | Connection[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.