mqsicvp command

Use the mqsicvp command to perform verification tests on an integration node, to verify ODBC connections, and perform CPU benchmark processing.

Supported platforms

  • Windows
  • Linux® and UNIX systems

When you start an integration node by using the mqsistart command, this command is run automatically to verify the component.

z/OS platformOn z/OS®, the same verification procedures are run automatically when you start an integration node.

You can run this command against an integration node that is running, or is not running. If the integration node is not running, the verification tests are performed, but the integration node is not started.

Purpose

The mqsicvp command completes the following actions:

  • The command checks that the integration node environment is set up correctly; for example, that the installed level of Java™ is supported.
  • The command verifies that the WebSphere® MQ queues are defined and accessible.
  • Linux platformUNIX platformOn Linux and UNIX systems, the command verifies that the ODBC environment (if specified) is configured correctly.
    If the ODBCINI environment variable is set, the mqsicvp command writes warning messages to the syslog in the following circumstances:
    • If the file to which the ODBCINI environment variable points does not exist, or the integration node does not have access to read it or write to it
    • If ODBCSYSINI is not set
    • If ODBCSYSINI is set but the directory to which this variable points does not contain a file named odbcinst.ini, or the integration node does not have access to read or write to this file
    • If the IE02_PATH environment variable is not set
  • Linux platformUNIX platformOn Linux and UNIX systems, if the ODBC environment check is successful, the command connects to all data sources that are listed in the odbc.ini files, and that were associated with the integration node by using the mqsisetdbparms command.
  • Linux platformWindows platformUNIX platformOn Windows, Linux and UNIX systems, the command can be run to perform benchmark processing on the system so that expected performance can be compared between two, or more, systems.

Use of the command to provide information about user data sources

The data sources that are described are those that you defined when you set up the ODBC database. See Enabling ODBC connections to the databases.

Extra invocations of the mqsicvp command provide ODBC test tool function. This function provides useful information about a user data source, or compares two user data sources for equivalence. These invocations of the command are discrete from the basic invocation of the mqsicvp command, and are not run at integration node startup.

When you use the mqsicvp command as an ODBC test tool, the command issues an informational message for a successful connection, providing the name of the data source, database type, and version. If a secondary data source is supplied, the mqsicvp command issues a second informational message for a successful connection to that data source, with the same information about the secondary data source, and stating that a comparison will be made.

When the tool is run against one data source, it completes several checks against the ODBC interface to determine which data types and functions are supported, together with information about the names and sizes of those data types. If any data types or functions are not supported, they are summarized in a final informational message.

When these tests are run against two data sources, they are run against both data sources, and both sets of results are shown. A final informational message states whether the two data sources are equivalent and eligible to be used in the same message processing node; for further information, see Accessing databases from ESQL.

Syntax

Invocation to verify the integration node

When you run the mqsicvp command with only the integration node name, and no other parameters, the command completes the following checks:
  • Checks that the integration node environment is set up correctly (for example, the installed level of Java is supported).
  • Verifies that the WebSphere MQ queues are defined and accessible.
  • Linux platformUNIX platformOn Linux and UNIX systems only, the command verifies that the ODBC environment (if specified) is configured correctly. If the ODBCINI environment variable is not set, ODBC environment verification is skipped. If the ODBC environment check is completed successfully, the command then tries to connect to all data sources that are listed in the odbc.ini files where the mqsisetdbparms command was used to associate the data source with the integration node. To check what credentials are set by mqsisetdbparms, use mqsireportdbparms
Read syntax diagramSkip visual syntax diagrammqsicvpintegrationNodeName

Syntax

Invocation where ODBC data source names have not been associated with the integration node

When you run the mqsicvp command with parameters shown in the following syntax diagram, the command provides ODBC test tool function. You can use the command to display useful information about a user data source, or compare two user data sources. On Linux and UNIX systems only, invocations of the command that use these parameters also verify that the ODBC environment (if specified) is configured correctly. In these cases, the command checks that the ODBCINI, ODBCSYSINI, and IE02_PATH variables are set.

Each data source name (DSN) is fully specified with a user name and password.

This invocation does not rely on an association between the integration node and the data source, and returns information about the data source even when there is no association with an integration node.

Read syntax diagramSkip visual syntax diagrammqsicvp-nprimaryDatasource-uprimaryDatasourceUserId-pprimaryDatasourcePassword-csecondaryDatasource-isecondaryDatasourceUserId-asecondaryDatasourcePassword-v

Syntax

Invocation where ODBC data source names were associated with the integration node

This invocation requires an association between the integration node and the data source name (DSN). To successfully use this invocation, you must first run the mqsisetdbparms command to identify a specific user ID and password for the integration node to use when connecting to the data source. The output from this invocation is the same as the output from the invocation where data source names have not been associated with the integration node.

When using the mqsisetdbparms command, you can either specify the data source name directly, or add the prefix odbc::.

This prefix identifies the type of identity being created in mqsisetdbparms, and must be omitted when using this identity as the data source in mqsicvp. For example:
mqsisetdbparms IBNODE -n odbc::myDsn -u username -p password
mqsicvp IBNODE -n myDsn
If you use mqsisetdbparms to set an integration server level identity for a data source, the identity cannot be used in mqsicvp.

Linux platformUNIX platformOn Linux and UNIX systems only, invocations of the command that use the parameters in the following syntax diagram also verify that the ODBC environment (if specified) is configured correctly. In these cases, the command checks that the ODBCINI, ODBCSYSINI, and IE02_PATH variables are set.

Read syntax diagramSkip visual syntax diagrammqsicvpintegrationNodeName-nprimaryDatasource-csecondaryDatasource-v

Parameters

integrationNodeName
(Required - if you are using an invocation that contains integrationNodeName.) Specify an integration node name to verify, or the integration node name with which the primaryDatasource is associated.

Linux platformUNIX platformAll names are case-sensitive on Linux and UNIX systems.

-n primaryDatasource
(Required if you are using an invocation that contains primaryDatasource.) The name of the ODBC connection to verify.
-u primaryDatasourceUserId
(Required if you did not previously associate the data source name with the integration node.) The user name with which to connect to the primaryDatasource.
-p primaryDatasourcePassword
(Required if you did not previously associate the data source name with the integration node.) The password that is used with the primaryDatasourceUserId.
-c secondaryDatasource
(Optional) If two data sources are being compared for equivalence, this data source is the second ODBC connection name.
-i secondaryDatasourceUserId
(Optional) The user name with which to connect to the secondaryDatasource.
-a secondaryDatasourcePassword
(Optional) The password that is used with the secondaryDatasourceUserId.
-v
(Optional) This parameter causes extra, untranslated, diagnostic information that is related to supported CASTS to be shown by the command.

Responses

  • BIP8040W: No database access (unable to connect).
  • BIP8267W: Warning, there might be issues when using this data source. For more information, see the preceding messages.
  • BIP8268I: The two data sources that are supplied are compatible, and can be used in the same Compute node.
  • BIP8269W: The two data sources that are supplied are not compatible, and must not be used in the same Compute node.
  • BIP8270I: Connected to data source <multiple inserts>
  • BIP8271I: Connected to second data source <multiple inserts> for comparison.
  • BIP8272W: Data source specified is not associated with the integration node.
  • BIP8273I: The following data types and functions are not natively supported by data source '&1': <multiple inserts>
  • BIP8274W: The following data types and functions might cause problems when you use data source '&1' with IBM® Integration Bus: <multiple inserts>
  • BIP8288W: Unable to read ODBCINI file 'file_name'. Check that this file exists, and that the integration node user ID has permission to read and write the file.
  • BIP8289W: Unable to read ODBCSYSINI file in specified directory 'directory_name'. Check that this file exists, and that the integration node user ID has permission to read and write the file.
  • BIP8290I: Verification passed for the ODBC environment.
  • BIP8291W: The IE02_PATH environment variable is not set.
  • BIP8292I: 'insert1' user data sources were not verified because they do not have mqsisetdbparms credentials.
  • BIP8294I: ODBC environment verification was skipped because the ODBCINI environment variable is not set.
  • BIP8295E: ODBCINI environment variables have not been set, or are invalid.
  • BIP8296W: The ODBCSYSINI environment variable is not set.
  • BIP8297W: 'environment_variable_name' file 'file_name' is empty.
  • BIP8873I: Starting the component verification for integration node 'integrationNodeName'.
  • BIP8874I: The component verification for 'integrationNodeName' finished successfully.
  • BIP8875W: The component verification for 'integrationNodeName' finished, but one or more checks failed.
  • BIP8876I: Starting the environment verification for integration node 'integrationNodeName'.
  • BIP8877W: The environment verification for integration node 'integrationNodeName' finished, but one or more checks failed.
  • BIP8878I: The environment verification for integration node 'integrationNodeName' finished successfully.
  • BIP8882I: Starting the WebSphere MQ verification for integration node 'integrationNodeName'.
  • BIP8883W: The WebSphere MQ verification for integration node 'integrationNodeName' finished, but one or more checks failed.
  • BIP8884I: The WebSphere MQ verification for integration node 'integrationNodeName' finished successfully.
  • BIP8885E: Verification failed. Failed to connect to queue manager 'queue_manager_name'. MQRC: return_code MQCC: completion_code
  • BIP8886I: Verification has passed for queue 'queue_name' on queue manager 'queue_manager_name'.
  • BIP8887E: Verification has failed for queue 'queue_name' on queue manager 'queue_manager_name' while issuing 'operation'. MQRC: return_code MQCC: completion_code
  • BIP8888E: Verification failed. Failed to disconnect from queue manager 'queue_manager_name'. MQRC: return_code MQCC: completion_code
  • BIP8892E: Verification failed. The installed Java level 'level_installed' does not meet the required Java level 'level_supported'.
  • BIP8893E: Verification has failed for environment variable 'variable_name'. Unable to access file 'file_name' with user ID 'user_ID'. Extra information for IBM support: data1 data2.
  • BIP8894I: Verification has passed for 'integrationNodeName'.
  • BIP8895E: Verification failed. Environment variable 'variable_name' is incorrect or missing.
  • BIP8896E: Verification failed. Unable to access the registry with user ID 'user_ID'. Extra information for IBM support: data1 data2
  • BIP8897E: Verification failed. Environment variable 'variable_name' does not match the integration node name 'integrationNodeName'.
  • BIP8900I: APF Authorization check successful for file 'file_name'.
  • BIP8903E: Verification failed. The APF Authorization check failed for file 'file_name'.
  • BIP8904E: Verification failed. Failed to stat file 'file_name1' with return code 'return_code' and error number 'error_number'.

Examples

Run verification checks on the integration node named: IBNODE
mqsicvp IBNODE
Data source name (DSN) MyDB is associated with the integration node IBNODE by using the mqsisetdbparms command:
mqsicvp IBNODE -n MyDB
DSNMyDB is compared against a secondary DSN MyDB2 associated with the integration node IBNODE by using the mqsisetdbparms command:
mqsicvp IBNODE -n MyDB -c MyDB2
The fully qualified DSNMyDB is compared against a secondary fully qualified DSN MyDB2 by using the primary and secondary user IDs and passwords:
mqsicvp -n MyDB -u username -p password -c MyDB2 -i username2 -a password2

Use of the command to perform CPU benchmark processing

The mqsicvp command can be used to perform a benchmark on the system. The benchmark tests the CPU performance by calculating a recursive, arithmetic sequence on one or more threads. For the duration of the benchmarking process, each thread that is used typically consumes an entire logical CPU on the system. Consequently, the optimal time to run the command is during a period of scheduled downtime so that the CPU usage does not impact running production workloads.

Syntax

Read syntax diagramSkip visual syntax diagram mqsicvp integrationNodeName  -b  checkType options
options
Read syntax diagramSkip visual syntax diagram  -o  javarecursion ,threads=nn,iterations=nn,sequence=nn

Parameters

integrationNodeName
(Required) Specify the name of an integration node that is defined on the system.

Linux platformUNIX platformAll names are case-sensitive on Linux and UNIX systems.

-b checkType
(Required) Specify a value of benchmark to perform benchmark processing.
-o options
(Required) Specify the options to run with the command.
javarecursion
(Required) Specify javarecursion to run a CPU benchmark stress test.
, threads=nn
(Optional) Specify the number of threads to run. The default value is 5.
, iterations=nn
(Optional) Specify the number of times that the benchmark process is to be repeated. The default value is 5.
, sequence=nn
(Optional) Specify the number of steps in the sequence to calculate. The default value is 10.

Examples

Run a benchmark that includes two threads, five iterations, and calculates 40 steps in the sequence:
mqsicvp IBNODE -b benchmark -o javarecursion,threads=2,iterations=5,sequence=40
The output from the command is similar in format to the following example:
mqsicvp IBNODE -b benchmark -o javarecursion,threads=2,iterations=5,sequence=40
Running 2 threads
ThreadId:23 - Calculating sequence to number 40 5 times
ThreadId:24 - Calculating sequence to number 40 5 times
Took 3 seconds to run
Total CPU time: 7014ms, for  10 calculations

Rating Value:285714
Average Core Value:142857
BIP8071I: Successful command completion.