Gets the database connection string for the specified data store used by the Broker Service.
Get-BrokerDBConnection [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
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.
|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|
You cannot pipe input into this cmdlet.
The database connection string configured for the current Broker Service instance.
If the command fails, the following errors can be returned.
The database connection string for the Broker Service has not been specified.
You do not have permission to execute this command.
There was a problem communicating with the Citrix Delegated Administration Service.
There was a problem communicating with the remote service.
An unexpected error occurred. For more details, see the Windows event logs on the controller or the XenDesktop logs.
C:\PS> Get-BrokerDBConnection -AdminAddress controller1.mydomain.net
Gets the database connection string in use by the Broker Service instance running on controller "controller1.mydomain.net".