This topic has not yet been rated - Rate this topic

Set-RDRemoteApp

Updated: September 14, 2012

Applies To: Windows Server 2012

Set-RDRemoteApp

Specifies configuration details for a RemoteApp program running in the remote desktop deployment.

Syntax

Parameter Set: __AllParameterSets
Set-RDRemoteApp [-CollectionName] <String> -Alias <String> [-CommandLineSetting <CommandLineSettingValue> ] [-ConnectionBroker <String> ] [-DisplayName <String> ] [-FilePath <String> ] [-FileVirtualPath <String> ] [-FolderName <String> ] [-IconIndex <String> ] [-IconPath <String> ] [-RequiredCommandLine <String> ] [-ShowInWebAccess <Boolean> ] [-UserGroups <String[]> ] [ <CommonParameters>]

Parameter Set: VirtualDesktop
Set-RDRemoteApp -VirtualDesktopName <String> [ <CommonParameters>]

Detailed Description

The Set-RDRemoteApp cmdlet specifies configuration details for a RemoteApp program running in the remote desktop deployment.

Parameters

-Alias<String>

Specifies the alias for the RemoteApp program. This parameter is required. (The default alias is the program's file name without the extension.)

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CollectionName<String>

Specifies the name of the personal virtual desktop collection. This parameter is required.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CommandLineSetting<CommandLineSettingValue>

Specifies whether the RemoteApp should accept command-line arguments from the client at connection time. Valid values are DoNotAllow, Allow, and Require. Use Require to specify that only certain command-line arguments may be accepted, as described in the RequiredCommandLine parameter. Use Allow if any command-line arguments may be accepted.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ConnectionBroker<String>

Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for this remote desktop deployment. If not supplied, defaults to the fully qualified domain name (FQDN) of the local host.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DisplayName<String>

Specifies a user-friendly name for the RemoteApp. This is the name displayed to users.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-FilePath<String>

Specifies the path to the executable file for the application. The path specified here may not contain any environment variables, and must be a valid local path on all Remote Desktop Session Host (RDSH) servers in the collection for session collections, and a valid local path on all virtual desktops in the collection for virtual desktop collections.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-FileVirtualPath<String>

Provides a path to the application executable file that can include environment variables.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-FolderName<String>

Specifies the name of the folder that the RemoteApp will appear under on the RD Web Access webpage and in the Start menu, for subscribed RemoteApp and Desktop Connections.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-IconIndex<String>

Specifies the index into the icon file supplied by the IconPath parameter.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-IconPath<String>

Specifies the path to a file containing the icon to be displayed for the RemoteApp program identified by the Alias parameter. The path specified here may not contain any environment variables, and must be a valid local path on all Remote Desktop Session Host (RDSH) servers in the collection for session collections, and a valid local path on all virtual desktops in the collection for virtual desktop collections.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RequiredCommandLine<String>

Provides a string specifying command-line arguments that the client may pass at connection time to the application running as a RemoteApp. This parameter is used only if the value for the CommandLineSetting parameter is set to Require.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ShowInWebAccess<Boolean>

Specifies whether the RemoteApp should be displayed on the Remote Desktop Web Access (RD Web Access) server, and in RemoteApp and Desktop Connections to which the user has subscribed.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-UserGroups<String[]>

Specifies a list of domain groups and users that can view the RemoteApp in RD Web Access, and in published RemoteApp and Desktop Connections. To allow all users to see this RemoteApp program, set this value to $null.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-VirtualDesktopName<String>

Specifies the name of the virtual desktop where the icon file defined by the IconPath parameter is stored. This parameter is required. The virtual desktop identified here must be a member of the collection specified by the CollectionName parameter.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Outputs

The output type is the type of the objects that the cmdlet emits.

Null

None.

Examples

Example 1:

Description

PS C:\> Set-RDRemoteApp -CollectionName "Virtual Desktop Collection" –VirtualDesktopName ”RDS-WKS-A27” -Alias iexplore -CommandLineSetting Require -RequiredCommandLine "http://www.bing.com" -FolderName "Websites"

Example 2:

Description

PS C:\> Set-RDRemoteApp -CollectionName "Session Collection" -Alias notepad -UserGroups @("contoso\Domain Admins") -FolderName "Admin Tools"

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)