Citrix Virtual Apps and Desktops SDK

Get-BrokerApplication

Get the applications published on this site.

Syntax

Get-BrokerApplication
   [[-Name] <String>]
   [-AdminFolderName <String>]
   [-AdminFolderUid <Int32>]
   [-AllAssociatedDesktopGroupUid <Int32>]
   [-AllAssociatedDesktopGroupUUID <Guid>]
   [-ApplicationName <String>]
   [-ApplicationType <ApplicationType>]
   [-AssociatedApplicationGroupUid <Int32>]
   [-AssociatedApplicationGroupUUID <Guid>]
   [-AssociatedDesktopGroupPriority <Int32>]
   [-AssociatedDesktopGroupUid <Int32>]
   [-AssociatedDesktopGroupUUID <Guid>]
   [-AssociatedUserFullName <String>]
   [-AssociatedUserName <String>]
   [-AssociatedUserSID <String>]
   [-AssociatedUserUPN <String>]
   [-BrowserName <String>]
   [-ClientFolder <String>]
   [-CommandLineArguments <String>]
   [-CommandLineExecutable <String>]
   [-CpuPriorityLevel <CpuPriorityLevel>]
   [-Description <String>]
   [-DoNotEnumerate <Boolean>]
   [-Enabled <Boolean>]
   [-HomeZoneName <String>]
   [-HomeZoneOnly <Boolean>]
   [-HomeZoneUid <Guid>]
   [-IconFromClient <Boolean>]
   [-IconUid <Int32>]
   [-IgnoreUserHomeZone <Boolean>]
   [-LocalLaunchDisabled <Boolean>]
   [-MaxPerMachineInstances <Int32>]
   [-MaxPerUserInstances <Int32>]
   [-MaxTotalInstances <Int32>]
   [-MetadataKey <String>]
   [-Metadata <String>]
   [-PackagedApplicationId <String>]
   [-PackagedApplicationType <String>]
   [-PublishedName <String>]
   [-SecureCmdLineArgumentsEnabled <Boolean>]
   [-ShortcutAddedToDesktop <Boolean>]
   [-ShortcutAddedToStartMenu <Boolean>]
   [-StartMenuFolder <String>]
   [-Tag <String>]
   [-UserFilterEnabled <Boolean>]
   [-UUID <Guid>]
   [-Visible <Boolean>]
   [-WaitForPrinterCreation <Boolean>]
   [-WorkingDirectory <String>]
   [-DesktopUid <Int32>]
   [-ApplicationGroupUid <Int32>]
   [-SessionUid <Int64>]
   [-UserSID <String>]
   [-DesktopGroupUid <Int32>]
   [-MachineConfigurationUid <Int32>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerApplication
   [-Uid] <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Get-BrokerApplication cmdlet gets the published applications that are hosted on this site.

Without parameters, Get-BrokerApplication gets all the applications that have been published, regardless of whether they are visible to users or not. You can also use the parameters of Get-BrokerApplication to filter the results to just the applications you’re interested in. You can also identify applications by their UIDs or their BrowserNames.

For more information about applications, see about_Broker_Applications.

————————– BrokerApplication Object

The BrokerApplication object represents a published application in the site. It contains the following properties:

  • AdminFolderName (System.String)

    The name of the admin folder the application is in (including trailing backslash), or the empty string if the application is at the root level

  • AdminFolderUid (System.Int32)

    The Uid of the admin folder the application is in (if any)

  • AllAssociatedDesktopGroupUids (System.Int32[])

    List of associated desktop group uids, including desktop groups that are indirectly associated with the application by virtue of being associated with an application group of which this application is a member.

  • AllAssociatedDesktopGroupUUIDs (System.Guid[])

    List of associated desktop group UUIDs, including desktop groups that are indirectly associated with the application by virtue of being associated with an application group of which this application is a member.

  • ApplicationName (System.String)

    The simple name of the application within its parent admin folder (if any)

  • ApplicationType (Citrix.Broker.Admin.SDK.ApplicationType)

    The type of the application, whether HostedOnDesktop, InstalledOnClient or PublishedContent.

  • AssociatedApplicationGroupUids (System.Int32[])

    List of associated application group uids.

  • AssociatedApplicationGroupUUIDs (System.Guid[])

    List of associated application group UUIDs.

  • AssociatedDesktopGroupPriorities (System.Int32[])

    List of directly associated desktop group priorities. Associated desktop groups is the list of desktop groups on which the application is published. When launching an application an available machine from one of the associated groups is selected. Desktop groups are searched for available machines in order of their priority.

  • AssociatedDesktopGroupUids (System.Int32[])

    List of directly associated desktop group uids. Associated desktop groups is the list of desktop groups on which the application is published. The list is sorted by priority, with the highest priority group first.

  • AssociatedDesktopGroupUUIDs (System.Guid[])

    List of directly associated desktop group UUIDs. Associated desktop groups is the list of desktop groups on which the application is published. The list is sorted by priority, with the highest priority group first.

  • AssociatedUserFullNames (System.String[])

    List of associated users (full names). Associated users is the list of users who are given access using the application/user mapping filter.

  • AssociatedUserNames (System.String[])

    List of associated users (SAM names). Associated users is the list of users who are given access using the application/user mapping filter.

  • AssociatedUserSIDs (System.String[])

    List of associated users (SIDs). Associated users is the list of users who are given access using the application/user mapping filter.

  • AssociatedUserUPNs (System.String[])

    List of associated users (user principle names). Associated users is the list of users who are given access using the application/user mapping filter.

  • BrowserName (System.String)

    Unique browser name used to identify this application to other components in the site. This value is not visible to the end users.

  • ClientFolder (System.String)

    The folder that the application belongs to as the user sees it.

  • CommandLineArguments (System.String)

    The command-line arguments to use when launching the executable.

  • CommandLineExecutable (System.String)

    The name including the full path of the executable file to launch.

  • ConfigurationSlotUids (System.Int32[])

    Uids of any configuration slots which hold machine configurations associated with the application. The order of slot UIDs in this list correspond with the order of items in the associated MachineConfigurationNames and MachineConfigurationUids list properties, and so the same slot UID can appear more than once.

  • CpuPriorityLevel (Citrix.Broker.Admin.SDK.CpuPriorityLevel)

    The CPU priority of the launched process. Valid values are: Low, BelowNormal, Normal, AboveNormal, and High.

  • Description (System.String)

    Optional application description. This description is visible to the end users.

  • DoNotEnumerate (System.Boolean)

    Specifies if the application is returned to the user by enumeration.

  • Enabled (System.Boolean)

    Specifies whether or not this application can be launched.

  • HomeZoneName (System.String)

    Name of optional preferred home zone for launching the application.

  • HomeZoneOnly (System.Boolean)

    Indicates that if the preferred zone for launching the application is its home zone but no machine is available from that zone then the launch fails.

  • HomeZoneUid (System.Guid?)

    Optional preferred home zone for launching the application.

  • IconFromClient (System.Boolean)

    Specifies if the app icon should be retrieved from the application on the client. This is reserved for possible future use, and all applications of type HostedOnDesktop cannot set or change this value.

  • IconUid (System.Int32?)

    The icon UID used for this application. If not specified a generic icon is used.

  • IgnoreUserHomeZone (System.Boolean)

    Indicates that when launching the application and the user has a home zone specified then the user’s home zone preference should be ignored.

  • LocalLaunchDisabled (System.Boolean)

    When launching a published application from within a published desktop, do not launch the application in that desktop session.

  • MachineConfigurationNames (System.String[])

    The MachineConfiguration names associated with the application.

  • MachineConfigurationUids (System.Int32[])

    The MachineConfiguration uids associated with the application.

  • MaxPerMachineInstances (System.Int32)

    Maximum allowed concurrently running instances of the application that an individual machine can have. A value of zero allows unlimited usage subject to any site-wide limit.

  • MaxPerUserInstances (System.Int32)

    Maximum allowed concurrently running instances of the application that an individual user can have. A value of zero allows unlimited usage subject to any site-wide limit.

  • MaxTotalInstances (System.Int32)

    Maximum allowed total of concurrently running instances of the application in the site. A value of zero allows unlimited usage.

  • MetadataKeys (System.String[])

    All key names of metadata items associated with this application.

  • MetadataMap (System.Collections.Generic.Dictionary<string, string>)

    Metadata for this application.

  • Name (System.String)

    Unique administrative name of application; this will include any parent admin folder hierarchy separated by backslash characters.

  • PackagedApplicationId (System.String)

    The Id of the Packaged Application in the AppLibrary

  • PackagedApplicationType (System.String)

    The packaging technology used to create this application

  • PublishedName (System.String)

    Published name of application as seen by end user. If not specified value used defaults to the administrative name.

  • SecureCmdLineArgumentsEnabled (System.Boolean)

    Specifies whether the command-line arguments should be secured.

  • ShortcutAddedToDesktop (System.Boolean)

    Specifies whether a shortcut to the application should be placed on the user device.

  • ShortcutAddedToStartMenu (System.Boolean)

    Specifies whether a shortcut to the application should be placed in the user’s Start menu on their user device.

  • StartMenuFolder (System.String)

    The name of the Start menu folder that holds the application shortcut.

  • Tags (System.String[])

    A list of tags associated with the application.

  • Uid (System.Int32)

    A unique identifier of the application.

  • UserFilterEnabled (System.Boolean)

    Indicates if application-specific user filter is enabled.

  • UUID (System.Guid)

    UUID of the application.

  • Visible (System.Boolean)

    Specifies if the application is visible to users.

  • WaitForPrinterCreation (System.Boolean)

    Specifies whether the VDA delays starting the app until printers are set up or not.

  • WorkingDirectory (System.String)

    The working directory the executable is launched from.

Examples

EXAMPLE 1

Returns the application with the Name of “Notepad”.

Get-BrokerApplication Notepad
<!--NeedCopy-->

EXAMPLE 2

Returns the applications that have a PublishedName starting with “Note” and that are enabled.

Get-BrokerApplication -PublishedName Note* -Enabled $true
<!--NeedCopy-->

Parameters

-Uid

Gets only the application with the specified unique identifier.

Type: Int32
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Name

Gets only the applications matching the specified name (including any parent admin folder hierarchy.

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

-AdminFolderName

Gets applications that are in admin folders matching the specified name.

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

-AdminFolderUid

Gets applications that are in the specified admin folder.

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

-AllAssociatedDesktopGroupUid

Gets applications associated with the desktop group identified by the uid.

The application may be either published directly on the desktop group or published indirectly on the desktop group as part of an application group.

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

-AllAssociatedDesktopGroupUUID

Gets applications associated with the desktop group identified by the UUID.

The application may be either published directly on the desktop group or published indirectly on the desktop group as part of an application group.

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

-ApplicationName

Gets applications that match the specified simple name.

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

-ApplicationType

Gets applications that match the type specified: HostedOnDesktop, InstalledOnClient or PublishedContent.

Type: ApplicationType
Accepted values: HostedOnDesktop, InstalledOnClient, SessionPreLauncher, PublishedContent, PackagedApplication
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AssociatedApplicationGroupUid

Gets applications that are members of the application group identified by the uid.

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

-AssociatedApplicationGroupUUID

Gets applications that are members of the application group identified by the UUID.

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

-AssociatedDesktopGroupPriority

Gets applications with an associated desktop group identified by priority assigned to the pairing between an application and desktop group.

Associated desktop group is a desktop group on which the application is published.

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

-AssociatedDesktopGroupUid

Gets applications directly associated with the desktop group identified by the uid.

The application must be published directly on the desktop group. To search for applications that may be published indirectly on the desktop group as part of an application group, use the AllAssociatedDesktopGroupUid filter instead.

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

-AssociatedDesktopGroupUUID

Gets applications directly associated with the desktop group identified by the UUID.

The application must be published directly on the desktop group. To search for applications that may be published indirectly on the desktop group as part of an application group, use the AllAssociatedDesktopGroupUid filter instead.

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

-AssociatedUserFullName

Gets applications with an associated user identified by their full name (usually ‘first-name last-name’).

If the ‘UserFilterEnabled’ property is true then access to the application is restricted to those users only, otherwise access is unrestricted (but always subject to other policy rules).

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

-AssociatedUserName

Gets applications with an associated user identified by their user name (in the form ‘domain\user’). If the ‘UserFilterEnabled’ property is true then access to the application is restricted to those users only, otherwise access is unrestricted (but always subject to other policy rules).

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

-AssociatedUserSID

Gets applications with an associated user identified by their Windows SID. If the ‘UserFilterEnabled’ property is true then access to the application is restricted to those users only, otherwise access is unrestricted (but always subject to other policy rules).

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

-AssociatedUserUPN

Gets applications with an associated user identified by their user principle name (in the form ‘user@domain’). If the ‘UserFilterEnabled’ property is true then access to the application is restricted to those users only, otherwise access is unrestricted (but always subject to other policy rules).

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

-BrowserName

Gets only the applications that match the supplied name. The BrowserName is usually an internal name for the application and is unique in the site.

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

-ClientFolder

Gets only the applications that match the specified value for the folder the application belongs to as seen by the end-user. This folder can be seen in the Citrix Online Plug-in, in Web Services, and also potentially in the user’s start menu.

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

-CommandLineArguments

Gets only the applications that match the supplied arguments to the command-line executable.

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

-CommandLineExecutable

Gets only the applications that match the supplied command-line executable.

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

-CpuPriorityLevel

Gets only the applications that have the specified value for the CPU priority level of the launched executable. Valid values are: Low, BelowNormal, Normal, AboveNormal, and High.

Type: CpuPriorityLevel
Accepted values: Low, BelowNormal, Normal, AboveNormal, High
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Description

Gets only the applications that match the supplied description.

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

-DoNotEnumerate

Gets only the applications that have the specified value for whether the application is hidden from enumeration. Hidden applications are not visible to the user but may still be launched by other means.

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 2212

-Enabled

Gets only the applications that have the specified value for whether the application is enabled. Disabled applications are still visible to users (that is controlled by the Visible setting) but cannot be launched.

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

-HomeZoneName

Gets only applications with a home zone preference matching the specified name.

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

-HomeZoneOnly

Gets only applications that have the specified behaviour with respect to forcing use of their home zone during launch.

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

-HomeZoneUid

Gets only applications with a home zone preference matching the specified UID.

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

-IconFromClient

Gets only the applications that have the specified value for whether the application icon should be retrieved from the user device.

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

-IconUid

Gets only the applications that use the specified icon (identified by its Uid).

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

-IgnoreUserHomeZone

Gets only applications that have the specified behaviour with respect to ignoring user home zones during launch.

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

-LocalLaunchDisabled

Gets only applications that have the specified local launch behaviour

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

-MaxPerMachineInstances

Gets only applications with the specified maximum allowed concurrently running instances that an individual machine can have.

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

-MaxPerUserInstances

Gets only applications with the specified maximum allowed concurrently running instances that an individual user can have.

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

-MaxTotalInstances

Gets only applications with the specified maximum allowed total of concurrently running instances in the site.

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

-MetadataKey

Gets only applications whose associated metadata contains key names matching the specified value.

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

-Metadata

Gets records with matching metadata entries.

The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.

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

-PackagedApplicationId

Gets only the applications with the specified Packaged Application Id

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

-PackagedApplicationType

Gets only the applications with the specified application package type

Type: String
Accepted values: NotApplicable, AppVSingleAdmin, AppVDualAdmin, Msix, AppAttach, FlexApp
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2311

-PublishedName

Gets applications whose published name matches the supplied pattern.

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

-SecureCmdLineArgumentsEnabled

Gets only the applications that have the specified value for whether the command-line arguments should be secured. This is reserved for possible future use, and all applications of type HostedOnDesktop can only have this value set to true.

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

-ShortcutAddedToDesktop

Gets only the applications that match depending on whether a shortcut for the application has been added to the user device or not.

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

-ShortcutAddedToStartMenu

Gets only the applications that match depending on whether a shortcut for the application has been added to Start Menu of the user device or not.

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

-StartMenuFolder

Gets only the applications that match the specified name for the start menu folder that holds the application shortcut. This is valid only for the Citrix Online Plug-in.

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

-Tag

Gets applications associated with the specified tag.

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

-UserFilterEnabled

Gets only applications whose user filter is in the specified state.

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

-UUID

Gets applications with the specified value of UUID.

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

-Visible

Gets only the applications that have the specified value for whether it is visible to the users.

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

-WaitForPrinterCreation

Gets only the applications that match depending on whether the VDA delays starting the application until printers are set up.

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

-WorkingDirectory

Gets only the applications that match the specified working directory.

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

-DesktopUid

Gets only the applications that have been associated (using a desktop group) to the specified desktop (identified by its Uid). Note that an application is not directly associated with a desktop, but only indirectly by which desktop group it has been published to.

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

-ApplicationGroupUid

Gets applications that are members of the application group identified by the uid.

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

-SessionUid

Gets only the applications that are running in the specified session (identified by its Uid).

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

-UserSID

Gets only applications with their accessibility restricted to include the specified user.

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

-DesktopGroupUid

Gets only the applications that have been published to the specified desktop group (identified by its Uid).

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

-MachineConfigurationUid

Gets only applications which have an associated machine configuration identified by the given Uid.

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

-ReturnTotalRecordCount

When specified, this causes the cmdlet to output 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_Broker_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_Broker_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

-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

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 cannot pipe input into this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.Application

Get-BrokerApplication returns an object for each application it gets.

Notes

Get-BrokerApplication returns just the application object, and as such is not a complete picture. The returned objects do not tell you what File-Type Associations are configured for this application, etc.

Use the following cmdlets to gather data related to applications (shown with examples of syntax):

Get-BrokerConfiguredFTA -ApplicationUid $app.Uid

Get-BrokerTag -ApplicationUid $app.Uid

Get-BrokerDesktopGroup -ApplicationUid $app.Uid

Get-BrokerDesktop -PublishedApplication $app

Get-BrokerSession -ApplicationUid $app.Uid

Get-BrokerApplicationInstance -ApplicationUid $app.Uid

Get-BrokerApplication