Skip to content

Remove-Vuscatalogupgrade

Remove existing catalog upgrade schedule.

Syntax

Remove-VusCatalogUpgrade -CatalogUid <Int32> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-VusCatalogUpgrade -CatalogUuid <String> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Remove-VusCatalogUpgrade -CatalogName <String> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

The Remove-VusCatalogUpgrade cmdlet removes existing catalog schedule. The schedule would be cancelled if it has not moved to UpgradeInProgress state. To cancel schedule which is in UpgradeInProgress state use Force switch which would cancel schedules for VDAs which have not yet started to upgrade.

Parameters

Name Description Required? Pipeline Input Default Value
CatalogUid Uid of the Catalog true false
CatalogUuid Uuid of the Catalog true false
CatalogName Name of the Catalog true false
Force Force removes machines which have not yet started the upgrade. Without force only if the catalog is not in upgrade window is removed. 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.Guid

Return Values

None

Examples

Example 1

C:\PS> Remove-VusCatalogUpgrade -CatalogName "Workstation catalog" -Force

Description

Force cancel upgrades for machine not yet started

Was this article helpful?