-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
Get-BrokerImportedFTA
-
-
-
-
-
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-BrokerImportedFTA
Gets the imported file type associations.
Syntax
Get-BrokerImportedFTA
[[-ExtensionName] <String>]
[-ContentType <String>]
[-Description <String>]
[-DesktopGroupUid <Int32>]
[-Edit <String>]
[-EditArguments <String>]
[-EditExecutableName <String>]
[-HandlerName <String>]
[-Open <String>]
[-OpenArguments <String>]
[-OpenExecutableName <String>]
[-PerceivedType <String>]
[-Print <String>]
[-PrintTo <String>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Get-BrokerImportedFTA
[-Uid] <Int32>
[-Property <String[]>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Returns the file type associations the system imports from worker machines.
File type association associates a file extension (such as “.txt”) with an application (such as Notepad). In a Citrix environment file type associations on a user device can be configured so that when an user clicks on a document it launches the appropriate published application. This is known as “content redirection”.
Imported file type associations are different from configured file type associations. Imported file type associations are lists of known file type associations for a given desktop group. Configured file type associations are those that are actually associated with published applications for the purposes of content redirection.
Initially the system is not aware of any extensions, and they must be imported by the Citrix administrator. See the Update-BrokerImportedFTA cmdlet for more information.
After file type extensions are imported, this cmdlet lets the administrator review which file type associations the system is aware of. ImportedFTA objects are also used when configuring content redirection. See the New-BrokerConfiguredFTA cmdlet for more information.
The imported file type associations are grouped according to the desktop group to which they belong, because the system expects all machines in the same desktop group to have the same file type associations. That may not be true, however, across desktop groups.
Note that the ImportedFTA object has several fields that are not currently used. Only those fields that are shared with the ConfiguredFTA object are actually used in some capacity.
————————– BrokerImportedFTA Object
The BrokerImportedFTA object represents a file type association imported from worker machines. It contains the following properties:
-
ContentType (System.String)
Content type of the file, such as “text/plain” or “application/vnd.ms-excel”.
-
Description (System.String)
File type description, such as “Test Document”, “Microsoft Word Text Document”, etc.
-
DesktopGroupUid (System.Int32)
The desktop group this file type belongs to.
-
Edit (System.String)
Edit command with full path to executable: “C:\Program Files (x86)\Microsoft Office\Office12\WINWORD.EXE” /n /dde
-
EditArguments (System.String)
The arguments used for the ‘edit’ action on files of this type. These are extracted from the full edit command, and may be empty.
-
EditExecutableName (System.String)
The executable name extracted from the Edit property, no path included. This is used for matching with published apps’ executable when searching for the list of extensions an application is capable of handling.
-
ExtensionName (System.String)
A single file extension, such as .txt. Unique within the scope of a desktop group.
-
HandlerName (System.String)
File type handler name, e.g. “Word.Document.8” or TXTFILE.
-
Open (System.String)
Open command with full path to executable: “C:\Program Files (x86)\Microsoft Office\Office12\WINWORD.EXE” /n /dde
-
OpenArguments (System.String)
The arguments used for the ‘open’ action on files of this type. These are extracted from the full open command, and may be empty.
-
OpenExecutableName (System.String)
The executable name extracted from the Open property, no path included. This is used for matching with published apps’ executable when searching for the list of extensions an application is capable of handling.
-
PerceivedType (System.String)
Perceived type, such as “text”.
-
Print (System.String)
Print command: “C:\Program Files (x86)\Microsoft Office\Office12\WINWORD.EXE” /x /n /dde
-
PrintTo (System.String)
PrintTo command: “C:\Program Files (x86)\Microsoft Office\Office12\WINWORD.EXE” /n /dde
-
Uid (System.Int32)
Unique internal identifier of imported file type association.
Examples
EXAMPLE 1
Invoking this cmdlet with no arguments simply returns
all of the imported file type association objects. By default, only
the first 250 objects are returned. See the -MaxRecordCount and
-Skip parameters for information about modifying this.
Get-BrokerImportedFTA
<!--NeedCopy-->
EXAMPLE 2
Retrieves all imported file type associations that have
the extension “.txt”. Note that because imported file type associations
are per-desktop group, multiple instances may be returned.
Get-BrokerImportedFTA -ExtensionName ".txt"
<!--NeedCopy-->
Parameters
-Uid
Gets only the imported file type associations with the
specified unique identifier.
| Type: | Int32 |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExtensionName
Gets only the imported file type associations with the
specified extension name. For example, “.txt” or “.png”.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ContentType
Gets only the imported file type associations with the
specified content type (as listed in the Registry). For example,
“application/msword”.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Description
Gets only the imported file type associations with the
specified description (as listed in the Registry). For example,
“Text Document” or “Microsoft Word text document”.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-DesktopGroupUid
Gets only the file type associations imported from a
worker machine belonging to the specified desktop group.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Edit
Gets only the imported file type associations with the
specified Edit command, that includes both the executable name and path,
and any arguments to that executable.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-EditArguments
Gets only the imported file type associations with the
specified arguments to the Edit command.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-EditExecutableName
Gets only the imported file type associations with the
specified executable for the Edit command.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-HandlerName
Gets only the imported file type associations with the
specified handler name (as listed in the Registry). For example,
“TXTFILE” or “Word.Document.8”.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Open
Gets only the imported file type associations with the
specified Open command, that includes both the executable name and path,
and any arguments to that executable.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-OpenArguments
Gets only the imported file type associations with the
specified arguments to the Open command.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-OpenExecutableName
Gets only the imported file type associations with the
specified executable for the Open command.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-PerceivedType
Gets only the imported file type associations with the
specified perceived type (as listed in the Registry). For example,
“document”.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
Gets only the imported file type associations with the
specified Print command.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-PrintTo
Gets only the imported file type associations with the
specified PrintTo command.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ReturnTotalRecordCount
When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxRecordCount
Specifies the maximum number of records to return.
| Type: | Int32 |
| Position: | Named |
| Default value: | 250 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SortBy
Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.
| Type: | String |
| Position: | Named |
| Default value: | The default sort order is by name or unique identifier. |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterScope
Gets only results allowed by the specified scope id.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2106 |
-Property
Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
This cmdlet does not accept any input from the pipeline.
Outputs
Citrix.Broker.Admin.SDK.ImportedFTA
One or more ImportedFTA objects are returned as output.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.