Skip to content

Get-Vuscataloginfo

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>]

Get-VusCatalogInfo -CatalogUuid <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Get-VusCatalogInfo -CatalogName <String> [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Get-VusCatalogInfo [-All] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

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

System.Guid

Return Values

Citrix.Vdaupdateservice.Sdk.Cataloginfo

Upgrade info related to the catalog

Examples

Example 1

C:\PS> Get-VusCatalogInfo

Description

Return the list of catalogs and their upgrade details.

Example 2

C:\PS> Get-VusCatalogInfo -CatalogUid 1

Description

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

Was this article helpful?