Developer Documentation
Citrix Virtual Apps and Desktops 2411 SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Update-BrokerImportedFTA

December 4, 2024
Contributed by: 
C

Imports or updates all of the file type associations for the

specified worker.

Syntax

Update-BrokerImportedFTA
      -DesktopUids <Int32[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Imports or updates the file type associations from a specified worker machine.

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. To import or update file type associations from a worker machine, two criteria must be met:

  • The worker machine must not be in use
  • The worker machine must be in maintenance mode

For more information about putting a worker machine in maintenance mode, see the Set-BrokerPrivateDesktop and Set-BrokerSharedDesktop cmdlets.

Imported file type associations are grouped together based on the desktop group of the machine from which they were imported. All file types for a desktop group are deleted. There is no mechanism for deleting a subset imported file type associations for a specific desktop group.

If file type associations are imported more than once for a desktop group, for example, if this cmdlet is run twice for two workers belonging to the same desktop group, all existing imported file type associations for that desktop group are deleted and imported again.

Examples

EXAMPLE 1

Gets an object for the worker machine named

“Worker1” in the “ACME” domain, and ensures no users can

connect to it, before importing the file type associations from that

desktop and re-enabling it.

$desktop = Get-BrokerSharedDesktop -MachineName "ACME\Worker1"
Set-BrokerSharedDesktop $desktop -InMaintenanceMode $true
Update-BrokerImportedFTA -DesktopUids $desktop.Uid
Set-BrokerSharedDesktop $desktop -InMaintenanceMode $false
<!--NeedCopy-->

Parameters

-DesktopUids

Imports or updates the file type associations from the

specified desktop. The desktop must belong to a desktop group of the

Private or Shared desktop kind.

Type: Int32[]
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
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

Int32[]

An array of Uids for desktops can be supplied as input.

Outputs

None

By default, this cmdlet returns no output.

Update-BrokerImportedFTA
December 4, 2024
Contributed by: 
C
December 4, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.