Broker 10.5 | webMethods Broker Documentation | Administering webMethods Broker | webMethods Broker Command-Line Utilities | Broker Utilities | broker_ping
broker_ping Return Codes
Use broker_ping to send system ping documents through a Broker. If the document passes through the Broker Server and returns to broker_ping, a positive message is printed. By default, one document is sent. If no document returns, a negative message is printed.
broker_ping [-h] [-s] [-c count] [-remote [/territory/]broker2]
[[--] [broker@]host[:port]] [-idhelp] [id_options] [-timeout timeout]
The broker_ping command uses the following arguments:
Displays a usage message.
Sends a document through the Broker Server once every second.
-c count
Specifies the number of documents that are sent through the Broker.
-remote [/territory/]broker2
Pings a specified Broker in a specified territory.
Allows the Broker name to start with the character -.
Specifies the name of the Broker Server (and, optionally, the Broker or port) you want to ping. If you omit the Broker name, the default Broker is assumed.
Displays a usage message for the [id_options] listed below.
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.
-keystore filename specifies the name of the file containing the user SSL certificate.
-password password specifies the password for the keystore file.
-truststore filename specifies the name of the file containing the trusted root of the user SSL certificate.
-noencrypt specifies to not use encryption for the connection. By default, every connection using a certificate is encrypted.
-basicauthuser username specifies the user name for basic authentication. If you specify -basicauthuser, you must also specify -basicauthpassword.
-basicauthpassword password specifies the password for the basic authentication user. If you specify -basicauthpassword, you must also specify -basicauthuser.
[-timeout timeout]
Specifies the timeout time in seconds for the API calls made by the broker_ping 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_ping utility.
Pinging a Remote Broker
You can use the broker_ping utility to ping a remote Broker in the same territory or in a territory that is connected by a territory gateway. The ping document passes through the local Broker to the remote Broker, allowing you to trace the connection between Brokers. For example, assume that you want to trace the connection between local Broker Alpha on the host atlas and remote Broker Beta in the same territory. The command is:
broker_ping -remote Beta Alpha@atlas
To ping the Broker Gamma, which is in the territory T-2, across a territory gateway, the command is:
broker_ping -remote /T-2/Gamma Alpha@atlas
To use broker_ping across a territory gateway, the document type Broker::Ping must be shared across the gateway.