Skip to content

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>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

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

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

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 which have not yet picked up the upgrade would be impacted i.e VDAs which have started to upgrade cannot be rescheduled.

Parameters

Name Description Required? Pipeline Input Default Value
CatalogUid Uid of the Catalog as provided by broker service true false
CatalogUuid Uuid of the Catalog as provided by broker service true false
CatalogName Name of the Catalog as provided by broker service true false
ScheduledTimeInUtc Scheduled time in UTC for catalog schedule false false
DurationInHours Hours available to upgrade 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
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

System.Datetime

Return Values

Citrix.Vdaupdateservice.Sdk.Catalogupgrade

The Upgrade information for catalog schedule being updated

Examples

Example 1

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

Description

Sets 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))

Description

Sets upgrade time for provided catalog

Was this article helpful?