Citrix Virtual Apps and Desktops SDK

Get-AppLibAppDiskStartMenuShortcut

August 3, 2023

Contributed by:

Gets the AppDisk start menu shortcuts for the AppLibrary Service.

Syntax

Get-AppLibAppDiskStartMenuShortcut [-StartMenuShortcutUid <Guid>] [-AppDiskUid <Guid>] [-AppDiskName <String>] [-CommandLineExecutable <String>] [-CommandLineArguments <String>] [-Description <String>] [-DisplayName <String>] [-ShortcutPath <String>] [-WorkingDirectory <String>] [-IconUid <Guid>] [-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

Returns a list of AppDisk shortcuts known to the AppLibrary Service.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
StartMenuShortcutUid	The identifier of a specific shortcut to inspect.	false	false
AppDiskUid	The identifier of a specific AppDisk to inspect.	false	false
AppDiskName	The name of a specific AppDisk to inspect.	false	false
CommandLineExecutable	The executable indicated by the shortcut to match	false	false
CommandLineArguments	The command line argument string of a shortcut to match	false	false
Description	The description of the shortcut to match	false	false
DisplayName	The displayed name of the shortcut to match	false	false
ShortcutPath	The path of the shortcut to match	false	false
WorkingDirectory	The working directory of the shortcut to match	false	false
IconUid	The identifier of a specific icon to inspect.	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.Appdiskshortcut

This object provides details of the shortcut and its use, and contains the following information: AppDiskUid <Guid> The identifier for the owning AppDisk AppDiskName <string> The identifier for the owning AppDisk IconUid <Guid> The identifier for the icon, if present CommandLineExecutable <string> The shortcut executable property CommandLineArguments <string> The shortcut arguments property Description <string> The shortcut description property DisplayName <string> The shortcut display name property ShortcutPath <string> The shortcut path property WorkingDirectory <string> The shortcut working directory property

Notes

If the command fails, the following errors can result.

UnknownObject: One of the specified objects was not found.
PartialData: Only a subset of the available data was returned.
InvalidFilter: A filtering expression was supplied that could not be interpreted for this cmdlet.
CouldNotQueryDatabase: The query required to get the database was not defined.
DatabaseError: An error occurred in the service while attempting a database operation.
DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.
DataStoreException: An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
PermissionDenied: You do not have permission to execute this command.
AuthorizationError: There was a problem communicating with the Citrix Delegated Administration Service.
CommunicationError: There was a problem communicating with the remote service.
ExceptionThrown: An unexpected error occurred. For more details, see the Windows event logs on the controller or the XenDesktop logs.

Examples

Example 1

c:\PS>Get-AppLibStartMenuIcon -AppDiskName MyAppDisk

          AppDiskUid               : d9ba6487-05f8-48ad-a178-1794605e2b8e

          AppDiskName              : MyAppDisk

          IconUid                  : 7b4c01c4-72fa-4c80-913d-c6df785f4297

          CommandLineExecutable    : "C:\Program Files (x86)\Mozilla Firefox\firefox.exe"

          CommandLineArguments     :

          Description              :

          DisplayName              : Mozilla Firefox

          ShortcutPath             : "C:\Users\Public\Desktop\Mozilla Firefox.lnk"

          WorkingDirectory         : "C:\Program Files (x86)\Mozilla Firefox"

          AppDiskUid               : d9ba6487-05f8-48ad-a178-1794605e2b8e

          AppDiskName              : MyAppDisk

          ...

<!--NeedCopy-->

Description

Get all shortcuts for the AppLDisk “MyAppDisk”.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-AppLibAppDiskStartMenuShortcut

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Get-AppLibAppDiskStartMenuShortcut

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Applibrary.Sdk.Appdiskshortcut

Notes

Examples

Example 1

Description

In this article