Citrix Virtual Apps and Desktops SDK

Set-VusCatalogUpgradeType

Introduced in: Citrix Virtual Apps and Desktop 7 2411

Set upgrade type LTSR/CR/EAR_CR/EAR_LTSR for a catalog.

Syntax

Set-VusCatalogUpgradeType
   -CatalogName <String>
   -UpgradeType <UpgradeType>
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [-WhatIf]
   [-Confirm]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-VusCatalogUpgradeType
   -CatalogUid <Int32>
   -UpgradeType <UpgradeType>
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [-WhatIf]
   [-Confirm]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-VusCatalogUpgradeType
   -CatalogUuid <String>
   -UpgradeType <UpgradeType>
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [-WhatIf]
   [-Confirm]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Set-VusCatalogUpgradeType cmdlet sets the upgrade type for a catalog.

All machines/VDAs inherit the property from the catalog.

Examples

EXAMPLE 1

Set upgrade type for provided catalog to LTSR.

Set-VusCatalogUpgradeType -CatalogName "Workstation catalog" -UpgradeType LTSR
<!--NeedCopy-->

Parameters

-CatalogUid

UID of the catalog provided by broker service

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

-UpgradeType

Upgrade type for a catalog

Type: UpgradeType
Accepted values: NotSet, LTSR, CR, EAR_LTSR, EAR_CR
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-CatalogUuid

UUID of the catalog provided by broker service

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

-CatalogName

Name of the catalog provided by broker service

Type: String
Position: Named
Default value: None
Required: True
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

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

-WhatIf

Displays the confirmation message displayed for selected Upgrade type

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Confirms that user understands Early access release builds are available for customers to test in their non-production or limited production environments, and share feedback. It is advised not to deploy early access release builds in production environments.

Type: SwitchParameter
Aliases: cf
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

Citrix.VdaUpdateService.Sdk.UpgradeType

Upgrade Type i.e, LTSR/CR/EAR_CR/EAR_LTSR

Outputs

None

By default, this cmdlet returns no output.

Set-VusCatalogUpgradeType