Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

New-BrokerCatalogRebootSchedule

August 3, 2023
Contributed by: 
C

Creates a new reboot schedule for a catalog.

Syntax


New-BrokerCatalogRebootSchedule [-Name] <String> -CatalogName <String> -RebootDuration <Int32> [-Description <String>] [-Enabled <Boolean>] [-MaxOvertimeStartMins <Int32>] [-StartDate <String>] [-StartTime <TimeSpan>] [-WarningDuration <Int32>] [-WarningMessage <String>] [-WarningRepeatInterval <Int32>] [-WarningTitle <String>] [-LoggingId <Guid>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

New-BrokerCatalogRebootSchedule [-Name] <String> -CatalogUid <Int32> -RebootDuration <Int32> [-Description <String>] [-Enabled <Boolean>] [-MaxOvertimeStartMins <Int32>] [-StartDate <String>] [-StartTime <TimeSpan>] [-WarningDuration <Int32>] [-WarningMessage <String>] [-WarningRepeatInterval <Int32>] [-WarningTitle <String>] [-LoggingId <Guid>] [-AdminClientIP <String>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

The New-BrokerCatalogRebootSchedule cmdlet is used to define a reboot schedule for a catalog.

Parameters

Name Description Required? Pipeline Input Default Value
Name The name of the new reboot schedule. true true (ByPropertyName)  
CatalogName The name of the catalog that this reboot schedule is applied to. true true (ByPropertyName)  
CatalogUid The Uid of the catalog that this reboot schedule is applied to. true true (ByPropertyName)  
RebootDuration Approximate maximum number of minutes over which the scheduled reboot cycle runs. true true (ByPropertyName)  
Description An optional description for the reboot schedule. false true (ByPropertyName)  
Enabled Boolean that indicates if the new reboot schedule is enabled. false true (ByPropertyName)  
MaxOvertimeStartMins Maximum delay in minutes after which the scheduled reboot will not take place. false true (ByPropertyName) 0
StartDate The date on which the schedule is expected to run, date is in ISO 8601 Format (YYYY-MM-DD). false true (ByPropertyName)  
StartTime Time of day at which the scheduled reboot cycle starts (HH:MM). false true (ByPropertyName)  
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. false true (ByPropertyName)  
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. false true (ByPropertyName)  
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. false true (ByPropertyName)  
WarningTitle The window title used when showing the warning message in user sessions on a machine scheduled for reboot. false true (ByPropertyName)  
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. false false  
AdminClientIP Internal use only. false false  
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. false false Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  

Input Type

None

Input cannot be piped to this cmdlet.

Return Values

Citrix.Broker.Admin.Sdk.Catalogrebootschedule

Examples

Example 1 


C:\PS> New-BrokerCatalogRebootSchedule -Name BankTellers -CatalogName BankTellers  -StartDate "2022-02-03" -StartTime "02:00" -Enabled $true -RebootDuration 120

<!--NeedCopy-->

Description

Schedules the machines in the catalog named ‘BankTellers’ to be rebooted Feb 3, 2021 between 2 AM and 4 AM.

Example 2 


C:\PS> New-BrokerCatalogRebootSchedule -Name 'Update reboot' -CatalogUid 17 -StartDate "2022-02-03" -StartTime "01:00" -Enabled $true -RebootDuration 240 -WarningTitle "WARNING: Reboot pending" -WarningMessage "Save your work" -WarningDuration 10

<!--NeedCopy-->

Description

Schedules the machines in the catalog having Uid 17 to be rebooted between 1 AM and 5 AM at Feb 3, 2021. 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.

New-BrokerCatalogRebootSchedule
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.