nevisidmdb Usage and Configuration Properties
Command line
The nevisidmdb tool can be used for the migration of the database schema of nevisIDM.
The nevisidmdb tool is supported as of nevisIDM database version 2.75.0.0. Older database versions must be migrated first to at least version 2.75.0.0, with the legacy nevisidmdb tool version 2.75.x. See chapter Upgrade database to version 2.75.0.0 for further information.
Usage
nevisidmdb tool - Command line - Usage
Usage: nevisidmdb [-dhV] [-c=FILE] [COMMAND]
-c, --config=FILE Path to config file.
-d, --debug Show more debug information.
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
Commands:
migrate Migrates the database schema.
status Displays the status of the database schema.
loadpwddictionary Loads the password dictionary. (Note: For the Oracle database this command can take longer to complete.)
repair Repairs the schema history table after a failed migration.
Options
| Option | Default | Mandatory | Description |
|---|---|---|---|
| -c, --config FILE | /var/opt/nevisidmdb/conf/ nevisidmdb.properties | no | Determines the location of the nevisidmdb configuration properties file. If you do not explicitly provide the location, the system will load the configuration file from the default location. |
| -d, --debug | no | Sets the output information level to debug. The nevisidmdb tool logs to the console and the /var/opt/nevisidmdb/log/nevisidmdb.log file.The file is rolled-over at a size of 10 MB; a maximum of 9 files are kept. | |
| -h, --help | no | Shows a complete description of the usage and returns with exit code 0. | |
| -V, --version | no | Displays the software package version (including patch/build number) and returns with exit code 0. |
Commands
| Command | Description | Return Code |
|---|---|---|
| migrate | Migrates an existing database to the available database schema version in the package. | In case of failure: 1; In all other cases: 0 |
| status | Validates the current state and displays the following information: The available database schema version in the package. This is the software version without patch/build number. The current database schema version, if existing. * Validation information, if existing. | In case of failure: 1; In all other cases: 0 |
| loadpwddictionary | Loads the full-size password dictionary reference table. Note that this is time-consuming! | In case of failure: 1; In all other cases: 0 |
| repair | This command fixes issues with the schema history table. It cleans up entries after failed migrations, re-aligns the checksums of the applied/available migrations, and marks missing migrations as deleted. | In case of failure: 1; In all other cases: 0 |
Errors in command line parsing will result in a return code 2.
The first time that the system executes the migrate command during the initial database setup, it will create the database schema and load the nevisIDM reference data. See chapter Setup initial database schema for further information.
Configuration file
The path to the configuration file is /var/opt/nevisidmdb/conf/nevisidmdb.properties per default. The file configures the configuration properties listed in the table below. Default values apply if a property is not set in the configuration file.
| Configuration | Default Value | Mandatory | Allowed Values | Description |
|---|---|---|---|---|
| database.connection.url | jdbc:<mysql://localhost:3306/nevisidm> | no | Database connection URL. | |
database.owner.name | no | _ - # $ @ % . ' (un-)quoted alphanumeric | The name of the database owner. | |
| database.owner.password | no | _ - # $ @ % . ' (un-)quoted alphanumeric | The password of the database owner. | |
| Specific for Oracle Database: | ||||
| database.ts.index | INDEX_IDM | no | _ - # $ @ % . ' (un-)quoted alphanumeric | The tablespace name for the index of nevisIDM. |
| database.ts.data | DATA_IDM | no | _ - # $ @ % . ' (un-)quoted alphanumeric | The tablespace name for the data of nevisIDM. |
| database.role.appl | RL_IDM_APPL | no | _ - # $ @ % . ' (un-)quoted alphanumeric | The role of the application user. |
Environment configuration file
The environment configuration file env.conf is located in the configuration folder /var/opt/nevisidmdb/conf.
The file includes the following environment variables:
JAVA_HOME
Defines the Java installation to use.
As the first priority, nevisidmdb uses the Java installation defined by this configuration property in the env.conf file. If you do not set this JAVA_HOME property, nevisidmdb will use the Java version defined in the PATH environment variable.
Example: JAVA_HOME=/etc/alternatives/jre_1.8.0
JAVA_OPTS
You can use this variable to pass Java Virtual Machine arguments to the execution of nevisidmdb.Example: JAVA_OPTS=-oracle.net.tns_admin=/path/to/tnsnames/dir