New-BrokerRebootSchedule
Apr 15, 2014
Creates a new reboot schedule for a desktop group.
Syntax
New-BrokerRebootSchedule [-DesktopGroupName] <String> -RebootDuration <Int32> [-Day <RebootScheduleDays>] [-Enabled <Boolean>] [-Frequency <RebootScheduleFrequency>] [-StartTime <TimeSpan>] [-WarningDuration <Int32>] [-WarningMessage <String>] [-WarningTitle <String>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]
New-BrokerRebootSchedule -DesktopGroupUid <Int32> -RebootDuration <Int32> [-Day <RebootScheduleDays>] [-Enabled <Boolean>] [-Frequency <RebootScheduleFrequency>] [-StartTime <TimeSpan>] [-WarningDuration <Int32>] [-WarningMessage <String>] [-WarningTitle <String>] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description
The New-BrokerRebootSchedule cmdlet is used to define a reboot schedule for a desktop group.
Related topics
Parameters
-DesktopGroupName<String>
The name of the desktop group that this reboot schedule is applied to.
| Required? | true |
| Default Value | |
| Accept Pipeline Input? | true (ByPropertyName) |
-RebootDuration<Int32>
Approximate maximum number of minutes over which the scheduled reboot cycle runs.
| Required? | true |
| Default Value | |
| Accept Pipeline Input? | true (ByPropertyName) |
-DesktopGroupUid<Int32>
The Uid of the desktop group that this reboot schedule is applied to.
| Required? | true |
| Default Value | |
| Accept Pipeline Input? | true (ByPropertyName) |
-Day<RebootScheduleDays>
For weekly schedules, the day of the week on which the scheduled reboot-cycle starts (one of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday).
| Required? | false |
| Default Value | |
| Accept Pipeline Input? | true (ByPropertyName) |
-Enabled<Boolean>
Boolean that indicates if the new reboot schedule is enabled.
| Required? | false |
| Default Value | |
| Accept Pipeline Input? | true (ByPropertyName) |
-Frequency<RebootScheduleFrequency>
Frequency with which this schedule runs (either Weekly or Daily).
| Required? | false |
| Default Value | |
| Accept Pipeline Input? | true (ByPropertyName) |
-StartTime<TimeSpan>
Time of day at which the scheduled reboot cycle starts (HH:MM).
| Required? | false |
| Default Value | |
| Accept Pipeline Input? | true (ByPropertyName) |
-WarningDuration<Int32>
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.
| Required? | false |
| Default Value | |
| Accept Pipeline Input? | true (ByPropertyName) |
-WarningMessage<String>
Warning message displayed in user sessions on a machine scheduled for reboot. If the message is blank then no message is displayed.
| Required? | false |
| Default Value | |
| Accept Pipeline Input? | true (ByPropertyName) |
-WarningTitle<String>
The window title used when showing the warning message in user sessions on a machine scheduled for reboot.
| Required? | false |
| Default Value | |
| Accept Pipeline Input? | true (ByPropertyName) |
-LoggingId<Guid>
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.
| Required? | false |
| Default Value | |
| Accept Pipeline Input? | false |
-AdminAddress<String>
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.
| Required? | false |
| Default Value | Localhost. Once a value is provided by any cmdlet, this value will become the default. |
| Accept Pipeline Input? | false |
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.