Citrix Daas SDK

Get-VusComponents

November 28, 2023

Contributed by:

C C

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

Syntax

Get-VusComponents
   -CatalogUid <Int32>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Get-VusComponents
   -CatalogUuid <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Get-VusComponents
   -CatalogName <String>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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

-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

-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

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

Guid

Outputs

Citrix.VdaUpdateService.Sdk.CatalogComponent

Components and feature Information related to Catalog

about_VusVdaUpdateServiceSnapin

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

November 28, 2023

Contributed by:

C C

November 28, 2023

Contributed by:

C C

Get-VusComponents

Syntax

Description

Examples

EXAMPLE 1

Parameters

-CatalogUid

-CatalogUuid

-CatalogName

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Guid

Outputs

Citrix.VdaUpdateService.Sdk.CatalogComponent

Related Links

In this article