Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-Applibappvpackage

August 3, 2023
Contributed by: 
C

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

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>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Get-AppLibAppVPackage -RetrieveApplicationPolicy <Boolean> -RetrieveApplicationData <Boolean> [-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>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

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

Parameters

Name Description Required? Pipeline Input Default Value
RetrieveApplicationPolicy A switch to indicate whether to return the package application’s policy data data. true true (ByValue, ByPropertyName)  
RetrieveApplicationData A switch to indicate whether to return the package applications. true true (ByValue, ByPropertyName)  
Uid The AppLibrary’s internal UID of the App-V package. false true (ByPropertyName)  
Name The name of the App-V package. false true (ByPropertyName)  
LibraryUid The AppLibrary’s internal UID of the specific library that holds details of the App-V package. false true (ByPropertyName)  
Description A description of the App-V package and its contents. false true (ByPropertyName)  
RetrieveIcon A switch to indicate whether to return the package’s icon data. false true (ByPropertyName)  
RetrieveMetadata A switch to indicate whether to return the package metadata false true (ByPropertyName)  
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. false 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. false false False
MaxRecordCount Specifies the maximum number of records to return. false false 250
Skip Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. false false 0
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. false false The default sort order is by name or unique identifier.
Filter Gets records that match a PowerShell-style filter expression. See about_AppLib_Filtering for details. false false  
FilterScope Gets only results allowed by the specified scope id. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

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.

Examples

Example 1 

Get-AppLibAppVPackage
<!--NeedCopy-->

Description

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

Example 2 

Get-AppLibAppVPackage -Name "MyPackage"
<!--NeedCopy-->

Description

Gets the details of the App-V package named MyPackage.

Example 3 

Get-AppLibAppVPackage -libraryUid 1
<!--NeedCopy-->

Description

Gets the details of all of the App-V packages in the specified library.

Example 4 

Get-AppLibAppVPackage -Name "MyPackage" -RetrieveIcon $true
<!--NeedCopy-->

Description

Gets the details of the App-V package named MyPackage, including it and its containing application’s icon data.

Example 5 

Get-AppLibAppVPackage -Name "MyPackage" -RetrieveApplicationData $true -RetrieveApplicationPolicy $true
<!--NeedCopy-->

Description

Gets the details of the App-V package named MyPackage, including it and its containing application and their policy data.

Example 6 

Get-AppLibAppVPackage -Name "MyPackage" -RetrieveMetadata $false
<!--NeedCopy-->

Description

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
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.