Citrix Virtual Apps and Desktops SDK

Get-AppLibAppVApplication

Gets the details of an App-V application held in the application library.

Syntax

Get-AppLibAppVApplication
   [[-Uid] <Int32>]
   [-Name <String>]
   [-AppVPackageUid <Int32>]
   [-Description <String>]
   [-RetrieveIcon <Boolean>]
   [-RetrievePolicy <Boolean>]
   [-RetrieveUsers <Boolean>]
   [-RetrieveMetadata <Boolean>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The application library holds the information required to find and launch an App-V application on a client VDA.

Examples

EXAMPLE 1

Gets the details for all of the App-V applications in the library.

Get-AppLibAppVApplication
<!--NeedCopy-->

EXAMPLE 2

Gets the details of the App-V application named MyApp.

Get-AppLibAppVApplication -Name "MyApp"
<!--NeedCopy-->

EXAMPLE 3

Gets the details of all of the App-V applications in the specified package.

Get-AppLibAppVApplication -AppVPackageUid 15
<!--NeedCopy-->

EXAMPLE 4

Gets the details of all App-V applications without the metadata

Get-AppLibAppVApplication -RetrieveMetadata $false
<!--NeedCopy-->

Parameters

-Name

The name of the application in the the App-V package.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-AppVPackageUid

The AppLibrary’s internal UID of the App-V package that contains the application.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Description

A description of the application.

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

-RetrieveIcon

A switch to indicate whether to return the application’s icon data.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-RetrievePolicy

A switch to indicate whether to return the application’s policy blob

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-RetrieveUsers

A switch to indicate whether to return the application’s associated users

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-RetrieveMetadata

A switch to indicate whether to return the application’s metadata

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2003

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

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

-ReturnTotalRecordCount

When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_AppLib_Filtering for details.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MaxRecordCount

Specifies the maximum number of records to return.

Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell-style filter expression. See about_AppLib_Filtering for details.

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

-FilterScope

Gets only results allowed by the specified scope id.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2106

-Uid

The AppLibrary’s internal UID of the App-V application.

Type: Int32
Position: 2
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
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

None

You can’t pipe objects to this cmdlet.

Outputs

Citrix.AppLibrary.Sdk.AppVApplication

An object representing the details required to launch the App-V application.

Notes

Pass in the App-V application’s UID to retrieve a single application.

Pass in a package UID to retrieve all of the applications in that package.

Call the cmdlet without any parameters to retrieve all of the applications in the library.

Get-AppLibAppVApplication