5.2.2 List of commands of command utility

This subsection lists and describes the commands of the command utility as per the managed items. Note that when the status of the CJMSP broker is SHUTDOWN_COMPLETE (status where termination process is completed), these commands do not operate normally.

Organization of this subsection
(1) CJMSP Broker management
(2) Connection service management
(3) Physical destination management
(4) Persistence subscriber management
(5) Common options of command utility

(1) CJMSP Broker management

Table 5-2 List of commands used in the CJMSP Broker management

Command nameDescription
cjmsicmd list bkrLists and displays the status of CJMSP Broker.
cjmsicmd pause bkrTemporarily stops the running CJMSP Broker.
cjmsicmd query bkrLists and displays the property value of CJMSP Broker.
cjmsicmd resume bkrResumes CJMSP Broker.
cjmsicmd shutdown bkrStops CJMSP Broker.

(2) Connection service management

Table 5-3 List of commands used in the connection service management

Command nameDescription
cjmsicmd list svcLists and displays the usable connection services.

(3) Physical destination management

Table 5-4 List of commands used in the physical destination management

Command nameDescription
cjmsicmd compact dstCompresses physical destinations.
cjmsicmd create dstCreates a physical destination.
cjmsicmd destroy dstDestroys the physical destination.
cjmsicmd list dstLists and displays the physical destination.
cjmsicmd pause dstTemporarily stops the message delivery to physical destination.
cjmsicmd purge dstDeletes all the messages from physical destination.
cjmsicmd query dstLists and displays the property values of physical destination.
cjmsicmd resume dstResumes the message delivery to physical destination.

(4) Persistence subscriber management

Table 5-5 List of commands used in the persistence subscriber management

Command nameDescription
cjmsicmd destroy durDestroys persistence subscriber.
cjmsicmd list durLists and displays the persistence subscriber.
cjmsicmd purge durDeletes all the messages of persistence subscriber.

(5) Common options of command utility

There are some common options that you can specify in all commands with the command utility. The following table lists and describes the common options of the command utility:

Table 5-6 List of common options of the command utility

Option nameDescription
-rtm timeoutIntervalSpecifies an initial value of the timeout interval (unit: seconds) as an integer from 0 to 2147483647​. The initial value is the time for which you wait for a response from the CJMSP Broker after executing a command until the request is sent again. The retry interval is set up in multiples of the initial value of the timeout interval. The default value is 10 seconds. Also, if you specify 0, a timeout does not occur.
-b host-name:port-numberSpecifies the host name (or IP address) and the port number connected to CJMSP Broker. The default value is as follows:
  • Host name: localhost
  • Port number: 7676
An error message is displayed, if you do not set up a correct value when the CJMSP Broker instance is started at the remote host.
If you specify only the port number and omit the host name, CJMSP Broker of the local host is connected. For example, when you specify :7676 has the same meaning when you specify localhost:7676.
-fExecutes the command without a confirmation from the user.
-h | -helpDisplays help.