Version 9.6
 —  System Management Hub  —

The System Management Hub Batch Interface

The System Management Hub supports a batch interface called argbatch, which can be used to create and run broker-specific routine jobs, for example, to list brokers, servers, and services and to start and stop broker. Help is provided in the batch interface. See the sections on the batch interface in the separate System Management Hub documentation for more information.

This document provides a short introduction to the System Management Hub batch interface to get you started. It covers the following topics:


Setting the argbatch Environment

Most of the argbatch commands require that you provide your user ID and password. To avoid typing your user ID and password for each command, we recommend that you first use the argbatch set environment command to set your user ID and password. Settings exceed session lifetime and are valid for the current user until they are overwritten with new values in a new argbatch set environment command, or until they are cleaned with the command

argbatch clear environment

Start of instruction setTo set the environment

Define the product for your argbatch session with the command

argbatch set environment product="webMethods EntireX 9.6"

It is also possible to set the product version for the argbatch session, but this should be handled with care and only be done if necessary, observing the following rules:

Start of instruction setTo define the product and, if necessary, the product version

  1. Display a list of available products by entering the command

    argbatch show products

    A list of available products will be displayed, among them the product webMethods EntireX 9.6.

  2. Display a list of available versions by entering the command

    argbatch show versions product="webMethods EntireX 9.6"

    All installed versions of webMethods EntireX 9.6 will be displayed.

    If the product and version of the product you are using are not listed, set the environment to the product "webMethods EntireX 9.6" and the version you are using, e.g. version 9.6

    argbatch set environment product="webMethods EntireX 9.6" version=9.6

Top of page

Description of argbatch Commands

This section covers the following topics:

Displaying Information about Commands

Start of instruction setTo display a list of available EntireX argbatch commands

Start of instruction setTo display detailed online information on how to use a command

EntireX Broker - Root

Commands for manipulating the list of brokers.

Batch Command Description
show brokers Displays the list of available brokers.
create localbroker brokerName=<broker name> tcpPort=<port> sslPort=<port> Creates a local broker. Enter the corresponding port parameters, depending on the chosen transport method. Do not enter "Transport=[TCP|SSL|TCP-SSL]" as in earlier versions; this is now generated automatically in the broker's attribute file.
add remotebroker brokerName=<broker name> brokerId=<broker ID> Creates a definition of a remote broker. The value of broker ID should be equal to the URL on which the broker can be found (see note 1).
delete broker broker=<broker name> Deletes a local broker or removes the definition of a remote broker.

EntireX Broker - Admin

Administrative commands for a broker.

Batch Command Description
show brokerstatus broker=<broker name> Displays the status information of a broker.
show brokercommands broker=<broker name> Displays a list with all administrative batch commands which can be executed over a broker.
start broker broker=<broker name> Starts a local broker.
stop broker broker=<broker name> Stops a local broker.
restart broker broker=<broker name> Stops and restarts a running local broker. In case of an already stopped broker, this command has the same effect as start broker broker=<broker name>.
set credentials broker=<broker name> userName=<user name> userPassword=<user password> Sets the user credentials for a broker. If no value is specified for userName, credentials are cleared.
set credentialssnmp broker=<broker name> userName=<user name> userPassword=<user password> Sets the credentials needed to monitor a broker via the SNMP administrative interface. If no value is specified for userName, credentials are cleared (see note 2).
set brokertrace broker=<broker name> level=[off|1|2|3|4] Sets the trace level of a broker.
set newuows broker=<broker name> allowed=[yes|no] Allows or forbids a broker to receive new UOW messages.
set pstore broker=<broker name> connected=[yes|no] Connects or disconnects a broker to/from its persistent store.
set autostart broker=<broker name> autostart=[yes|no] Enables or disables the automatic start of a broker when the operating system is booted.
set sslparameters broker=<broker name> sslParameters=<SSL parameters> Sets the SSL parameters of a broker. This parameter cannot be left unspecified.

EntireX Broker - Service

Command-line utilities for accessing CIS. See Command-line Utilities.

Batch Command Description
show brokerservices broker=<broker name> Displays a list of Command and Information Services available to a broker.
show broker broker=<broker name> Displays information from the Broker Information Services (IS), see BROKER-OBJECT in the Broker CIS Data Structures documentation.
show workers broker=<broker name> Displays information from the Worker IS, see WORKER-OBJECT.
show services broker=<broker name> Displays information from the Service IS, see SERVICE-OBJECT.
show servers broker=<broker name> Displays information from the Server IS, see CLIENT-SERVER-PARTICIPANT-OBJECT.
show clients broker=<broker name> Displays information from the Client IS, see CLIENT-SERVER-PARTICIPANT-OBJECT.
show participants broker=<broker name> Displays information from the Participant IS, see CLIENT-SERVER-PARTICIPANT-OBJECT.
show conversations broker=<broker name> Displays information from the Conversation IS, see CONVERSATION-OBJECT.
show security broker=<broker name> Displays information from the Security IS, see SECURITY-OBJECT.
show tcp broker=<broker name> Displays information from the TCP IS, see TCP-OBJECT.
show ssl broker=<broker name> Displays information from the SSL IS, see SSL-OBJECT.
show network broker=<broker name> Displays information from the Net-Work IS, see NET-OBJECT.
deregister service broker=<broker name> class=<class> server=<server> service=<service> option=[immed|quiesce] Shuts down all servers registered as <class>/<server>/<service> on a broker.
shutdown server broker=<broker name> class=<class> server=<server> service=<service> puid=<physical user ID> option=[immed|quiesce] Shuts down a server registered on a broker. Use the hexadecimal internal physical user ID as a value for puid. This guarantees successful results. In many cases, the translated physical user ID can be used with success, too (see note 3).
set securitytrace broker=<broker name> level=[off|1|2|3|4] Sets the trace level for the security of a broker.

Java Message Service

Commands specific to EntireX MSP.

Batch Command Description
show jmsproperties Displays general settings for webMethods EntireX MSP.
show jmsqueueconnectionfactory Displays the list of queue connection factories.
show jmsqueue Displays the list of queues.
show jmstopicconnectionfactory Displays the list of topic connection factories.
show jmstopic Displays the list of topics.

RPC Server

Commands specific to RPC servers.

Batch Command Description
show rpcserverlist Displays the list of available RPC servers.
show rpcserver name=<rpc server name> Displays detailed information on a particular RPC server.
start rpcserver name=<rpc server name> Starts an RPC server (see note 4).
stop rpcserver name=<rpc server name> Stops an RPC server (see note 4).

Technical Information

Commands providing technical information.

Batch Command Description
show technicalinformation Displays general technical information about the product.
show versioninformation Displays the version of each file which is included in the product.
show windowssettinginformation Displays the Windows environment of the product.
show exxenvinformation Displays the SMH environment of the product.
show javainformation Displays the Java environment of the product.
show licenseinformation Displays the information contained in the license file.

Notes

  1. A Broker ID can be given in two different formats:

    See Using the Broker ID in Applications.

  2. See SNMP Support for EntireX.

  3. The hexadecimal internal physical user ID is the 56-character string which is shown as the value of the property Internal ID in the server's detailed information. The translated physical user ID is the 28-character string which is shown as the value of the property Internal ID Char in the server's detailed information. See the fields P-USER-ID and P-USER-ID-CHAR in CLIENT-SERVER-PARTICIPANT-OBJECT.

  4. Only local RPC servers can be started or stopped with this command. Attempts to start and stop remote RPC servers will fail.

Top of page

argbatch Command Examples

This section provides examples of the argbatch command.

Start of instruction setTo list the brokers configured for EntireX

Start of instruction setTo start a broker

Note:
Each batch command consists of two words. Enter these in the exact order at the beginning of the command. The available parameters can be entered in any order.

Top of page