Get-BrokerDBConnection

Last published : Oct 31, 2026
Returns the database connection string for the specified data store used by the Broker Service.
Related information
about_Broker_AccessPolicy

Syntax

Get-BrokerDBConnection
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

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

Examples

EXAMPLE 1

Gets the database connection string in use by the Broker Service instance running on controller "controller1.mydomain.net".
Get-BrokerDBConnection -AdminAddress controller1.mydomain.net
Server=serverName\SQLEXPRESS;Initial Catalog=databaseName;Integrated Security=True

Parameters

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

None

You cannot pipe input into this cmdlet.

Outputs

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

Notes

If the command fails, the following errors can be returned:
  • NoDBConnections
    The database connection string for the BrokerService 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 Citrix Virtual Apps and Desktops logs.