Export (0) Print
Expand All
Expand Minimize

Set-RDRemoteApp

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-RDRemoteApp

Modifies configuration settings for a RemoteApp program.

Syntax

Parameter Set: Session
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 [-CollectionName] <String> -Alias <String> -VirtualDesktopName <String> [-CommandLineSetting <CommandLineSettingValue> ] [-ConnectionBroker <String> ] [-DisplayName <String> ] [-FilePath <String> ] [-FileVirtualPath <String> ] [-FolderName <String> ] [-IconIndex <String> ] [-IconPath <String> ] [-RequiredCommandLine <String> ] [-ShowInWebAccess <Boolean> ] [-UserGroups <String[]> ] [ <CommonParameters>]




Detailed Description

The Set-RDRemoteApp cmdlet modifies configuration settings for a Windows Server 2012 RemoteApp program that runs in a Remote Desktop deployment.

RemoteApp allows Remote Desktop Services (RDS) to run a program remotely that appears as if it runs locally on a client computer. A RemoteApp program runs in its own resizable window and has its own entry on the taskbar.

Parameters

-Alias<String>

Specifies an alias for the RemoteApp program. This alias must be unique within the collection specified by the CollectionName parameter.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-CollectionName<String>

Specifies the name of a virtual desktop collection or session collection.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-CommandLineSetting<CommandLineSettingValue>

Specifies whether the RemoteApp program accepts command-line arguments from the client at connection time. The acceptable values for this parameter are: 

-- Allow. Accepts command-line arguments.
-- DoNotAllow. Does not accept command-line arguments.
-- Require. Allows only command-line arguments specified in the RequiredCommandLine parameter.


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 a Remote Desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DisplayName<String>

Specifies a name to display to users for the RemoteApp program.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-FilePath<String>

Specifies a path for the executable file for the application. Do not include any environment variables. For session collections, this path must be a valid local path on all Remote Desktop Session Host (RD Session Host) servers in the collection. For virtual desktop collections, this path must be a valid local path on all virtual desktops in the collection.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-FileVirtualPath<String>

Specifies a path for the application executable file. This path resolves to the same location as the value of the FilePath parameter, but it 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 program appears in on the Remote Desktop Web Access (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 in the icon file for the RemoteApp program icon. The IconPath parameter specifies the icon file.


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 display for the RemoteApp program identified by the Alias parameter. This path must not contain any environment variables. For session collections, the path must be a valid local path on all RD Session Host servers in the collection. For virtual desktop collections, the path must be a valid local path on all virtual desktops in the collection.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RequiredCommandLine<String>

Specifies a string that contains command-line arguments that the client can use at connection time with the RemoteApp program. If you specify this parameter, the CommandLineSetting parameter must have a value of Require.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ShowInWebAccess<Boolean>

Specifies whether to show the RemoteApp program in the RD Web Access server, and in RemoteApp and Desktop Connections that the user subscribes to.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-UserGroups<String[]>

Specifies an array of domain groups and users that can view the RemoteApp in RD Web Access, and in RemoteApp and Desktop Connections. To allow all users to see a RemoteApp program, provide a value of $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 a virtual desktop. The icon file specified in the IconPath parameter resides in this virtual desktop. The virtual desktop must be a member of the collection specified by the CollectionName parameter.


Aliases

VMName

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.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

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

  • Null

    None.


Examples

Example 1: Modify settings for a RemoteApp program

This command modifies settings for a RemoteApp program in the collection named Virtual Desktop Collection. The command specifies IE as an alias, and specifies Websites as the folder where the RemoteApp program appears. The command specifies the virtual desktop name RDS-WKS-A27. This command uses a required command line argument. This RemoteApp opens the specified browser to go to the specified URL.


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

Example 2: Modify user and group settings for a RemoteApp program

This command modifies settings for a RemoteApp program in the collection named Session Collection. The command specifies Notepad as an alias for the program, and specifies the Admin Tools as the folder where this RemoteApp program appears. The command also specifies the users and groups that can see the program.


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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft