Get-VusComponents

Last published : Oct 31, 2026
Introduced in: Citrix Virtual Apps and Desktop 7 2411
Gets list of Components Installed, Components Available for Installation and Available features for a catalog
Related information
about_VusVdaUpdateServiceSnapIn

Syntax

Get-VusComponents
   -CatalogName <String>
   [-Tag <String>]
   [-UpgradeVersion <String>]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-VusComponents
   -CatalogUid <Int32>
   [-Tag <String>]
   [-UpgradeVersion <String>]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-VusComponents
   -CatalogUuid <String>
   [-Tag <String>]
   [-UpgradeVersion <String>]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

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.

Examples

EXAMPLE 1

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

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

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

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

-Tag

Validate selection for a subset of machines based on the provided tag
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True
Introduced in: Citrix Virtual Apps and Desktop 7 2603

-UpgradeVersion

VDA Version of which the components and parameters are to be fetched
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-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

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

Outputs

Citrix.VdaUpdateService.Sdk.CatalogComponent

Components and feature Information related to Catalog