Rules for using commands

Observe the following rules when using the IBM® App Connect Enterprise commands on distributed systems.

  • Each command starts with the executable command name (primary keyword) followed by one or more blanks.
  • Following the command name, parameters can occur in any order.
  • Parameters are shown as a flag in the form -t, for example. Some parameters have alternative long names; for example: -p and --admin-port are alternative parameter names of the port number for the administration REST API. In all cases, the character / can be substituted for the - character.
  • If a parameter has a corresponding value, its value must follow the parameter flag. A flag can be followed by its value directly or can be separated by any number of blanks.
  • Parameter 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: 
    mqsichangetrace INODE -t -e default  -l debug -m fast -c 200000 -r
    can be entered as: 
    mqsichangetrace INODE  -tredefault -l none -m fast -c 200000
    where the name of the integration server, 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: 
    mqsichangetrace "My Integration node" -tredefault  -l none -m fast -c 200000
    Additionally, you can specify a null, or empty, string with a pair of quotation marks with nothing between: "".
  • Most commands must be issued on the same system as the resource that the command acts on. Some commands can be used with a connection to a remote independent integration server or integration node; for example, by specifying the host and port by the -i and (optionally) -p parameters.
  • 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 Linux® and UNIX platforms, you must use lowercase; only mqsistart is acceptable.