Citrix Virtual Apps and Desktops SDK

Export-BrokerConfiguration

March 11, 2024

Contributed by:

Obtains an XML document containing the configuration of the broker and optionally a script to import it into another broker

Syntax

Export-BrokerConfiguration [-TargetBrokerVersion <Version>] [-ExistingImportScriptId <String>] [-ExistingConfigLastChangeTime <String>] [-AdminAddress <String>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Parameters

Name	Description	Required?	Pipeline Input	Default Value
TargetBrokerVersion	The version of the broker receiving the configuration	false	false	$null
ExistingImportScriptId	The Id of the script the caller already has; a new script will be returned in the XML document if different.	false	false	$null
ExistingConfigLastChangeTime	The value of ConfigLastChangeTime in the site object of any configuration already held by the caller. If nothing has changed, an empty configuration will be returned with the “Updated” attribute set to false.	false	false	$null
AdminAddress	Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Internal use only.	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false

Input Type

This Cmdlet Does Not Accept Input

Return Values

String

The XML document

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Export-BrokerConfiguration

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Export-BrokerConfiguration

Syntax

Detailed Description

Related Commands

Parameters

Input Type

This Cmdlet Does Not Accept Input

Return Values

String

In this article