BrokerAdmin

BrokerAdmin APIs provide administrative access to Brokers on a Director. They are listed in the following table:

Method

Method Type

Description

service-discriminator

POST

Adds the service discriminator.

service-discriminator

DELETE

Deletes the Service Discriminator.

all-broker-info

GET

Retrieves information about all Brokers logged in to the Director.

broker-count

GET

Retrieves the total number of Brokers logged in to the Director.

broker-info

GET

Retrieves information about a given Broker.

engine-router

GET

Retrieves the Engine Router assigned to this Broker.

service-discriminator

GET

Retrieves the PropertyConditionSet used by the Service Discriminator.

service-discriminator-names

GET

Retrieves the names of all Service Discriminators.

shared-brokers

GET

Retrieves Broker sharing.

available

GET

Retrieves whether the methods are available.

driver-weight

PUT

Sets the Driver distribution weighing relative to other Brokers.

engine-router

POST

Sets an Engine router for a given Broker.

engine-weight

PUT

Sets the Engine distribution weighting relative to other Brokers.

maximum-engines

PUT

Sets the maximum number of Engines the Broker can manage.

min-idle-home-engines

PUT

Sets the minimum number of Idle Home Machines that the Broker is left to manage.

minimum-engines

PUT

Sets the minimum number of Engines the Broker is left to manage.

shared-brokers

PUT

Sets the Broker sharing.