Skip to content

Get-Vuscomponents

Gets list of Components Installed, Components Available for Installation and Available features for a catalog

Syntax

Get-VusComponents -CatalogUid <Int32> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Get-VusComponents -CatalogUuid <String> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]<br><br>Get-VusComponents -CatalogName <String> [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

For a given catalog, this cmdlet retrieves a list of Components Installed, Components that are available for installation and features that can be enabled on VDAs of a catalog,. Retrieves the information matching the specified catalogName/CatalogUid/CatalogUuid. If no paramaters are specified, then no response is returned.

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

Citrix.Vdaupdateservice.Sdk.Catalogcomponent

Components and feature Information related to Catalog

Examples

Example 1

C:\PS> Get-VusComponents -CatalogUid 1

Description

Returns the component related information: InstalledComponents, AvailableComponents and AvailableFeatures for Catalog with Uid 1.

Was this article helpful?