Citrix Daas SDK

Remove-VusCatalogUpgrade

November 28, 2023

Contributed by:

C C

Removes existing catalog upgrade schedule

Syntax

Remove-VusCatalogUpgrade
      -CatalogUid <Int32>
      [-Force]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-VusCatalogUpgrade
      -CatalogUuid <String>
      [-Force]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Remove-VusCatalogUpgrade
      -CatalogName <String>
      [-Force]
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

Force cancel upgrades for machine not yet started.

Remove-VusCatalogUpgrade -CatalogName "Workstation catalog" -Force
<!--NeedCopy-->

Parameters

-CatalogUid

UID of the catalog

Type:	Int32
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-CatalogUuid

UUID of the catalog

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-CatalogName

Name of the catalog

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Removes machines that have not yet started the upgrade. Without Force, catalog is removed only if not in upgrade window.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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.

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Guid

Outputs

None

By default, this cmdlet returns no output.

about_VusVdaUpdateServiceSnapin

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Remove-VusCatalogUpgrade

November 28, 2023

Contributed by:

C C

November 28, 2023

Contributed by:

C C

Remove-VusCatalogUpgrade

Syntax

Description

Examples

EXAMPLE 1

Parameters

-CatalogUid

-CatalogUuid

-CatalogName

-Force

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Guid

Outputs

None

Related Links

In this article