Flags and Arguments

-archive directoryname

Displays the contents of the archive that has been extracted to the specified directory. The -archive flag displays the same information as does the -journaler flag, except that you specify the directory to which you extracted the archive. The MS Control utility displays information in the same format as -journaler. See To Access an Archive File.

-ar

-backup file date

Creates an archive (.zip) file that contains all messages for all queues and topics up to the specified date. Both live and journaled messages are included in the archive. See To Create a Backup Archive File.

-b

-changeqmsg queuename seqnumber

Changes the content of the message designated by the specified sequence number in the specified queue, reading from standard input (the command prompt, or whatever file or piped command it specifies). See To Change Message Contents.

-cqm

-changetmsg topicname seqnumber

Changes the content of the message designated by the specified sequence number in the specified topic, reading from standard input (the command prompt, or whatever file or piped command it specifies). See To Change Message Contents.

-ctm

-createqueue queuename

Creates a new queue with the specified name. 

-cq

-createsub topicname subname clientname

Creates a new subscriber for the specified topic and client. For the name of the client, specify eGate.

-cs

-createtopic topicname

Creates a new topic with the specified name. 

-ct

-deletequeue queuename

Deletes the specified queue. 

-dq

-deletesub topicname subname clientname

Deletes the specified subscriber from the specified topic and client. For the name of the client, specify eGate.

-ds

-deletetopic topicname

Deletes the specified topic. 

-dt

-delqmsg queuename seqnumber

Deletes the message designated by the specified sequence number in the specified queue. 

-dqm

-deltmsg topicname seqnumber

Deletes the message designated by the specified sequence number in the specified topic. 

-dtm

--help

Displays information about the JMS IQ Manager. 

-host hostname

Specifies the name of the Logical Host. If not specified, the default is localhost. For hosts other than localhost and flags other than --help and --version, specification of the host is required.

-journaler

Displays the contents of journaled messages. Note that the journaler does not support information about subscribers and receivers. Flags such as-sublistall, -deletesub, or -recvlistall do not work with the -journaler flag. You cannot delete journaled messages, topics, or queues. The MS Control utility displays information about journaled topics and queues in the same format as the JMS IQ Manager

-j

-locktopic topicname

Locks a topic, preventing any subscriber from receiving messages from it. 

-lt

-msgtype type

Specifies the data type of the content of the message, which must be either bytes or text.

-msversion

Displays server version information. 

-offset portoffset

Specifies a server port offset number. 

-port portnumber

Specifies the TCP/IP port of the Logical Host to which this message server is listening. If not specified, the default is 7555. For ports other than 7555 and flags other than --help and --version, specification of the port is required.

-p

-qmessage queuename

Retrieves the message designated by the specified sequence number for the specified queue. If the specified queue contains no message with this sequence number, an error is returned. 

-gqm

-qmimport queuename seqnumber numbermessages

Republishes the specified number of messages from the specified queue, beginning with the specified sequence number.  

-qmi

-qmsglist queuename seqnumber numbermessages

Lists all messages for the specified queue, starting at or above the specified sequence number and listing no more than the specified number of messages. 

-qml

-queuelist

Lists all queues for this server.  

-ql

-queuestat queuename

Displays the status of the specific queue.  

-qs

-recvlistall

Lists all receivers for all queues for this server.  

-rla

-recvlistforqueue queuename

Lists all receivers for the specified queue.  

-rlfq

-shutdown

Shuts the server down. See To Shut the Server Down.

-status

Displays the status of the server.  

-sublistall

Lists all subscribers to all topics for this server.  

-sla

-sublistfortopic topicname

Lists all subscribers for the specified topic.  

-slft

-timeout seconds

Specifies the timeout period in seconds (the default is 5 seconds). See To Set the MS Control Utility Timeout Period.

-tmessage topicname seqnumber

Retrieves the message designated by the specified sequence number for the specified topic. If the specified topic contains no message with this sequence number, an error is returned. 

-gtm

-tmimport topicname seqnumber numbermessages

Republishes the specified number of messages from the specified topic, beginning with the specified sequence number.  

-tmi

-tmsglist topicname seqnumber numbermessages

Lists all messages for the specified topic, starting at or above the specified sequence number and listing no more than the specified number of messages. 

-tml

-topiclist

List all topics for this server.  

-tl

-topicstat topicname

Displays the status of the specified topic.  

-ts

-unlocktopic topicname

Unlocks the specified topic, restoring access to all subscribers. 

-ut

-username username

Specifies the user name to connect to the JMS IQ Manager. This flag is mandatory when JMS IQ security is enabled.

-userpassword userpassword

Specifies the password to connect to the JMS IQ Manager. This flag is mandatory when JMS IQ security is enabled.

--version

Displays MS Utility version information. 

stcmsctrlutil -host hostname -port portnumber [-offset portoffset]
 -flag [argument1 ... argumentN]

stcmsctrlutil -host hostname -port portnumber -username username
 -userpassword userpassword [-offset portoffset] -flag

stcmsctrlutil --help
stcmsctrlutil --version