New-BrokerRebootSchedule

https://docs.citrix.com/en-us/xenapp-and-xendesktop/7-5/cds-sdk-wrapper-rho/cds-sdk-cmdlet-help/citrix-broker-admin-v2-wrapper-xd75/new-brokerrebootschedule-xd75.html

Apr 15, 2014

Creates a new reboot schedule for a desktop group.

Syntax

New-BrokerRebootSchedule [-DesktopGroupName] -RebootDuration [-Day ] [-Enabled ] [-Frequency ] [-StartTime ] [-WarningDuration ] [-WarningMessage ] [-WarningTitle ] [-LoggingId ] [-AdminAddress ] []

New-BrokerRebootSchedule -DesktopGroupUid -RebootDuration [-Day ] [-Enabled ] [-Frequency ] [-StartTime ] [-WarningDuration ] [-WarningMessage ] [-WarningTitle ] [-LoggingId ] [-AdminAddress ] []

Detailed Description

The New-BrokerRebootSchedule cmdlet is used to define a reboot schedule for a desktop group.

Related topics

Get-BrokerRebootSchedule

Set-BrokerRebootSchedule

Remove-BrokerRebootSchedule

Start-BrokerRebootCycle

Parameters

-DesktopGroupName

The name of the desktop group that this reboot schedule is applied to.

-RebootDuration

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

-DesktopGroupUid

The Uid of the desktop group that this reboot schedule is applied to.

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

-Enabled

Boolean that indicates if the new reboot schedule is enabled.

-Frequency

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

-StartTime

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

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

-WarningMessage

Warning message displayed in user sessions on a machine scheduled for reboot. If the message is blank then no message is displayed.

-WarningTitle

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

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

-AdminAddress

Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.

Input Type

None Input cannot be piped to this cmdlet.

Return Values

Citrix.Broker.Admin.SDK.RebootSchedule

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> New-BrokerRebootSchedule -DesktopGroupName BankTellers -Frequency Daily -StartTime "02:00" -Enabled $true -Duration 120

Schedules the machines in the desktop group named 'BankTellers' to be rebooted every night between 2 AM and 4 AM.

-------------------------- EXAMPLE 2 --------------------------

C:\PS> New-BrokerRebootSchedule -DesktopGroupUid 17 -Frequency Weekly -Day Saturday -StartTime "01:00" -Enabled $true -Duration 240 -WarningTitle "WARNING: Reboot pending" -WarningMessage "Save your work" -WarningDuration 10

Schedules the machines in the desktop group having Uid 17 to be rebooted every Saturday night between 1 AM and 5 AM. Ten minutes prior to rebooting, each machine will display a message box with the title "WARNING: Reboot pending" and message "Save your work" in every user session.