IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

mqsimode command

Use the mqsimode command to configure and retrieve operation mode information.

Supported platforms

Windows
Linux and UNIX systems
z/OS®. Run this command by customizing and submitting BIPMODE; see Contents of the broker PDSE

Purpose

Use the mqsimode command to change the operation mode of a broker, or to retrieve information about the mode in which the broker is currently working.

Syntax


>>-mqsimode--| brokerSpec |--+---------------------+------------>
                             '- -o --operationMode-'   

>--+-------------------+--+---------------------+--------------->
   '- -w --timeoutSecs-'  '- -v --traceFileName-'   

>--+----------------------+------------------------------------><
   '- -x --modeExtensions-'   

brokerSpec

|--+- brokerName ----------------+------------------------------|
   +- -n --brokerFileName--------+   
   | .-------------------------. |   
   | V                         | |   
   '-----+- -i --ipAddress-+---+-'   
         +- -p --port------+         
         '- -q --qMgr------'

Parameters

brokerSpec

(Required) You must specify at least one parameter to identify the target broker for this command, in one of the following forms:

brokerName

This parameter identifies the name of a locally defined broker. You cannot use this option if the broker is on a remote computer.

-n brokerFileName

This parameter identifies the name of a file that contains the connection details for a local or remote broker.

Use this option if multiple users want to connect to the same broker, or if you are using advanced connection parameters such as SSL.

To create this file, right-click the broker in the IBM® Integration Explorer and select Export *.broker file. When prompted, navigate to the location in which you want to save the file and enter the file name; the extension .broker is appended automatically when you click Save. Include the location (path) and file name when you specify this parameter. You must ensure that the location is accessible when you run this command.

If you want to run a command that uses SSL to administer a remote broker over a secured channel, you must specify the keystore and truststore password for the connection using the IBM_JAVA_OPTIONS environment variable. See Resolving problems when running commands for further information.

-i ipAddress, -p port, -q qMgr

These parameters identify the connection details for the broker.

Use this option for connections to remote brokers that do not require advanced connection parameters.

If you choose this option, you must specify at least one of these three parameters; the order in which you specify them is insignificant. You cannot specify each parameter more than once.

Parameters that you omit assume default values:

-i ipAddress: The host name or the IP address of the computer on which the broker is running. If you do not specify this parameter, a value that represents the local computer is used.
-p port: The TCP port on which the broker's queue manager is listening. If you do not specify this parameter, the value 1414 is used.
-q qMgr: The name of the broker's queue manager. If you do not specify this parameter, a value that represents the default queue manager on the local computer is used.

You cannot connect to a remote queue manager on z/OS; see Usage note.

-o operationMode

(Optional) This parameter sets the mode of the target broker. Valid values are advanced (the full edition), standard (Standard Edition), express (Express Edition), scale (Scale mode), and adapter (Remote Adapter Deployment mode). The default value is advanced, unless you have the Developer Edition, in which case the default value is developer. If you do not specify the -o parameter, the command displays the mode in which the broker is running.

If you have purchased a license for the Standard Edition, you are entitled to run your brokers in either standard or scale mode.

-x modeExtensions

(Optional) This parameter uses a comma separated list of to specify the mode extensions to which the broker is entitled. You can also use the -x parameter to switch off all mode extensions (See Examples).

If the mode extension is DecisionServices, you do not need to specify the broker name. If you do specify a broker name, it is ignored.

-w timeoutSecs

(Optional) This parameter specifies the time in seconds that the utility waits to ensure that the command completed; the default value is 60.

-v traceFileName

(Optional) This parameter sends internal debug trace information to the specified file.

Usage note

If you try to connect to a remote broker by specifying the i, p, and q parameters, or by using a connection parameter file (.broker), the command attempts to use WebSphere® MQ Java™ client code. This option is not supported on z/OS, and returns the following error:

BIP1046E: Unable to connect with the broker (name)

The reported reason code is MQRC_ENVIRONMENT_ERROR. You must specify a local queue manager.

Authorization

For information about platform-specific authorizations, see the following topics:

If you have enabled broker administration security, you must also set up the authority detailed in Tasks and authorizations for administration security.

Responses

This command returns the following responses:

0: The command completed successfully.
2: (Failure) The broker received the deployment request but was unable to process it successfully. See the messages issued from the utility (or the Administration log) for more information.
9: (Failure) The request has been submitted to the broker, but no response was received before the timeout expired.
10: (Failure) Another user or application canceled the request operation before the broker was able to process it.
98: The broker is not running.
99: One or more of the parameters that you specified is invalid.

Examples

Running the mqsimode command specifying the -o parameter

When you run the mqsimode command for broker BROKER1, and specify the -o parameter, the mode is updated, and you receive a report about all errors. For example, if you run the following mqsimode command to change your broker to the Remote Adapter Deployment mode, and your broker is in the following state:

Broker_Name1 is the name of your broker.
Message_Flow is the name of your message flow.
Execution_Group is the name of your integration server.
The command changes Broker_Name1 to the Remote Adapter Deployment mode, but contains a node Node_Type that is not valid in this mode.

mqsimode BROKER1 –o adapter

You receive the following messages:

BIP1044: Connecting to the broker's queue manager...
BIP1045: Connecting to the broker...
BIP1805: The mode for broker 'Broker_Name1' has been changed to 'adapter'.
BIP1823: WARNING: Broker 'Broker_Name1' has a message flow called 'Message_Flow' 
 in integration server 'Execution_Group', which contains one or more nodes that are not 
 valid in this mode: Node_Type.
BIP8229: The command completed with the following number of warnings: 1.

Running the mqsimode command without the -o parameter

When you run the mqsimode command without the -o parameter, you receive a report about the mode being used by your broker, a report about all mode violations, and a report for any mode extensions that are required and not set. For example, if you run the following mqsimode command, and your broker is in the following state:

Broker_Name is the name of your broker.
Your broker is in Standard Edition mode.
Your broker has no violations.

mqsimode Broker_Name

You receive the following messages:

BIP1044: Connecting to the broker's queue manager...
BIP1807: Discovering mode information from broker 'Broker_Name'...
BIP1802: Broker 'Broker_Name' is in 'standard' mode.
BIP8071: Successful command completion.

Switching off all mode extensions

To switch off all mode extensions, run the mqsimode command with the -x parameter:

mqsimode Broker_Name –x

where Broker_Name is the name of your broker.

an67710_.htm |

Last updated Friday, 21 July 2017