Citrix Virtual Apps and Desktops SDK

Set-BrokerRebootSchedule

Updates the values of one or more desktop group reboot schedules.

Syntax

Set-BrokerRebootSchedule
   [-InputObject] <RebootSchedule[]>
   [-PassThru]
   [-Day <RebootScheduleDays>]
   [-Enabled <Boolean>]
   [-Frequency <RebootScheduleFrequency>]
   [-RebootDuration <Int32>]
   [-StartTime <TimeSpan>]
   [-WarningDuration <Int32>]
   [-WarningMessage <String>]
   [-WarningRepeatInterval <Int32>]
   [-WarningTitle <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-BrokerRebootSchedule
   [-DesktopGroupName] <String>
   [-PassThru]
   [-Day <RebootScheduleDays>]
   [-Enabled <Boolean>]
   [-Frequency <RebootScheduleFrequency>]
   [-RebootDuration <Int32>]
   [-StartTime <TimeSpan>]
   [-WarningDuration <Int32>]
   [-WarningMessage <String>]
   [-WarningRepeatInterval <Int32>]
   [-WarningTitle <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Set-BrokerRebootSchedule cmdlet is used to alter the settings of an existing desktop group reboot schedule.

Examples

EXAMPLE 1

Sets the reboot schedule for the desktop group named Accounting to display a message with the title “WARNING: Reboot pending” and body “Save your work” ten minutes prior to rebooting each machine. The message is displayed in every user session on that machine.

Set-BrokerRebootSchedule -DesktopGroupName Accounting -WarningMessage "Save your work" -WarningDuration 10 -WarningTitle "WARNING: Reboot pending"
<!--NeedCopy-->

EXAMPLE 2

Sets all weekly reboot schedules to run on Friday.

Get-BrokerRebootSchedule -Frequency Weekly | Set-BrokerRebootSchedule -Day Friday
<!--NeedCopy-->

EXAMPLE 3

Sets the reboot schedule for the desktop group having Uid 17 to display the message “Rebooting in %m% minutes.” Fifteen, ten and five minutes prior to rebooting each machine, the message “Rebooting in %m% minutes.” will be displayed in each user session with the pattern ‘%m%’ replaced with the number of minutes until the reboot.

Set-BrokerRebootSchedule -DesktopGroupUid 17 -WarningMessage "Rebooting in %m% minutes." -WarningDuration 15 -WarningRepeatInterval 5
<!--NeedCopy-->

Parameters

-InputObject

The reboot schedule to be modified.

Type: RebootSchedule[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DesktopGroupName

The name of the desktop group whose reboot schedule is to be modified.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-PassThru

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.

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

-Day

For weekly schedules, the day of the week on which the scheduled reboot-cycle starts (one of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday).

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

-Enabled

Boolean that indicates if the reboot schedule is to be enabled or disabled.

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

-Frequency

Frequency with which this schedule runs (either Weekly or Daily).

Type: RebootScheduleFrequency
Accepted values: Daily, Weekly, Monthly, Once
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-RebootDuration

Approximate maximum number of minutes over which the scheduled reboot cycle runs.

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

-StartTime

Time of day at which the scheduled reboot cycle starts (HH:MM).

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

-WarningDuration

Time prior to the initiation of a machine reboot at which warning message is displayed in all user sessions on that machine. If the warning duration is zero then no message is displayed. In some cases the time required to process a reboot schedule may exceed the RebootDuration time by up to the WarningDuration value; Citrix recommends that the WarningDuration is kept small relative to the RebootDuration value.

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

-WarningMessage

Warning message displayed in user sessions on a machine scheduled for reboot. If the message is blank then no message is displayed. The optional pattern ‘%m%’ is replaced by the number of minutes until the reboot.

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

-WarningRepeatInterval

Time to wait after the previous reboot warning before displaying the warning message in all user sessions on that machine again. If the warning repeat interval is zero then the warning message is not displayed after the initial warning.

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

-WarningTitle

The window title used when showing the warning message in user sessions on a machine scheduled for reboot.

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

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Citrix.Broker.Admin.SDK.RebootSchedule

Reboot schedules may be specified through pipeline input.

Outputs

None

By default, this cmdlet returns no output.

Set-BrokerRebootSchedule