< Back
Set-RDFileTypeAssociation
Post
NAME Set-RDFileTypeAssociation
SYNOPSIS
Changes the file type association of a RemoteApp program in a Remote Desktop deployment.
SYNTAX
Set-RDFileTypeAssociation [-CollectionName] <String> [-ConnectionBroker <String>] [-IconIndex <String>] [-IconPath <String>] -AppAlias <String>
-FileExtension <String> -IsPublished <Boolean> [<CommonParameters>]
Set-RDFileTypeAssociation [-CollectionName] <String> [-ConnectionBroker <String>] [-IconIndex <String>] [-IconPath <String>] -AppAlias <String>
-FileExtension <String> -IsPublished <Boolean> -VirtualDesktopName <String> [<CommonParameters>]
DESCRIPTION
The Set-RDFileTypeAssocation cmdlet modifies the file type association of a firstref_server_7 RemoteApp program in a Remote Desktop deployment.
PARAMETERS
-AppAlias <String>
Specifies the alias for the RemoteApp program. The default alias is the program's file name without the extension.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CollectionName <String>
Specifies the name of the session or virtual desktop collection.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection Broker) server for this Remote Desktop deployment. Remote users connect to this
server to obtain views of available nextref_server_7 RemoteApp programs, session-based desktops, and virtual desktops. If this parameter does
not appear, the default value is the fully qualified domain name (FQDN) of the local host.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-FileExtension <String>
Specifies the file name extension of the file type whose association you change.
Required? true
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 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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-IsPublished <Boolean>
Indicates whether users can see the file type association.
Set this parameter to $True if users need to open the RemoteApp that corresponds to a file type by double-clicking a file of that type.
Set this parameter to $False if you do not want to associate files of a particular type with a RemoteApp program on end users???????? machines. For
example, if you have published Microsoft Word as a RemoteApp, but you want end users to open .docx files in local copies of Wordpad rather
than in the RemoteApp Word, set IsPublished to $False in the file type association for .docx files.
Required? true
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 whose name is in the IconPath parameter appears. This virtual desktop must
belong to the collection whose value is in 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: Set a file type association for a virtual desktop collection
PS C:\\> Set-RDFileTypeAssociation -CollectionName "Virtual Desktop Collection" -AppAlias "iexplore" -FileExtension ".html" -IsPublished $True
-VirtualDesktopName "RDS-WKS-A27"
This command sets the following options for file type association:
-- Collection named Virtual Desktop Collection.
-- Remote Desktop application alias of iexplore.
-- File name extension of .html to associate with the application.
-- Virtual desktop named RDS-WKS-A27.
-- Users can see the file name extension.
Example 2: Set a file type association for a session collection
PS C:\\> Set-RDFileTypeAssociation -CollectionName "Session Collection" -AppAlias "Notepad" -FileExtension ".txt" -IsPublished $True -IconPath
"%windir%\\System32\\Notepad.exe" -IconIndex 0
This command sets these options for file type association:
-- Collection named Session Collection.
-- Remote Desktop application alias of Notepad.
-- File name extension of .txt to associate with the application.
-- The icon for the Remote Desktop program Notepad.exe appears in the \\System32 subfolder of the Windows folder. The icon that appears for Notepad
is at the first position of the icon file.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294259
Get-RDFileTypeAssociation
SYNOPSIS
Changes the file type association of a RemoteApp program in a Remote Desktop deployment.
SYNTAX
Set-RDFileTypeAssociation [-CollectionName] <String> [-ConnectionBroker <String>] [-IconIndex <String>] [-IconPath <String>] -AppAlias <String>
-FileExtension <String> -IsPublished <Boolean> [<CommonParameters>]
Set-RDFileTypeAssociation [-CollectionName] <String> [-ConnectionBroker <String>] [-IconIndex <String>] [-IconPath <String>] -AppAlias <String>
-FileExtension <String> -IsPublished <Boolean> -VirtualDesktopName <String> [<CommonParameters>]
DESCRIPTION
The Set-RDFileTypeAssocation cmdlet modifies the file type association of a firstref_server_7 RemoteApp program in a Remote Desktop deployment.
PARAMETERS
-AppAlias <String>
Specifies the alias for the RemoteApp program. The default alias is the program's file name without the extension.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CollectionName <String>
Specifies the name of the session or virtual desktop collection.
Required? true
Position? 1
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ConnectionBroker [<String>]
Specifies the Remote Desktop Connection Broker (RDConnection Broker) server for this Remote Desktop deployment. Remote users connect to this
server to obtain views of available nextref_server_7 RemoteApp programs, session-based desktops, and virtual desktops. If this parameter does
not appear, the default value is the fully qualified domain name (FQDN) of the local host.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-FileExtension <String>
Specifies the file name extension of the file type whose association you change.
Required? true
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 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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-IsPublished <Boolean>
Indicates whether users can see the file type association.
Set this parameter to $True if users need to open the RemoteApp that corresponds to a file type by double-clicking a file of that type.
Set this parameter to $False if you do not want to associate files of a particular type with a RemoteApp program on end users???????? machines. For
example, if you have published Microsoft Word as a RemoteApp, but you want end users to open .docx files in local copies of Wordpad rather
than in the RemoteApp Word, set IsPublished to $False in the file type association for .docx files.
Required? true
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 whose name is in the IconPath parameter appears. This virtual desktop must
belong to the collection whose value is in 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: Set a file type association for a virtual desktop collection
PS C:\\> Set-RDFileTypeAssociation -CollectionName "Virtual Desktop Collection" -AppAlias "iexplore" -FileExtension ".html" -IsPublished $True
-VirtualDesktopName "RDS-WKS-A27"
This command sets the following options for file type association:
-- Collection named Virtual Desktop Collection.
-- Remote Desktop application alias of iexplore.
-- File name extension of .html to associate with the application.
-- Virtual desktop named RDS-WKS-A27.
-- Users can see the file name extension.
Example 2: Set a file type association for a session collection
PS C:\\> Set-RDFileTypeAssociation -CollectionName "Session Collection" -AppAlias "Notepad" -FileExtension ".txt" -IsPublished $True -IconPath
"%windir%\\System32\\Notepad.exe" -IconIndex 0
This command sets these options for file type association:
-- Collection named Session Collection.
-- Remote Desktop application alias of Notepad.
-- File name extension of .txt to associate with the application.
-- The icon for the Remote Desktop program Notepad.exe appears in the \\System32 subfolder of the Windows folder. The icon that appears for Notepad
is at the first position of the icon file.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294259
Get-RDFileTypeAssociation