Skip to content


Creates a new Upgrade Schedule for a catalog.


New-VusCatalogSchedule -CatalogUid <Int32> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

New-VusCatalogSchedule -CatalogUuid <String> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

New-VusCatalogSchedule -CatalogName <String> -ScheduledTimeInUtc <DateTime> -DurationInHours <Int32> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The New-VusCatalogSchedule cmdlet creates a new upgrade schedule for all machines in catalog.

The service internally gets a list of VDAs which are part of this catalog and schedules an upgrade for each machine. Any machine newly added to catalog after the expansion would not be scheduled.


Name Description Required? Pipeline Input Default Value
CatalogUid Uid of the Catalog true false
ScheduledTimeInUtc Scheduled time in UTC for catalog schedule true false
DurationInHours Hours available to upgrade true false
CatalogUuid Uuid of the Catalog true false
CatalogName Name of the Catalog true false
LoggingId Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and 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
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
AdminAddress Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type


Return Values


The Upgrade information for catalog schedule being updated


Example 1

C:\PS> New-VusCatalogSchedule -CatalogName "Workstation catalog" -ScheduledTimeInUtc ([System.DateTime]::ParseExact("10/23/2021 07:00 PM", 'MM/dd/yyyy hh:mm tt', $null)) -DurationInHours 4


Schedules Upgrade for a catalog on specified date for specified hours

Was this article helpful?