Remove-SCOMSubscriberSchedule
Remove-SCOMSubscriberSchedule
Removes entries from a notification subscriber schedule.
Syntax
Parameter Set: Default
Remove-SCOMSubscriberSchedule [-Subscriber] <NotificationRecipient> [-Entry] <NotificationRecipientScheduleEntry> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-PassThru] [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-SCOMSubscriberSchedule cmdlet removes entries from a notification subscriber schedule. Notification subscribers are users who receive notifications when System Center 2012 – Operations Manager raises an alert on a monitored system.
Parameters
-ComputerName<String[]>
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 computer must run the System Center Data Access service.
If you do not specify this parameter, the default is the computer for the current management group connection.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the user account under which the management group connection runs. Specify a PSCredential object, such as one that the Get-Credential cmdlet returns, for this parameter. This account must have access to the server that is specified in the ComputerName parameter if that parameter is used. For more information about credential objects, type "Get-Help Get-Credential".
If you do not specify this parameter, the default is the account for the current user.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Entry<NotificationRecipientScheduleEntry>
Specifies the schedule entry that the cmdlet removes.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Indicates that the cmdlet creates or modifies an object that a command can use in the pipeline. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies an array of Connection objects. To get Connection objects, use the Get-SCOMManagementGroupConnection cmdlet.
If this parameter is not specified, the 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".
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Subscriber<NotificationRecipient>
Specifies the notification subscriber for whom the cmdlet removes schedule entries.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Remove a schedule entry from a subscriber
This example removes the last schedule entry from a subscriber.
The first command gets the notification subscriber object named Katarina and stores the object in the $Subscriber variable.
The second command selects the last schedule entry for the subscriber that is stored in the $Subscriber variable. For more information, type "Get-Help Select-Object". The command passes the subscriber object to the Remove-SCOMSubscriberSchedule cmdlet by using the pipeline operator.
PS C:\> $Subscriber = Get-SCOMNotificationSubscriber "Katarina"
PS C:\> $Subscriber.ScheduleEntries | Select-Object -Last 1 | Remove-ScomSubscriberSchedule -Subscriber $Subscriber