Queue utility commands are made up of operations and modifiers.
The basic syntax of a queue utility command is:
qutil -operation qname -modifier
qname is the name of the queue.
Command operations
Operations define the various functions of the queue utility.
You can add only one operation to a qutil command.
- -C
- Creates a new queue. Requires a unique name for qname. Must be an upper
case C.
- -f
- Copies stdin to the queue. Requires a qname.
- -i
- Copies stdin to many queues. Requires section name as defined in the qutil.ini
file. Specifies a section from the qutil.ini to load for delivering messages
to many queues.
- -k
- Purge count for each record. Requires a qname. Can be used in conjunction
with -c modifier to limit the number of records processed.
- -p
- Peek count for each record. Does not remove records from the queue. Requires
a qname. Writes to stdout. Can be used in conjunction with -c modifier to
limit the number of records processed.
- -r
- Read count for each record. Removes records from the queue. Requires a
qname. Writes to stdout. Can be used in conjunction with -c modifier to limit
the number of records processed.
- -s
- Queue status. Requires a qname.
- -x
- Delete qname. Requires a qname.
For example,
For output to multiple queues from data acquired
directly from a process (such as AFP™).
qutil -i sectionname < sourcefile
Command modifiers
Modifiers configure additional parameters
for a queue utility operation. You can use more than one modifier on a qutil
command.
- -T
- Transactional Specifies whether a queue is transactional.
By
default, all new queues are non-transactional, unless specified upon creation
as transactional with a -T modifier.
Transactional queues must not be
used when a queue might receive routing information from an application monitor.
Transactional queues in Microsoft Message Queueing do not allow messages to
be prioritized or to be processed in any order other than the order in which
they were received.
- -c
- Count Specifies to stop after count records have been processed.
Requires an integer. Must be a lower case c.
- -l
- Priority Specifies the priority level for each record. Requires
an integer.
- Microsoft Message Queueing the priority levels are 0 - 7, where 0 is the
lowest, 7 is the highest, and 3 is the default.
- IBM Websphere MQ the priority levels are 0 - 9, where 0 is the lowest,
9 is the highest. The default value depends on a queue property. You can change
this property in your queue manager.
- -m (UNIX® only)
- Queue Manager Specifies the queue manager.
- -o
- Expire Specifies the number of seconds before a message expires.
Requires an integer.
- -t
- Pause Specifies the number of milliseconds to wait between each
record. Requires an integer.
Command Operation and Modifier relationships
Certain
modifiers are only recommended for use with certain operations. The following
table describes the relationship of each operation to its potential modifiers:
Table 1. Queue Utility command operation and modifier relationshipsOperation |
Valid Modifiers |
-C
|
-T
EXAMPLE: qutil -C qname [-T] |
-f
|
-c, -t, -l, -o
EXAMPLE: qutil -f qname [-c count] [-t pause] [-l priority]
[-o expire] |
-i
|
NONE EXAMPLE: qutil -i configsection |
-k
|
-c
EXAMPLE: qutil -k qname [-c count] |
-p
|
-c
EXAMPLE: qutil -p qname [-c count] |
-r
|
-c
EXAMPLE: qutil -r qname [-c count] |
-s
|
NONE EXAMPLE: qutil -s qname |
-x
|
NONE EXAMPLE: qutil -x qname |