Get-BrokerServiceStatus

Last published : Oct 31, 2026
Gets the current status of the Broker Service on the controller.
Related information
about_Broker_AccessPolicy

Syntax

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

Description

Enables the status of the Broker Service on the controller to be determined. If the service has multiple data stores it will return the overall state as an aggregate of all the data store states. For example, if the site data store status is OK and the secondary data store status is DBUnconfigured then it will return DBUnconfigured.
Before using this cmdlet, you don't have to configure the database connection for the Service.

Examples

EXAMPLE 1

Get the current status of the Broker Service.
Get-BrokerServiceStatus

ServiceStatus  ExtraInfo
-------------- ---------
DBUnconfigured {...}

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 can't pipe objects to this cmdlet.

Outputs

Citrix.Fma.Sdk.Utilities.Service.ServiceStatusInfo

The Get-BrokerServiceStatus cmdlet returns an object containing the status of the Broker Service together with extra diagnostics information.
  • DBUnconfigured
    The Broker Service does not have a database connection configured.
  • DBRejectedConnection
    The database rejected the logon attempt from the Broker Service. This may be because the service attempted to log on with invalid credentials or because a database has not been installed in the specified location.
  • InvalidDBConfigured
    The expected stored procedures are missing from the database. This may be because the Broker Service schema has not been added to the database.
  • DBNotFound
    The specified database could not be located with the configured connection string.
  • DBMissingOptionalFeature
    The Broker is connected to a database that is valid, but it does not have the full functionality required for optimal performance. Upgrading the database is advisable.
  • DBMissingMandatoryFeature
    The Broker is connected to a database that is valid, but it does not have the full functionality required so the Broker cannot function. Upgrading the database is required.
  • DBNewerVersionThanService
    The version of the Broker Service currently in use is incompatible with the version of the Broker Service schema on the database. Upgrade the Broker Service to a more recent version.
  • DBOlderVersionThanService
    The version of the Broker Service schema on the database is incompatible with the version of the Broker Service currently in use. Upgrade the database schema to a more recent version.
  • DBVersionChangeInProgress
    A database schema upgrade is currently in progress.
  • OK
    The Broker Service is running and is connected to a database containing a valid schema.
  • PendingFailure
    Connectivity between the Broker Service and the database has been lost. This may be a transitory network error, but may indicate a loss of connectivity that requires administrator intervention.
  • Failed
    Connectivity between the Broker and the database has been lost for an extended period of time, or has failed due to a configuration problem. The Broker service cannot operate while its connection to the database is unavailable.
  • Unknown
    The service status cannot be determined.

Notes

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