Add-SCOMSubscriberSchedule

Add-SCOMSubscriberSchedule

Adds a new schedule entry for a notification subscriber.

Syntax

Parameter Set: AllDay
Add-SCOMSubscriberSchedule [[-DayOfWeek] <NotificationRecipientScheduleEntryDaysOfWeek> ] -AllDay -Subscriber <NotificationRecipient> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-EndDate <DateTime> ] [-Exclude] [-PassThru] [-SCSession <Connection[]> ] [-StartDate <DateTime> ] [-TimeZone <String> ] [ <CommonParameters>]

Parameter Set: StartAndEnd
Add-SCOMSubscriberSchedule [-StartTime] <DateTime> [-EndTime] <DateTime> [[-DayOfWeek] <NotificationRecipientScheduleEntryDaysOfWeek> ] -Subscriber <NotificationRecipient> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-EndDate <DateTime> ] [-Exclude] [-PassThru] [-SCSession <Connection[]> ] [-StartDate <DateTime> ] [-TimeZone <String> ] [ <CommonParameters>]

Detailed Description

The Add-SCOMSubscriberSchedule cmdlet adds a new schedule entry for a notification subscriber. Notification subscribers are users who receive notifications when System Center 2012 – 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.

Parameters

-AllDay

Indicates that the schedule entry applies to the whole day.

-ComputerName<String[]>

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.

-Credential<PSCredential>

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.

-DayOfWeek<NotificationRecipientScheduleEntryDaysOfWeek>

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

-EndDate<DateTime>

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.

-EndTime<DateTime>

Specifies the time at which the schedule entry ends.

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

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

-SCSession<Connection[]>

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

-StartDate<DateTime>

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.

-StartTime<DateTime>

Specifies the start time for the schedule entry.

-Subscriber<NotificationRecipient>

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.

-TimeZone<String>

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.

<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: Add a schedule for a notification subscriber

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.

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

Example 2: Add multiple schedule entries for a notification subscriber

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.

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

Related topics

Add-SCOMNotificationSubscriber

Clear-SCOMSubscriberSchedule

Get-SCOMManagementGroupConnection

Get-SCOMNotificationSubscriber

Remove-SCOMSubscriberSchedule