Citrix Daas SDK

Get-VusCatalogInfo

August 18, 2023

Contributed by:

Gets catalog-related information specific to VDA Upgrade Service

Syntax

Get-VusCatalogInfo -CatalogUid <Int32> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Get-VusCatalogInfo -CatalogUuid <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Get-VusCatalogInfo -CatalogName <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br /><br />Get-VusCatalogInfo [-All] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Retrieves catalogs matching specified criteria. If no parameters are specified, this cmdlet returns all catalogs.

The Get-VusCatalogInfo cmdlet returns the catalog-related information such as UpgradeType, UpgradeState as well as details about in-progress upgrades.

For any catalog that has more than one upgrade performed in the past, the cmdlet returns the data related to the most recently scheduled upgrade.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
CatalogUid	UID of the catalog provided by broker service	true	false
CatalogUuid	UUID of the catalog provided by broker service	true	false
CatalogName	Name of the catalog provided by broker service	true	false
All	Retrieves all catalog records	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

SystemGuid

Return Values

Citrix.VdaupdateserviceSdkCataloginfo

Upgrade info related to the catalog

Examples

Example 1

C:\PS> Get-VusCatalogInfo
<!--NeedCopy-->

Description

Return the list of catalogs and their upgrade details.

Example 2

C:\PS> Get-VusCatalogInfo -CatalogUid 1
<!--NeedCopy-->

Description

Return the upgrade information for the catalog that has the catalog UID 1.

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

Get-VusCatalogInfo

August 18, 2023

Contributed by:

August 18, 2023

Contributed by:

Get-VusCatalogInfo

Syntax

Detailed Description

Related Commands

Parameters

Input Type

SystemGuid

Return Values

Citrix.VdaupdateserviceSdkCataloginfo

Examples

Example 1

Description

Example 2

Description

In this article