Managing the List of Brokers with SMH

See also Administration Service Messages.


Creating a Local Broker

Start of instruction setTo create a local broker

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. From the context menu, choose Create Local Broker.

  3. Enter Broker ID, TCP Port Number, and SSL Port Number. The valid port number range is 1024 - 65535.

  4. Select a transport method.

  5. Choose OK.

    create local broker

When a local broker is added using SMH, a working directory is created for the new broker in the EntireX directory config/etb. This directory contains an attribute file, and the SSL certificates from the EntireX directory config/etb are also copied to this directory. If the broker is to use its own SSL certificates, these must be replaced or the attribute file modified accordingly.

The attributes of the new broker are checked. If, for example, a broker already exists with the specified port, a corresponding error message is given.

Deleting a Local Broker

Start of instruction setTo delete a local broker

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Select the broker name to be deleted.

  3. From the context menu, choose Delete Broker.

  4. Choose OK.

graphics/brokerSmh-list_deleteLocal.png

Adding a Remote Broker Instance to System Management Hub

Start of instruction setTo add a remote broker instance to System Management Hub

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. From the context menu, choose Add Remote Broker.

  3. In the field Broker Name, enter a valid name. Permitted characters are A-Z, a-z, 0-9.

  4. In the field Broker ID, enter the ID of an existing broker. Permitted formats: host:port[:protocol], protocol://host:port[?sslparameters].

  5. Choose OK.

graphics/brokerSmh-list_addRemote.png

Function Add Remote Broker creates a directory for a remote broker. The working directories for a remote broker start with "RB". This directory contains an attribute file with the URL of the remote broker. This directory will also be used for transferring the log and attribute files to or from the remote broker. If the broker can only be addressed using the SSL protocol, the SSL certificates should also be stored in this directory. When a remote broker is added, the default SSL certificates from the EntireX config/etb directory are copied to the working directory of the remote broker. If this broker is to use other certificates, replace them manually.

Removing a Remote Broker Instance from System Management Hub

Start of instruction setTo remove a remote broker instance from System Management Hub

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Select the remote broker instance to be removed.

  3. From the context menu, choose Remove Definition.

  4. Choose OK.

graphics/brokerSmh-list_removeRemote.png

Stopping All Local Brokers from System Management Hub

Start of instruction setTo stop all local brokers from System Management Hub

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. From the context menu, choose Stop All Brokers.

  3. Choose the stop mode.

  4. Choose OK to confirm deregistration.

graphics/brokerSmh-list_stopAllLocal.png

Setting the User Credentials for a Broker Instance

Before a remote broker instance or instance of a local broker that uses LDAP authentication can be administered, user credentials (user ID and password) must be set.

Start of instruction setTo set user credentials

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Select the broker instance.

  3. From the context menu, choose Set User Credentials.

  4. Enter a User ID and Password that are valid for the broker instance.

  5. Choose OK.

  6. Choose OK when the success message is displayed.

    graphics/brokerSmh-list_setCredentials.png

Clearing the User Credentials for a Broker Instance

Once a remote broker instance has been administered, the user credentials should be cleared.

Start of instruction setTo clear user credentials

  1. Select the EntireX Broker node below the EntireX node in System Management.

  2. Select the broker instance.

  3. From the context menu, choose Clear User Credentials. A confirmation screen will appear.

  4. Choose OK or Cancel.

  5. Choose OK when the success message is displayed.

Setting SSL/TLS Parameters

Start of instruction setTo edit a broker SSL file

  1. Select the EntireX Broker node below the webMethods EntireX node in System Management Hub.

  2. Select the broker name to be administered.

  3. Choose SSL Parameters.

  4. Make your changes.

  5. Choose Save.

graphics/brokerSmh-list_setSslParms.png