Broker 10.15 | webMethods Broker Documentation | Administering webMethods Broker | webMethods Broker Command-Line Utilities | Broker Utilities | broker_update
 
broker_update
You use the broker_update utility, which resides at webMethods Broker_directory /bin, to update the Broker configuration based on the subcommands. On successful update, success code 0 is returned. For specific return codes, check for individual subcommand exit codes. This utility provides the following subcommands:
Syntax
broker_update subcommand [options ...]
Subcommand
Description
See...
remotebrokerhostname
Updates the hostname for the particular remote broker.
Options
The broker_update utility has the following options:
Syntax
broker_update subcommand [-h] [-?] [-idhelp] [id_options] [[-timeout timeout]
Argument
Description
-h
Displays a usage message.
-?
Displays the usage help for Java command-line options.
-idhelp
Displays a usage message for the [id_options].
[id_options]
Provides identification needed for administrative access to the Broker if the Broker is protected by an Access Control List (ACL).
*-entrust. Uses entrust as the SSL provider. Default is JSSE.
*-keystorefilename. Specifies the name of the file containing the user SSL certificate.
*-passwordpassword. Specifies the password for the keystore file.
*-truststorefilename. Specifies the name of the file containing the trusted root of the user SSL certificate.
*-noencrypt. Specifies not to use encryption for the connection. By default, every connection using a certificate is encrypted.
*-basicauthuserusername. Specifies the user name for the basic authentication. If you specify -basicauthuser, you must also specify -basicauthpassword.
*-basicauthpasswordpassword. Specifies the password for the basic authentication user. If you specify -basicauthpassword, you must also specify -basicauthuser.
[-timeout timeout]
Specifies the timeout duration in seconds for the API calls made by the broker_update utility. If any of these API calls to the Broker Server do not complete before the specified time, a time-out exception is thrown by the broker_update utility.
broker_update remotebrokerhostname
Updates the hostname for the particular remote broker. If the remote Broker is found in the Broker's territory, cluster or gateway, its corresponding hostname is changed to the new hostname, and persisted to storage. The port number remains unaffected in this operation.
Syntax
broker_update remotebrokerhostname
-broker [broker@]server[:port]
-remote remotebrokername
-hostname newhostname
Argument
Description
-broker [broker@]server[:port]
Specifies the name of the webMethods Broker (and optionally, the Broker and the port number) where the update needs to be performed.
If you omit the Broker name or port, default Broker and port is used.
-remote remotebrokername
Name of the remote Broker whose hostname needs to be updated.
-hostname newhostname
New hostname for the above remote Broker.
Example
The following example updates the hostname of the remote Broker broker2 in broker1:
broker_update.exe remotebrokerhostname -broker broker1@localhost:6849 -remote broker2 -hostname new_hostname