Remove-Vuscatalogupgrade¶
Removes existing catalog upgrade schedule
Syntax¶
Remove-VusCatalogUpgrade -CatalogUid <Int32> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Remove-VusCatalogUpgrade -CatalogUuid <String> [-Force] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>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 the existing catalog schedule. The schedule is cancelled if it has not moved to the UpgradeInProgress state. To cancel a schedule in UpgradeInProgress state, use the Force switch, which cancels schedules for VDAs that have not yet started to upgrade.
Related Commands¶
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 | Removes machines that have not yet started the upgrade. Without Force, catalog is removed only if not in upgrade window. | 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.