Product Documentation

Get-BrokerDBConnection

Sep 29, 2015

Gets the Citrix Broker Service's database connection string.

Syntax

Get-BrokerDBConnection [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Gets the database connection string from the currently selected Citrix 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 that on the local machine, or that explicitly specified by the last usage of the -AdminAddress parameter to a Broker SDK cmdlet.

Parameters

-AdminAddress<String>

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.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value will become the default.
Accept Pipeline Input? false

Input Type

None You cannot pipe input into this cmdlet.

Return Values

System.String

The database connection string in use by the currently selected Citrix Broker Service instance.

Examples

-------------------------- EXAMPLE 1 --------------------------

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

Gets the database connection string in use by the Citrix Broker Service instance running on the controller with FQDN "controller1.mydomain.net".