Configure the Database from the Command Line

The command line utility vovdb_util can be used to configure most aspects of the Monitor database. You must have ADMIN privileges on the Monitor server to configure and control the database.

To execute the utility, first set up the CLI:

% vovproject enable vnclicmon

vovdb_util

Utilities for use with the VOV database.


vovdb_util: Usage Message
  DESCRIPTION:
    Utilities for use with the VOV database.
  
  USAGE:
    % vovdb_util <COMMAND> [COMMON OPTIONS] [OPTIONS]
  
  COMMANDS:
    help         -- Shows help information.
    backup <dest>
                 -- Backs up the VOV database to the specified destination.
                    This command must be run on the same machine as the
                    database.  If the destination exists it must be empty.
                    The database must also be running.
    clearcfg [-noconfirm]
                 -- Resets the VOV database configuration to the initial,
                    unconfigured state.  Pass -noconfirm to skip confirmation.
    exportconfig <fileout>          
                 -- Exports VOV database configuration 
                    properties DB_* to obfuscated file.
    exportpasswords <fileout> 
                 -- Exports VOV database passwords 
                    from project to obfuscated file.
    importconfig <filein> 
                 -- Imports VOV database configuration
                    properties DB_* from obfuscated file.
    importpasswords <filein>        
                 -- Imports VOV database passwords
                    from obfuscated file to project.
    configure [-v] [-reset] [-noconfirm] <host> <root> [<port>]
                 -- Sets the host, root data path, and port for the VOV
                    database. Pass -reset to overwrite existing settings.
                    Pass -noconfirm to skip confirmation.
    showcfg      -- Prints out current VOV database configuration.
    startdb      -- Starts the VOV database.  Will restart a running database.
    status       -- Prints current VOV database status.
    stopdb       -- Stops the VOV database.
    upgrade [-noconfirm] [-sdb sourcedir] [-spgsw pg_software_dir] 
                 -- Upgrades the VOV database to use the newest version of the
                    PostgreSQL engine. 
                    Pass -noconfirm to skip confirmation.
                    -sdb to specify path to Source database
                    -spgsw path to older version of PG 
                     binaries compatible with Source database
  
      The following commands are only supported for NetworkComputer and
      LicenseMonitor.
  
    dump [-pre201509] [-start <YYYYMMDD>] [-end <YYYYMMDD>]
                 -- Generate data files, optionally limited to the start and
                    end times specified.  Pass -pre201509 to dump the database
                    that was used prior to upgrade to 2015.09 (or beyond.)
  
    trim <YYYYMMDD>
                 -- Deletes data prior to the given date.
  
  COMMON OPTIONS:
    -v           -- Increase verbosity.

Database Configuration Options

Database configuration is handled by the vovdb_util configure command. Pass -reset to overwrite an existing configuration. Pass -noconfirm to skip confirmation.

To show the current configuration, use vovdb_util showcfg. To clear an existing configuration, use vovdb_util clearcfg.

Some examples:

% vovdb_util configure localhost /data/rtda/licmon
vovdb_util 08/17/2023 16:15:03: message: Setting VOV database configuration to:
	Host:      srv1
	Data Path: /data/rtda/licmon
Set configuration (yes/no)? yes
vovdb_util 08/17/2023 16:15:08: message: Configuration saved.

% vovdb_util configure -reset -noconfirm localhost /data/rtda/db/licmon
vovdb_util 08/17/2023 16:15:53: message: Configuration saved.

% vovdb_util showcfg
vovdb_util 08/17/2023 16:16:00: message: The VOV database configuration is:
	Host:      srv1
	Data Path: /data/rtda/db/licmon
	Status:    stopped

% vovdb_util clearcfg -noconfirm
vovdb_util 08/17/2023 16:15:24: message: Configuration has been cleared.

Database Control Options

Once the database is configured, it can be controlled with the vovdb_util startdb and stopdb commands. There will be additional output the first time the database is started as the on-disk structure is created.

Starting the database:

% vovdb_util startdb
vovdb 08/17/2023 16:22:55: message: Creating database
The files belonging to this database system will be owned by user "admin".
This user must also own the server process.

The database cluster will be initialized with locale "en_US.UTF8".
The default database encoding has accordingly been set to "UTF8".
The default text search configuration will be set to "english".

Data page checksums are disabled.

creating directory /data/rtda/db/licmon/dbdata9_4 ... ok
creating subdirectories ... ok
<snip>
vovdb 08/17/2023 16:22:58: message: Starting database
vovdb 08/17/2023 16:22:58: message: LOG:  database system was shut down at 2023-08-17 16:22:56 CDT
vovdb 08/17/2023 16:22:58: message: LOG:  MultiXact member wraparound protections are now enabled
vovdb 08/17/2023 16:22:58: message: LOG:  database system is ready to accept connections
vovdb 08/17/2023 16:22:58: message: Database engine is ready.
vovdb 08/17/2023 16:22:58: message: Configuring database...
vovdb 08/17/2023 16:22:58: message: Creating user 'rtdamgr'
vovdb 08/17/2023 16:22:58: message: Creating user 'rtdausr'
vovdb 08/17/2023 16:22:58: message: Creating database 'rtda'
vovdb 08/17/2023 16:22:58: message: Database configured.
vovdb 08/17/2023 16:22:58: message: Loading schema for LicenseMonitor...
vovdb 08/17/2023 16:22:58: message: Creating table 'metadata'...
vovdb 08/17/2023 16:22:58: message: Granting RO privileges to rtdausr...
vovdb 08/17/2023 16:22:58: message: Creating table 'loadinfo'...
vovdb 08/17/2023 16:22:58: message: Granting RO privileges to rtdausr...
<snip>
vovdb 08/17/2023 16:22:59: message: Schema loaded
vovdb 08/17/2023 16:22:59: message: Database is ready.
vovdb_util 08/17/2023 16:22:59: message: Database started.

Stopping the database:

% vovdb_util stopdb
vovdb_util 08/17/2023 16:31:22: message: Stopping database...
vovdb_util 08/17/2023 16:31:23: message: Database stopped.

Database Tasks

At present, database tasks such as the automatic loader, daily maintenance, and automatic backups can only be configured through the web interface. Refer to Set Up for more information.