New-BrokerCatalogRebootSchedule
Introduced in: Citrix Virtual Apps and Desktop 7 2209
Creates a new reboot schedule for a catalog.
Syntax
New-BrokerCatalogRebootSchedule
-CatalogUid <Int32>
[-Description <String>]
[-Enabled <Boolean>]
[-MaxOvertimeStartMins <Int32>]
[-Name] <String>
-RebootDuration <Int32>
[-StartDate <String>]
[-StartTime <TimeSpan>]
[-WarningDuration <Int32>]
[-WarningMessage <String>]
[-WarningRepeatInterval <Int32>]
[-WarningTitle <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
New-BrokerCatalogRebootSchedule
-CatalogName <String>
[-Description <String>]
[-Enabled <Boolean>]
[-MaxOvertimeStartMins <Int32>]
[-Name] <String>
-RebootDuration <Int32>
[-StartDate <String>]
[-StartTime <TimeSpan>]
[-WarningDuration <Int32>]
[-WarningMessage <String>]
[-WarningRepeatInterval <Int32>]
[-WarningTitle <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The New-BrokerCatalogRebootSchedule cmdlet is used to define a reboot schedule for a catalog.
Examples
EXAMPLE 1
Schedules the machines in the catalog named 'BankTellers' to be rebooted Feb 3, 2021 between 2 AM and 4 AM.
New-BrokerCatalogRebootSchedule -Name BankTellers -CatalogName BankTellers -StartDate "2022-02-03" -StartTime "02:00" -Enabled $true -RebootDuration 120
EXAMPLE 2
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 -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
Parameters
-Name
The name of the new reboot schedule.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
| Length range: | 1 to 64 |
| Disallowed characters: | /;:#.*?=<>\|[]()"'` and all ASCII control characters |
-CatalogName
The name of the catalog that this reboot schedule is applied to.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-CatalogUid
The Uid of the catalog that this reboot schedule is applied to.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| 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: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-Description
An optional description for the reboot schedule.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
| Disallowed characters: | All ASCII control characters |
-Enabled
Boolean that indicates if the new reboot schedule is enabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-MaxOvertimeStartMins
Maximum delay in minutes after which the scheduled reboot will not take place.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-StartDate
The date on which the schedule is expected to run, date is in ISO 8601 Format (YYYY-MM-DD).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-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: | True (ByPropertyName) |
| 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: | True (ByPropertyName) |
| 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: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-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: | True (ByPropertyName) |
| 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: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-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
None
Input cannot be piped to this cmdlet.