Citrix Daas SDK

Set-VusCatalogUpgrade

Sets upgrade schedule time and duration for existing catalog schedule

Syntax

Set-VusCatalogUpgrade -CatalogUid <Int32> [-ScheduledTimeInUtc <DateTime>] [-DurationInHours <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Set-VusCatalogUpgrade -CatalogUid <Int32> [-UpgradeNow] [-DurationInHours <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Set-VusCatalogUpgrade -CatalogUuid <String> [-UpgradeNow] [-DurationInHours <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Set-VusCatalogUpgrade -CatalogUuid <String> [-ScheduledTimeInUtc <DateTime>] [-DurationInHours <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Set-VusCatalogUpgrade -CatalogName <String> [-ScheduledTimeInUtc <DateTime>] [-DurationInHours <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Set-VusCatalogUpgrade -CatalogName <String> [-UpgradeNow] [-DurationInHours <Int32>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

The Set-VusCatalogUpgrade cmdlet allows admin to set the schedule time and/or duration for existing catalog schedule.

In case the schedule is already in UpgradeInProgress state, only the VDAs that have not yet picked up the upgrade are affected. VDAs that have started to upgrade cannot be rescheduled.

Parameters

Name Description Required? Pipeline Input Default Value
CatalogUid UID of the catalog provided by broker service true false  
CatalogUuid UUID of the catalog provided by broker service true false  
CatalogName Name of the catalog provided by broker service true false  
ScheduledTimeInUtc Scheduled time in UTC for catalog schedule false false  
DurationInHours Hours available to upgrade false false  
UpgradeNow Switch to start upgrade at current time in UTC false 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  
AdminClientIP Specifies the Client IP of 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

SystemDatetime

Return Values

Citrix.Vdaupdateservice.SdkCatalogupgrade

The upgrade information for catalog schedule being updated

Examples

Example 1

C:\PS> Set-VusCatalogUpgrade -CatalogName "Workstation catalog" -DurationInHours 4
<!--NeedCopy-->

Description

Set upgrade time for provided catalog.

Example 2

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

Description

Set upgrade time for provided catalog.

Example 3

C:\PS> Set-VusCatalogUpgrade -CatalogName "Workstation catalog" -UpgradeNow
<!--NeedCopy-->

Description

Change the schedule for provided catalog to start at right now.

Set-VusCatalogUpgrade