Remove-SCOMSubscriberSchedule

  • Reference
Module:
OperationsManager

Removes entries from a notification subscriber schedule.

Syntax

Remove-SCOMSubscriberSchedule
      [-Subscriber] <NotificationRecipient>
      [-Entry] <NotificationRecipientScheduleEntry>
      [-PassThru]
      [-SCSession <Connection[]>]
      [-ComputerName <String[]>]
      [-Credential <PSCredential>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-SCOMSubscriberSchedule cmdlet removes entries from a notification subscriber schedule. Notification subscribers are users who receive notifications when System Center - Operations Manager raises an alert on a monitored system.

Examples

Example 1: Remove a schedule entry from a subscriber

PS C:\>$Subscriber = Get-SCOMNotificationSubscriber "Katarina"
PS C:\> $Subscriber.ScheduleEntries | Select-Object -Last 1 | Remove-ScomSubscriberSchedule -Subscriber $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.

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 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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

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.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Entry

Specifies the schedule entry that the cmdlet removes.

Type:NotificationRecipientScheduleEntry
Position:2
Default value:None
Required:True
Accept pipeline input:True
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SCSession

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".

Type:Connection[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Subscriber

Specifies the notification subscriber for whom the cmdlet removes schedule entries.

Type:NotificationRecipient
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False