Citrix Virtual Apps and Desktops SDK

Get-AppLibAppVServer

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

Syntax

Get-AppLibAppVServer
   [-Uid <Int32>]
   [-ManagementServer <String>]
   [-PublishingServer <String>]
   [-RetrievePolicy <Boolean>]
   [-RetrievePackageIds <Boolean>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The application library holds the information about App-V Servers and their associated policies

Examples

EXAMPLE 1

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

Get-AppLibAppVServer
<!--NeedCopy-->

EXAMPLE 2

Gets the details of the App-V server with Uid 1.

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

EXAMPLE 3

Gets the details of the App-V server with Uid 1, including it and its containing policy data.

Get-AppLibAppVServer -Uid 1 -RetrievePolicy $true
<!--NeedCopy-->

EXAMPLE 4

Gets the details of the App-V server with given Management Server and Publishing server urls, including it and its containing policy data.

Get-AppLibAppVServer -ManagementServer http://AppVSrv.company.local -PublishingServer http://AppVSrv.company.local:8001 -RetrievePolicy $true
<!--NeedCopy-->

Parameters

-Uid

Uid of the App-V server.

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

-ManagementServer

Management Server Url of the App-V server.

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

-PublishingServer

Publishing Server Url of the App-V server.

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

-RetrievePolicy

A switch to indicate whether to return the servers policy data.

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

-RetrievePackageIds

A switch to indicate whether to return the server package Ids.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByPropertyName, ByValue)
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
Introduced in: Citrix Virtual Apps and Desktop 7 2106

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

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

Notes

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

Call the cmdlet without any parameters to retrieve all of the servers in the AppLibrary.

Get-AppLibAppVServer