Rules for using commands

Observe the following rules when using the WebSphere Message Broker commands on distributed systems. If you are using commands on z/OS, refer to the section on z/OS commands in Commands.
  • Each command must be issued on the system on which the resource it relates to is defined (or is to be created).
  • Each command starts with a primary keyword (the executable command name) followed by one or more blanks.
  • Following the primary keyword, flags (parameters) can occur in any order.
  • Flags are shown in this book in the form -t, for example. In all cases, the character / can be substituted for the - character.
  • If a flag has a corresponding value, its value must follow the flag to which it relates. A flag can be followed by its value directly or can be separated by any number of blanks.
  • Flags can be concatenated if they do not have corresponding values, although the last flag in a concatenated group can have a value associated with it. For example, the command:
    mqsireadlog WBRK_BROKER -u -e default -o trace.xml -f
    could be entered as:
    mqsireadlog WBRK_BROKER -ufedefault -o trace.xml
    where the name of the execution group, default, relates to the -e flag. For clarity, all examples given in this documentation are shown with separate flags and with a space before any associated value.
  • Repeated flags are not allowed.
  • Strings that contain blanks or special characters must be enclosed in double quotation marks. For example:
    mqsireadlog "My Broker" -u -e default -o trace.xml -f
    Additionally, you can specify a null, or empty, string with a pair of double quotes with nothing between: "". For example:
    mqsichangeconfigmgr -s ""
  • The case sensitivity of primary keywords and parameters depends on the underlying operating system. On Windows platforms keywords are not case sensitive; mqsistart, mqsiSTART, and MQSISTART are all acceptable. On UNIX platforms, you must use lower case; only mqsistart is acceptable.

All WebSphere Message Broker commands have dependencies on WebSphere MQ function. You must ensure that WebSphere MQ is available before issuing these commands.

Related reference
Characters allowed in commands
Commands
Responses to commands