Citrix Virtual Apps and Desktops SDK

Get-Brokerdbconnection

August 3, 2023

Contributed by:

Gets the database connection string for the specified data store used by the Broker Service.

Syntax

Get-BrokerDBConnection [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Gets the database connection string from the currently selected Broker Service instance.

If the returned string is blank, no valid connection string has been specified. In this case the service is running, but is idle and awaiting specification of a valid connection string.

The current service instance is the one on the local machine, or the one most recently specified using the -AdminAddress parameter of a Broker SDK cmdlet.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
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
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

None

You cannot pipe input into this cmdlet.

Return Values

System.String

The database connection string configured for the current Broker Service instance.

Notes

If the command fails, the following errors can be returned.
Error Codes
———–
NoDBConnections
The database connection string for the Broker Service has not been specified.
PermissionDenied
You do not have permission to execute this command.
AuthorizationError
There was a problem communicating with the Citrix Delegated Administration Service.
CommunicationError
There was a problem communicating with the remote service.
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs on the controller or the XenDesktop logs.

Examples

Example 1

C:\PS> Get-BrokerDBConnection -AdminAddress controller1.mydomain.net
<!--NeedCopy-->

Description

Gets the database connection string in use by the Broker Service instance running on controller “controller1.mydomain.net”.

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

Get-Brokerdbconnection

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Get-Brokerdbconnection

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

System.String

Notes

Examples

Example 1

Description

In this article