11 Audit Vault IBM DB2 (AVDB2DB) Utility Commands

Use the Audit Vault IBM DB2 Database (AVDB2DB) command-line utility to manage the relationship between Oracle Audit Vault an IBM DB2 source database and DB2 collector. When you run these commands, remember the following:

Enter the command in lowercase letters. The commands are case-sensitive.
When you open a new shell to run the command, first set the appropriate environment variables. See Section 2.2 for instructions.
Oracle Audit Vault creates a log file of AVDB2DB command activity. See Section A.1 and Section A.2 for more information.

Table 11-1 describes the AVDB2DB commands and where each is used, whether on the Audit Vault Server, on the Audit Vault collection agent, or in both places.

Table 11-1 AVDB2DB Commands

Command	Where Used?	Description
add_collector	Server	Adds a collector to Oracle Audit Vault
add_source	Server	Registers an audit source with Oracle Audit Vault
alter_collector	Server	Alters the attributes of a collector
alter_source	Server	Alters the attributes of a source
drop_collector	Server	Drops a collector from Oracle Audit Vault
drop_source	Server	Drops a source from Oracle Audit Vault
-help	Both	Displays help information for the `AVDB2DB` commands
setup	Collection agent	Adds the source user credentials to the wallet, creates a database alias in the wallet for the source user, and verifies the connection to the source using the wallet
verify	Both	Verifies that the source is compatible with the collectors

11.1 avdb2db

The AVDB2DB command-line utility, which you use to configure an IBM DB database with Oracle Audit Vault.

Syntax

avdb2db command -help

avdb2db command [options] arguments

Arguments

Argument	Description
`command`	Enter one of the commands listed in Table 11-1.
`arguments`	Enter one or more of the `AVDB2DB` command arguments.
`-help`	Displays help information for the `AVDB2DB` commands

Usage Notes

Issuing an AVDB2DB command generates the following log file: $ORACLE_HOME/av/log/db2db-%g.log. The %g is a generation number that starts from 0 (zero) and increases once the file size reaches the 100 MB limit.

11.2 add_collector

The avdb2db add_collector command adds a collector for the given IBM DB2 source database to Oracle Audit Vault. Oracle Audit Vault verifies the source database for the collector requirements.

Where to Run This Command

Audit Vault Server

Syntax

avdb2db add_collector -srcname srcname -agentname agentname 
        [-collname collname] [-desc desc]

Arguments

Argument	Description
`-srcname` `srcname`	Enter the source database name for which the collector is to be added. Remember that the source database name is case-sensitive. Typically, the host is the fully qualified domain name or IP address of the server on which the IBM DB2 source database is running, and the port number is 50000.
`-agentname` `agentname`	Create a name for the agent that will use the DB2 collector.
`-collname` `collname`	Create a name for the DB2 collector. Optional. If you do not create a name, Oracle Audit Vault names the collector `DB2_Coll`.
`-desc` `desc`	Enter a brief description of the collector. Optional.

Usage Notes

Run any collector-specific preparation scripts before you execute the avdb2db add_collector command.
The avdb2db add_collector command prompts for a user name and password. This user account must have privileges to run the IBM DB2 db2audit command (for example, a user who has the sysadmin privilege).

Example

The following example shows how to add an DB2 collector to Oracle Audit Vault on Linux and UNIX platforms.

$ avdb2db add_collector -srcname db2db4 -agentname agent1 
Enter a username : source_user_name
Enter a password : password

***** Collector Added Successfully*****

11.3 add_source

The avdb2db add_source command registers an IBM DB2 source database with Oracle Audit Vault for audit data consolidation.

Where to Run This Command

Audit Vault Server

Syntax

avdb2db add_source -src host:port -srcname srcname [-desc desc]

Arguments

Argument	Description
`-src` `host:port`	Enter the source database connection information: host name and port number, separated by a colon. Typically, the host is the fully qualified domain name or IP address of the server on which the IBM DB2 source database is running, and the port number is 50000.
`-srcname` `srcname`	Create a name to associate with this source database. Remember that the source database name is case-sensitive. Oracle Audit Vault uses this name to connect to the IBM DB2 source database.
`-desc` `desc`	Enter a brief description of the source database. Optional.

Usage Notes

The avdb2db add_source command prompts for a user name and password. This user account must have privileges to run the IBM DB2 db2audit command (for example, a user who has the sysadmin privilege).

Example

The following example shows how to register a source with Oracle Audit Vault.

$ avdb2db add_source -src lnxserver:50000 -srcname db2db4 -desc 'HR Database'
Enter a username : source_user_name
Enter a password : password

***** Source Verified *****
***** Source Added Successfully *****

11.4 alter_collector

The avdb2db alter_collector command modifies the attributes of a DB2 collector.

Where to Run This Command

Audit Vault Server

Syntax

avdb2db alter_collector -srcname srcname -collname collname 
       [attrname=attrvalue...attrname=attrvalue]

Arguments

Argument	Description
`-srcname` `srcname`	Enter the name of the source database to which this collector belongs. Remember that the source database name is case-sensitive.
`-collname` `collname`	Enter the name of the collector to be modified.
`attrname=attrvalue`	Enter the attribute pair (attribute name, new attribute value) for mutable collector property and attributes for this collector type. This argument is optional. Separate multiple pairs by a space on the command line.

Usage Notes

You can modify one or more collector attributes at a time. Table 11-2 lists the collector attributes, whether the parameter is mutable, its default value, and a brief description. You can enter these settings in any case; they not case sensitive.

Table 11-2 DB2 Collector Attributes

Attribute	Description	Mutable	Default Value
`DESCRIPTION`	The description for this collector	Yes	`NULL`
`DBCONNECTION`	Number of connections to the database	No	`1`
`DELAY_TIME`	The delay time (in milliseconds) of the collector	Yes	`20000`
`NO_OF_RECORDS`	The maximum number of records to be fetched by the collector	Yes	`1000`
`SINGLE_FILEPATH`	The location of the directory where the DB2 collector will look for files to collect audit records from, or the location to which the DB2 extraction utility writes the text files. Enter an absolute path only, not a relative path.	Yes	`NULL`

Examples

The following example shows how to alter the NO_OF_RECORDS attribute and the collector description for the DB2Collector collector in Oracle Audit Vault:

$ avdb2db alter_collector -srcname db2db4 -collname DB2Collector 
NO_OF_RECORDS=1500 DESCRIPTION="IBM DB2 collector 9" 

***** Collector Altered Successfully *****

11.5 alter_source

The avdb2db alter_source command modifies the attributes of an IBM DB2 source database.

Where to Run This Command

Audit Vault Server

Syntax

avdb2db alter_source -srcname srcname 
      [attrname=attrvalue...attrname=attrvalue]

Arguments

Argument	Description
`-srcname` `srcname`	Enter the name of the source database to be modified. Remember that the source database name is case-sensitive.
`attrname=attrvalue`	Enter the attribute pair (attribute name, new attribute value) for mutable source properties and attributes for this source type. This argument is optional. Separate multiple pairs by a space on the command line. See Table 11-3 for more information.

Usage Notes

Table 11-3 lists the source database attributes, a brief description of the attribute, whether the attribute is mutable, and the default value. You can modify one or more source attributes at a time.

Table 11-3 Source Attributes

Attribute	Description	Mutable	Default Value
`SOURCETYPE`	The source type name for this source database. The default name is DB2DB.	No	`NULL`
`NAME`	The name for this source database.	No	`NULL`
`HOST`	The source database host name.	No	`NULL`
`HOST_IP`	The source database host IP address.	No	`NULL`
`VERSION`	The source database version.	Yes	`NULL`
`DESCRIPTION`	A new description for this source database.	Yes	`NULL`
`PORT`	A new port number for this system where the source database audit data resides	Yes	None

Example

The following example shows how to alter the DESCRIPTION attribute for the source database named db2db4 in Oracle Audit Vault:

$ avdb2db alter_source -srcname db2db4 DESCRIPTION="HR Database" 

***** Source Altered Successfully *****

11.6 drop_collector

The avdb2db drop_collector command disables (but does not remove) a DB2 collector from Oracle Audit Vault.

Where to Run This Command

Audit Vault Server

Syntax

avdb2db drop_collector -srcname srcname -collname collname

Arguments

Argument	Description
`-srcname` `srcname`	Enter the name of the source database to which the collector (specified in the `-collname` argument) belongs. Remember that the source database name is case-sensitive.
`-collname` `collname`	Enter the name of the collector to be dropped from Oracle Audit Vault.

Usage Notes

The drop_collector command does not delete the collector from Oracle Audit Vault. It only disables the collector. The collector metadata is still in the database after you run the drop_collector command. If you want to recreate the collector, create it with a different name.

Example

The following example shows how to drop a collector named DB2Collector from Oracle Audit Vault:

$ avdb2db drop_collector -srcname db2db4 -collname DB2Collector

***** Collector Dropped Successfully *****

11.7 drop_source

The avdb2db drop_source command disables (but does not remove) an IBM DB2 source database from Oracle Audit Vault.

Where to Run This Command

Audit Vault Server

Syntax

avdb2db drop_source -srcname srcname

Arguments

Argument	Description
`-srcname` `srcname`	Enter the name of the source database to be dropped from Oracle Audit Vault. Remember that the source database name is case-sensitive.

Usage Notes

The drop_source command does not delete the source database from Oracle Audit Vault. It only disables the source database definition in Oracle Audit Vault. The source database metadata is still in the database after you run the drop_source command. If you want to re-create the source database definition, create it with a different name.
You cannot drop a source database if there are any active collectors for this source. You must drop all collectors associated with the source database before you can run the drop_source command on it.

Example

The following example shows how to drop the source named db2db4 from Oracle Audit Vault:

$ avdb2db drop_source -srcname db2db4 

***** Drop Source Successfully *****

11.8 -help

The avdb2db -help command displays help information for the AVDB2DB commands.

Where to Run This Command

Either Audit Vault Server or collection agent home

Syntax

avdb2db -help

avdb2db command -help

Arguments

Argument	Description
`command`	Enter the name of an `AVDB2DB` command for which you want help to appear.

Usage Notes

None

Example

The following example shows how to display general AVDB2DB utility help in Oracle Audit Vault:

avdb2db -help

The following example shows how to display specific AVDB2DB help for the add_source command in the Audit Vault Server home shell.

$ avdb2db add_source -help
  avdb2db add_source command
 
    add_source
          -src <host:port> -srcname <srcname> 
          [-desc <desc>]
 
  Purpose: The source is added to Audit Vault.
 
  Arguments:
       -src        : Source DB connection information
       -srcname    : Name of a source 
       -desc       : Optional description of the source
 
  Examples:
     avdb2db add_source -src lnxserver:50000
        -desc 'HR Database'

11.9 setup

The avdb2db setup command adds the IBM DB2 source user credentials to the wallet, creates a database alias in the wallet for the source user, and verifies the connection to the source using the wallet. You also can use this command to change the source user credentials in the wallet after these credentials have been changed in the source database.

Where to Run This Command

Audit Vault collection agent home

Syntax

avdb2db setup -srcname srcname

Arguments

Argument	Description
`-srcname` `srcname`	Enter the name of the IBM DB2 source database. Remember that the source database name is case-sensitive.

Usage Notes

If you installed the collection agent on a Microsoft Windows computer, run the avdb2db setup command from the ORACLE_HOME\bin directory. For UNIX or Linux installations, set the appropriate environment variables before running this command. See Section 2.2 for more information.
The avdb2db setup command prompts for a user name and password. This user account must have privileges to run the IBM DB2 db2audit command (for example, a user who has the sysadmin privilege).

Example

$ avdb2db setup -srcname db2db4 
Enter a username : source_user_name
Enter a password : password

***** Credentials Successfully added *****

11.10 verify

The avdb2db verify command verifies that the IBM DB2 source database is compatible for setting up the specified collectors.

Where to Run This Command

Either Audit Vault Server or collection agent home

Syntax

avdb2db verify -src host:port:database_name

Arguments

Argument	Description
`-src` `host:port:database_name`	Enter the source database connection information: host name and port number, separated by a colon. Typically, the host is the fully qualified domain name or IP address of the server on which the IBM DB2 source database is running, and the port number is 50000. The `database_name` setting refers to the name of the DB2 source database.

Usage Notes

The avdb2db verify command checks the following:
- Whether the version of the database is supported: Versions 8.2 through 9.5
- Whether the source user has the required privileges in the source database that is to be registered with Oracle Audit Vault
- Whether auditing is enabled in the source database
- Whether the operating system on which the source database is running is supported
If you installed the collection agent on a Microsoft Windows computer and want to run the avdb2db verify command from there, run it from the ORACLE_HOME\bin directory. For UNIX or Linux installations, set the appropriate environment variables before running this command. See Section 2.2 for more information.
The avdb2db verify command prompts for a user name and password. This user account must have privileges to run the IBM DB2 db2audit command (for example, a user who has the sysadmin privilege).

Example

The following example verifies that the source database is compatible with the DB2 collector on a Linux or UNIX system.

$ avdb2db verify -src 192.0.2.7:50000:sales_db
Enter a username : source_user_name
Enter a password : password

***** Source Verified *****