Skip to content


Gets the service instance entries for the Broker Service.


Get-BrokerServiceInstance [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]

Detailed Description

Returns service interfaces published by instances of the Broker Service. Each instance of a service publishes multiple interfaces with distinct interface types, and each of these interfaces is represented as a ServiceInstance object. Service instances can be used to register the service with a central configuration service so that other services can use the functionality.

You do not need to configure a database connection to use this command.


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

Return Values


The Get-BrokerServiceInstance command returns an object containing the following properties.
ServiceGroupUid <Guid>
    Specifies the unique identifier for the service group of which the service is a member.
ServiceGroupName <String>
    Specifies the name of the service group of which the service is a member.
ServiceInstanceUID <Guid>
    Specifies the unique identifier for registered service instances, which are service instances held by and obtained from a central configuration service.  Unregistered service instances do not have unique identifiers.
ServiceType <String>
    Specifies the service instance type.  For this service, the service instance type is always Broker.
    Specifies the address of the service instance.  The address can be used to access the service and, when registered in the central configuration service, can be used by other services to access the service.
    Specifies the binding type that must be used to communicate with the service instance.  In this release of XenDesktop, the binding type is always 'wcf_HTTP_kerb'. This indicates that the service provides a Windows Communication Foundation endpoint that uses HTTP binding with integrated authentication.
    Specifies the version of the service instance.  The version number is used to ensure that the correct versions of the services are used for communications.
ServiceAccount <String>
    Specifies the Active Directory account name for the machine on which the service instance is running.  The account name is used to provide information about the permissions required for interservice communications.
ServiceAccountSid <String>
    Specifies the Active Directory account security identifier for the machine on which the service instance is running.
InterfaceType <String>
    Specifies the interface type.  Each service can provide multiple service instances, each for a different purpose, and the interface defines the purpose.  Available interfaces are:
        SDK - for PowerShell operations
        InterService - for operations between different services
        Peer - for communications between services of the same type
Metadata <Citrix.Broker.Sdk.Metadata[]>
     The collection of metadata associated with registered service instances, which are service instances held by and obtained from a central configuration service.  Metadata is not stored for unregistered service instances.


If the command fails, the following errors can be returned.
Error Codes
An error occurred in the service while attempting a database operation.
The operation could not be completed because the database for the service is not configured.
An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
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.


Example 1



Get all instances of the Broker Service running on the specified machine. For remote services, use the AdminAddress parameter to define the service for which the interfaces are required. If the AdminAddress parameter has not been specified for the runspace, service instances running on the local machine are returned.

Was this article helpful?