Citrix Virtual Apps and Desktops SDK

Get-AppLibLibrary

Gets the details of a library maintained by the AppLibrary service.

Syntax

Get-AppLibLibrary
   [-Uid <Int32>]
   [[-Name] <String>]
   [-Description <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The AppLibrary service maintains information about various libraries. Network locations that are monitored for changes to the App-V packages are stored there.

Examples

EXAMPLE 1

Gets the details of all of the libraries maintained by the AppLibrary service.

Get-AppLibLibrary
<!--NeedCopy-->

EXAMPLE 2

Gets the details of the library named Manual.

Get-AppLibLibrary -Name "Manual"
<!--NeedCopy-->

EXAMPLE 3

Gets the details of the specified library.

Get-AppLibLibrary -Uid 1
<!--NeedCopy-->

Parameters

-Name

The name of the application library.

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

-Uid

The AppLibrary’s internal UID of the library.

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

-Description

A description of the application library.

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

-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

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.Library

An object representing the details required to maintain a library of App-V applications.

Notes

Pass in a library UID to retrieve only that specific library.

Call the cmdlet without any parameters to retrieve all of the libraries maintained by the AppLibrary service.

The ‘Manual’ library is not actively monitored and is designed to be managed by the user for ad-hoc storage of packages in unstructured locations.

Get-AppLibLibrary