< Back
Set-RDRemoteApp
Post
NAME Set-RDRemoteApp
SYNOPSIS
Modifies configuration settings for a RemoteApp program.
SYNTAX
Set-RDRemoteApp [-CollectionName] <String> [-CommandLineSetting {DoNotAllow | Allow | Require}] [-ConnectionBroker <String>] [-DisplayName
<String>] [-FilePath <String>] [-FileVirtualPath <String>] [-FolderName <String>] [-IconIndex <String>] [-IconPath <String>] [-RequiredCommandLine
<String>] [-ShowInWebAccess <Boolean>] [-UserGroups <String[]>] -Alias <String> [<CommonParameters>]
Set-RDRemoteApp [-CollectionName] <String> [-CommandLineSetting {DoNotAllow | Allow | Require}] [-ConnectionBroker <String>] [-DisplayName
<String>] [-FilePath <String>] [-FileVirtualPath <String>] [-FolderName <String>] [-IconIndex <String>] [-IconPath <String>] [-RequiredCommandLine
<String>] [-ShowInWebAccess <Boolean>] [-UserGroups <String[]>] -Alias <String> -VirtualDesktopName <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.
PARAMETERS
-Alias <String>
Specifies an alias for the RemoteApp program. This alias must be unique within the collection specified by the CollectionName parameter.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection 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.
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.
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 (RDSession Host) servers in the collection. For virtual desktop collections,
this path must be a valid local path on all virtual desktops in the collection.
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.
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 (RDWebAccess) webpage and in the Start
menu for subscribed RemoteApp and Desktop Connections.
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.
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 RDSession Host servers in the
collection. For virtual desktop collections, the path must be a valid local path on all virtual desktops in the collection.
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.
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 RDWebAccess server, and in RemoteApp and Desktop Connections that the user subscribes
to.
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 RDWebAccess, and in RemoteApp and Desktop Connections. To allow
all users to see a RemoteApp program, provide a value of $Null.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Null
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294263
Get-RDRemoteApp
New-RDRemoteApp
Remove-RDRemoteApp
SYNOPSIS
Modifies configuration settings for a RemoteApp program.
SYNTAX
Set-RDRemoteApp [-CollectionName] <String> [-CommandLineSetting {DoNotAllow | Allow | Require}] [-ConnectionBroker <String>] [-DisplayName
<String>] [-FilePath <String>] [-FileVirtualPath <String>] [-FolderName <String>] [-IconIndex <String>] [-IconPath <String>] [-RequiredCommandLine
<String>] [-ShowInWebAccess <Boolean>] [-UserGroups <String[]>] -Alias <String> [<CommonParameters>]
Set-RDRemoteApp [-CollectionName] <String> [-CommandLineSetting {DoNotAllow | Allow | Require}] [-ConnectionBroker <String>] [-DisplayName
<String>] [-FilePath <String>] [-FileVirtualPath <String>] [-FolderName <String>] [-IconIndex <String>] [-IconPath <String>] [-RequiredCommandLine
<String>] [-ShowInWebAccess <Boolean>] [-UserGroups <String[]>] -Alias <String> -VirtualDesktopName <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.
PARAMETERS
-Alias <String>
Specifies an alias for the RemoteApp program. This alias must be unique within the collection specified by the CollectionName parameter.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection 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.
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.
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 (RDSession Host) servers in the collection. For virtual desktop collections,
this path must be a valid local path on all virtual desktops in the collection.
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.
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 (RDWebAccess) webpage and in the Start
menu for subscribed RemoteApp and Desktop Connections.
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.
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 RDSession Host servers in the
collection. For virtual desktop collections, the path must be a valid local path on all virtual desktops in the collection.
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.
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 RDWebAccess server, and in RemoteApp and Desktop Connections that the user subscribes
to.
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 RDWebAccess, and in RemoteApp and Desktop Connections. To allow
all users to see a RemoteApp program, provide a value of $Null.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Null
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294263
Get-RDRemoteApp
New-RDRemoteApp
Remove-RDRemoteApp