init
Purpose
The init command initializes the data integrity framework.| Required access rights: | User has to be a data integrity administrator as described in Table 1 |
| Predefined roles that provide required access rights: | None |
Format
Notes:
- FTM SWIFT events are not written unless the instance's remote event service DNI_R_EVENT is running.
- You must specify parameters -host, -channel, and -port only if you want the data integrity checker utility to connect to the queue manager specified by parameter -qmgr in client mode. If you omit these parameters, the data integrity checker utility connects in bindings mode.
- You must specify parameters -ciphersuite, -truststore, and -fips only if you want to use SSL/TLS.
Parameters
- -Djava.security.policy=policy_file
- policy_file is the policy file that was provided for the runtime system. You can omit this parameter if your system administrator has added the required policies to the JVM default security properties file. For more information, see Java Policy files.
- -password password
- The password to be used by the data integrity framework.Note: If you omit this parameter, the data integrity checker utility prompts for the password.
- -keystore vault
- The vault file that you created in step 2.a when activating the database integrity framework. Make
sure that the vault file is accessible by all message brokers with the provided path and name. You
must specify the full path of the vault file, for
example:
-keystore /var/ftm/swift/v324/run/ftmswift_vault.jceks - -passphrase phrase
- The passphrase that the data integrity administrator specified when issuing the vault utility command
create as described in activation of the data integrity framework, step 2.a.Notes:
- If you omit this parameter, the data integrity checker utility prompts for the passphrase.
- Instead of specifying the phrase itself, you can also provide a stash file as described in Stash File Utility, for
example:
-passphrase @/var/ftm/swift/v324/run/passphrase.stash
- -dsn data_source_name
- Specifies information about the connection to Db2®. Use
one of the following notations:
-
Db2_database_name -
//server:port/Db2_database_name
- Db2_database_name
- The Db2 database name (for example, DNIDB)
- server
- The hostname or IP address of the Db2 server (for example, localhost)
- port
- The port of the Db2 server (for example, 50000)
If you do not specify this parameter, the first notation is used with the value of the environment variable DNI_DSN as Db2 database name.
-
- -schema schema
- The schema name of the tables in the FTM SWIFT runtime database. By default, the value of the environment variable DNI_SN is used.
- -uid user_id
- The user ID to be used when connecting to the FTM SWIFT runtime database. By default, this is the ID of the user who executes the command.
- -pw password
- The password of the user ID specified by the
-uid
parameter.Notes:
- If you omit this parameter, the data integrity checker utility prompts for the password.
- Instead of specifying the password itself, you can also provide a stash file as described in
Stash File Utility, for
example:
-pw @/var/ftm/swift/v324/run/db2.stash
- -instance (or -in or -i) instance
- The name of the FTM SWIFT instance used to write events. By default, the value of the environment variable DNI_I is used.
- -qmgr qmgr
- The name of the queue manager that is associated with the specified FTM SWIFT instance. By default, the value of the environment variable DNI_QM_instance is used.
- -host host
- The host name of the IBM MQ server on which the queue manager runs. Specify this parameter if you want the data integrity checker utility to connect to the queue manager in client mode instead of bindings mode.
- -channel channel
- The channel to be used to connect to the queue manager. Specify this parameter if you want the data integrity checker utility to connect in client mode instead of bindings mode.
- -port number
- The port number of the IBM MQ server on which the queue manager runs. Specify this parameter if you want the data integrity checker utility to connect in client mode instead of bindings mode. The default is 1414.
- -ciphersuite name
- The name of the SSL cipher suite to be used in client connections to the IBM MQ server on which the queue manager runs. Use the name of the SSL cipher suite that matches the SSL definition for the channel name used. Refer to the IBM MQ documentation, SSL CipherSpecs and CipherSuites in MQ classes for Java, for more information on cipher suite naming.
- -truststore filename
- The file name of a trust store which contains the certificate information of the IBM MQ queue manager. Refer to the IBM MQ documentation, Configuring SSL security for MQ, for details on how to set up SSL/TLS connections and certificate information.
- -fips
- Use this parameter to enable Federal Information Processing Standards (FIPS) conforming SSL/TLS operations.
- -force
- Use the -force option to start the init command even if a concurrent DIC command has been detected (DNPD1265E). Before using the -force option, ensure that there is no data integrity checker operation still running.
- -help or -h
- Show the help text that describes the parameters.
Return codes
The init command terminates with one of the following return codes:| Value | Explanation |
|---|---|
| 0 | Command completed successfully. |
| 4 | No processing was done because an invalid parameter was specified. |
| 8 | An error condition occurred, for example the vault file specified by the keystore parameter could not be read. Check the console output and log files (for example: /var/ftm/swift/v324/run/trace/dic/*.trc) for additional information. |
| 12 | Processing terminated due to a fatal error. For more information, check the console output and log files (for example: /var/ftm/swift/v324/run/trace/dic/*.trc) for additional information. |
Example
The following command (issued on a single line) initializes the control information for the data
integrity framework. The schema used is the value of environment variable DNI_SN,
and the hosting database is identified by environment variable DNI_DSN; it prompts for both, the passphrase and Helen's password, and
it writes FTM SWIFT events for the instance that is identified by
environment variable
DNI_I:
dnpdic -init -Djava.security.policy=/var/ftm/swift/v324/run/ftmswift.policy
-keystore /var/ftm/swift/v324/run/ftmswift_vault.jceks
-password my_data_integrity_pwd -uid helen