Citrix Virtual Apps and Desktops SDK

Export-BrokerConfiguration

August 9, 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>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Examples

Parameters

-TargetBrokerVersion

The version of the broker receiving the configuration

Type:	Version
Position:	Named
Default value:	$null
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExistingImportScriptId

The Id of the script the caller already has; a new script will be returned in the XML document if different.

Type:	String
Position:	Named
Default value:	$null
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-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.

Type:	String
Position:	Named
Default value:	$null
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

This cmdlet does not accept input

Outputs

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

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Export-BrokerConfiguration

Syntax

Examples

Parameters

-TargetBrokerVersion

-ExistingImportScriptId

-ExistingConfigLastChangeTime

CitrixCommonParameters

CommonParameters

Inputs

This cmdlet does not accept input

Outputs

String

Related Links

In this article