Citrix Virtual Apps and Desktops SDK

Get-VusMachineComponents

Introduced in: Citrix Virtual Apps and Desktop 7 2411

Gets list of Components Installed, Components Available for Installation and Available features for Machine(s)

Syntax

Get-VusMachineComponents
   -MachineName <String[]>
   [-UpgradeVersion <String>]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-VusMachineComponents
   -MachineUid <Int32[]>
   [-UpgradeVersion <String>]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-VusMachineComponents
   -MachineUuid <String[]>
   [-UpgradeVersion <String>]
   [-LoggingId <Guid>]
   [-SkipCertificateValidation]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

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

Examples

EXAMPLE 1

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

Get-VusMachineComponentsCommand -MachineUid 1
<!--NeedCopy-->

Parameters

-MachineUid

UID of the machine(s) provided by broker service

Type: Int32[]
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-MachineUuid

UUID of the machine(s) provided by broker service

Type: String[]
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-MachineName

Name of the machine(s) provided by broker service

Type: String[]
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-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

Guid

Outputs

Citrix.VdaUpdateService.Sdk.MachineComponent

Components and feature Information related to Machine

Get-VusMachineComponents