Starting the JMSAdmin and JMS30Admin tools

The IBM® MQ JMS and Jakarta Messaging administration tools have a command-line interface that you can use either interactively, or to start a batch process.

About this task

The interactive mode provides a command prompt where you can enter administration commands. In the batch mode, the command to start the tool includes the name of a file that contains an administration command script.

Procedure

Interactive mode

  • To start the tool in interactive mode, enter the following command:
    [JMS 2.0]
    JMSAdmin [-t] [-v] [-cfg config_filename] [-sf keyfile]
    
    [Jakarta Messaging 3.0]
    JMS30Admin [-t] [-v] [-cfg config_filename] [-sf keyfile]
    
    
    where:
    -t
    Enables trace (default is trace off).
    The trace file is generated in "%MQ_JAVA_DATA_PATH%"\errors ( Windows ) or /var/mqm/trace ( AIX® and Linux® ). The name of the trace file is of the form:
    mqjms_PID.trc
    where PID is the process ID of the JVM.
    -v
    Produces verbose output (default is terse output).
    -cfg config_filename
    Names an alternative configuration file. If this parameter is omitted, the default configuration file, JMSAdmin.config (for JMS 2.0) or JMS30Admin.config (for Jakarta Messaging 3.0), is used. For more information about the configuration file, see Configuring the JMSAdmin and JMS30Admin tools.
    [MQ 10.0.0 Jun 2026]-sf: Optional
    Defines the absolute path of the file containing a user supplied key used for encrypting the token secret. A default key is used if this parameter is not specified. For more information about creating a connection factory with JWT token properties, see Using authentication tokens in an application.
    A command prompt is displayed, which indicates that the tool is ready to accept administration commands. This prompt initially appears as:
    InitCtx>
    
    indicating that the current context (that is, the JNDI context to which all naming and directory operations currently refer) is the initial context defined in the PROVIDER_URL configuration parameter. For more information about this parameter, see Configuring the JMSAdmin and JMS30Admin tools.

    As you traverse the directory namespace, the prompt changes to reflect this, so that the prompt always displays the current context.

Batch mode

  • To start the tool in batch mode, enter the following command:
    [JMS 2.0]
    JMSAdmin < test.scp
    
    [Jakarta Messaging 3.0]
    JMS30Admin < test.scp
    
    where test.scp is a script file that contains administration commands. For more information, see Using administration commands with JMSAdmin and JMS30Admin. The last command in the file must be the END command.