Citrix Virtual Apps and Desktops SDK

Export-BrokerConfiguration

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

Export-BrokerConfiguration