Get-AppLibAppVPackage

Last published : Oct 31, 2026
Gets the details of an App-V package held in the application library.
Related information
about_AppLibAppLibrarySnapin

Syntax

Get-AppLibAppVPackage
   [[-Uid] <Int32>]
   [-Name <String>]
   [-LibraryUid <Int32>]
   [-Description <String>]
   [-RetrieveIcon <Boolean>]
   [-RetrieveMetadata <Boolean>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-AppLibAppVPackage
   [[-Uid] <Int32>]
   [-Name <String>]
   [-LibraryUid <Int32>]
   [-Description <String>]
   [-RetrieveIcon <Boolean>]
   -RetrieveApplicationPolicy <Boolean>
   -RetrieveApplicationData <Boolean>
   [-RetrieveMetadata <Boolean>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

The application library holds the information about App-V packages, their location on the network, and the applications they contain.

Examples

EXAMPLE 1

Gets the details of all of the App-V packages in the AppLibrary.
Get-AppLibAppVPackage

EXAMPLE 2

Gets the details of the App-V package named MyPackage.
Get-AppLibAppVPackage -Name "MyPackage"

EXAMPLE 3

Gets the details of all of the App-V packages in the specified library.
Get-AppLibAppVPackage -libraryUid 1

EXAMPLE 4

Gets the details of the App-V package named MyPackage, including it and its containing application's icon data.
Get-AppLibAppVPackage -Name "MyPackage" -RetrieveIcon $true

EXAMPLE 5

Gets the details of the App-V package named MyPackage, including it and its containing application and their policy data.
Get-AppLibAppVPackage -Name "MyPackage" -RetrieveApplicationData $true -RetrieveApplicationPolicy $true

EXAMPLE 6

Gets the details of the App-V package named MyPackage. Here we are setting the retrieveMedata flag to false, so that package info will be returned without metadata
Get-AppLibAppVPackage -Name "MyPackage" -RetrieveMetadata $false

Parameters

-RetrieveApplicationPolicy

A switch to indicate whether to return the package application's policy data data.
Type: Boolean
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-RetrieveApplicationData

A switch to indicate whether to return the package applications.
Type: Boolean
Position: Named
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Name

The name of the App-V package.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-LibraryUid

The AppLibrary's internal UID of the specific library that holds details of the App-V package.
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Description

A description of the App-V package and its contents.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-RetrieveIcon

A switch to indicate whether to return the package's icon data.
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RetrieveMetadata

A switch to indicate whether to return the package metadata
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-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

-Uid

The AppLibrary's internal UID of the App-V package.
Type: Int32
Position: 2
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
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.AppVPackage

An object representing the details needed to identify an App-V package.

Notes

Pass in the App-V package's UID to retrieve a single App-V package.
Pass in a library UID to retrieve all af the packages in that library.
Call the cmdlet without any parameters to retrieve all of the packages in the AppLibrary.