Add-SCOMSubscriberSchedule

  • Reference
Module:
OperationsManager

Adds a new schedule entry for a notification subscriber.

Syntax

Add-SCOMSubscriberSchedule
   -Subscriber <NotificationRecipient>
   [-Exclude]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [[-DayOfWeek] <NotificationRecipientScheduleEntryDaysOfWeek>]
   [-StartTime] <DateTime>
   [-EndTime] <DateTime>
   [-TimeZone <String>]
   [-PassThru]
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-SCOMSubscriberSchedule
   -Subscriber <NotificationRecipient>
   [-Exclude]
   [-StartDate <DateTime>]
   [-EndDate <DateTime>]
   [[-DayOfWeek] <NotificationRecipientScheduleEntryDaysOfWeek>]
   [-TimeZone <String>]
   [-PassThru]
   [-AllDay]
   [-SCSession <Connection[]>]
   [-ComputerName <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-SCOMSubscriberSchedule cmdlet adds a new schedule entry for a notification subscriber. Notification subscribers are users who receive notifications when System Center - Operations Manager raises an alert on a monitored system.

If you do not add entries to a subscriber's existing schedule, the subscriber continues to receive notifications.

Examples

Example 1: Add a schedule for a notification subscriber

PS C:\>Get-SCOMNotificationSubscriber "Katarina" | Add-SCOMSubscriberSchedule -StartTime "9:00 AM" -EndTime "5:00 PM" -DayOfWeek Monday, Wednesday, Friday

This command adds a schedule window from 9 A.M. to 5 P.M. on Mondays, Wednesdays, and Fridays in all date ranges for a notification subscriber named Katarina. The command uses the Get-SCOMNotificationSubscriber cmdlet to get the specified subscriber and passes that subscriber to the Add-SCOMSubscriberSchedule cmdlet by using the pipeline operator.

Example 2: Add multiple schedule entries for a notification subscriber

PS C:\>Get-SCOMNotificationSubscriber "Cesar" | Add-SCOMSubscriberSchedule -StartTime "7:00 AM" -EndTime "4:00 PM" -DayOfWeek Monday, Wednesday, Friday -TimeZone "*UTC-06:00*" -PassThru | Add-SCOMSubscriberSchedule -StartDate '2012/1/1' -EndDate '2012/1/15' -TimeZone "*UTC-06:00*" -Exclude

This command adds two schedule entries to the notification subscriber named Cesar in the USA Central time zone. The command uses the Get-SCOMNotificationSubscriber cmdlet to get the specified subscriber and passes that subscriber to the Add-SCOMSubscriberSchedule cmdlet by using the pipeline operator. The command adds the entry with the specified values. The command specifies the PassThru parameter in order to pass the user to another instance of the Add-SCOMSubscriberSchedule cmdlet by using the pipeline operator. The command adds a second schedule entry with the specified values.

Parameters

-AllDay

Indicates that the schedule entry applies to the whole day.

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

-ComputerName

Specifies an array of names of computers. The cmdlet establishes temporary connections with management groups for these computers. Valid formats include a NetBIOS name, an IP address, or a fully qualified domain name (FQDN). To specify the local computer, specify 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 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.

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

-DayOfWeek

Specifies the days of the week that the schedule entry is valid. By default, the entry applies to all days of the week.

Type:NotificationRecipientScheduleEntryDaysOfWeek
Position:3
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-EndDate

Specifies the date at which the schedule entry ends. If this command does not specify StartDate and EndDate parameters, the schedule entry applies to all dates.

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

-EndTime

Specifies the time at which the schedule entry ends.

Type:DateTime
Aliases:To, Until
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Exclude

Indicates that the command excludes the specified times and dates from the schedule. If this parameter does not appear, the schedule includes only the specified times.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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:True
Accept wildcard characters:False

-SCSession

Specifies an array of Connection objects. To get Connection objects, specify the Get-SCOMManagementGroupConnection cmdlet.

If this parameter does not appear, 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

-StartDate

Specifies the date at which the schedule entry starts. If this command does not specify StartDate and EndDate parameters, the schedule entry applies to all dates.

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

-StartTime

Specifies the start time for the schedule entry.

Type:DateTime
Aliases:From
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Subscriber

Specifies the notification subscriber. To obtain a notification subscriber object, use the Get-SCOMNotificationSubscriber cmdlet, or create a new object by using the Add-SCOMNotificationSubscriber cmdlet.

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

-TimeZone

Specifies the time zone for the schedule entry. If you specify wildcards as part of the time zone, the cmdlet performs wildcard matching against the display names for time zones. If this parameter does not appear, the cmdlet defaults to the current user time zone.

Examples of valid values for this parameter are:

  • UTC+05:00. United States Eastern time.
  • Pacific Time. United States Pacific time.
  • Amsterdam. Amsterdam, Berlin, Bern, Rome, Stockholm time.
Type:String
Position:Named
Default value:None
Required:False
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