Product Documentation

Get-BrokerServiceStatus

Oct 12, 2015

Determines the current state of the Broker Service on the controller.

Syntax

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

Detailed Description

This command provides the ability for the status of the Broker Service in the controller to be determined. Before using this command, you don't have to configure the database connection to the Service.

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

Get-BrokerServiceStatus returns a string describing the status of the Broker Service.

DBUnconfigured

The broker does not have a database connection configured.

DBRejectedConnection

The database rejected the logon from the Broker Service. This may be caused by bad credentials, or the database not being installed.

InvalidDBConfigured

The database schema is missing (possibly just the stored procedures in it).

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 broker is too old to use the database. A newer version is required.

DBOlderVersionThanService

The database is too old for the Broker Service. Upgrade the database.

DBVersionChangeInProgress

A database schema upgrade is in progress.

OK

The broker is connected to a database that is valid, and the service is running.

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's status cannot be determined.

Examples

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

C:\PS> Get-BrokerServiceStatus

Get the current status of the Service.