Set-RDRemoteApp
Modifies configuration settings for a RemoteApp program.
Syntax
Set-RDRemoteApp
[-CollectionName] <String>
-Alias <String>
[-DisplayName <String>]
[-FilePath <String>]
[-FileVirtualPath <String>]
[-ShowInWebAccess <Boolean>]
[-FolderName <String>]
[-CommandLineSetting <CommandLineSettingValue>]
[-RequiredCommandLine <String>]
[-UserGroups <String[]>]
[-IconPath <String>]
[-IconIndex <String>]
[-ConnectionBroker <String>]
[<CommonParameters>] Set-RDRemoteApp
[-CollectionName] <String>
-Alias <String>
[-DisplayName <String>]
[-FilePath <String>]
[-FileVirtualPath <String>]
[-ShowInWebAccess <Boolean>]
[-FolderName <String>]
[-CommandLineSetting <CommandLineSettingValue>]
[-RequiredCommandLine <String>]
[-UserGroups <String[]>]
[-IconPath <String>]
[-IconIndex <String>]
-VirtualDesktopName <String>
[-ConnectionBroker <String>]
[<CommonParameters>] 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.
Examples
Example 1: Modify settings for a RemoteApp program
PS C:\> Set-RDRemoteApp -CollectionName "Virtual Desktop Collection" -Alias "IE" -VirtualDesktopName "RDS-WKS-A27" -FolderName "Websites" -CommandLineSetting Require -RequiredCommandLine "http://www.bing.com"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.
Example 2: Modify user and group settings for a RemoteApp program
PS C:\> Set-RDRemoteApp -CollectionName "Session Collection" -Alias "Notepad" -FolderName "Admin Tools" -UserGroups @("contoso\Domain Admins")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.
Parameters
-Alias
Specifies an alias for the RemoteApp program. This alias must be unique within the collection specified by the CollectionName parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CollectionName
Specifies the name of a virtual desktop collection or session collection.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CommandLineSetting
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.
| Type: | CommandLineSettingValue |
| Accepted values: | DoNotAllow, Allow, Require |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ConnectionBroker
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisplayName
Specifies a name to display to users for the RemoteApp program.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FilePath
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FileVirtualPath
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FolderName
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IconIndex
Specifies the index in the icon file for the RemoteApp program icon. The IconPath parameter specifies the icon file.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IconPath
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RequiredCommandLine
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ShowInWebAccess
Specifies whether to show the RemoteApp program in the RD Web Access server, and in RemoteApp and Desktop Connections that the user subscribes to.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-UserGroups
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.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VirtualDesktopName
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.
| Type: | String |
| Aliases: | VMName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Outputs
Null