Skip Headers
Oracle® Audit Vault Administrator's Guide
Release 10.3

E23571-08
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

11 Audit Vault Sybase ASE (AVSYBDB) Utility Commands

Use the Audit Vault Sybase Database (AVSYBDB) command-line utility to manage the relationship between Oracle Audit Vault and a Sybase ASE source database and collector. When you run these commands, remember the following:

Table 11-1 describes the AVSYBDB 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 AVSYBDB 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 AVSYBDB 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 avsybdb

The AVSYBDB command-line utility, which you use to configure a Sybase ASE database with Oracle Audit Vault.

Syntax

avsybdb command -help

avsybdb command [options] arguments

Arguments

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

Usage Notes

Issuing an AVSYBDB command generates the following log file: $ORACLE_HOME/av/log/srcname-sybdb-#.log. The # 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 avsybdb add_collector command adds a SYBDB collector for a Sybase ASE 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:

  • UNIX: Set the appropriate environment variables, as described in Section 2.2.2.

  • Microsoft Windows: Go to the Audit Vault Server ORACLE_HOME\bin directory.

Syntax

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

Arguments

Argument Description
-srcname srcname Enter the name of the source database 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 Sybase ASE source database is running, and the port number is 5000.

-agentname agentname Enter the name of the collection agent that was created when you ran the avca add_agent command. (In most cases, this is the agent that you created when you installed the Audit Vault collection agent, as described in Oracle Audit Vault Collection Agent Installation Guide.)

If you are not sure of the agent name, then you can find it as follows: Log in to the Audit Vault Console, click the Configuration tab, and then click the Agent tab to display the Agents page. The name of the agent is displayed in the Agent column.

-collname collname Create a name for the SYBDB collector. Optional. If you do not create a name, Oracle Audit Vault names the collector SybaseCollector.
-desc desc Enter a brief description of the collector. Optional.

Usage Notes

  • Run any collector-specific preparation scripts before you execute the avsybdb add_collector command.

  • The avsybdb add_collector command prompts for the source user name and password. This user account must exist on the source database.

Example

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

avsybdb add_collector -srcname sybdb4 -agentname agent1 
Enter a username : source_user_name
Enter a password : password

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

11.3 add_source

The avsybdb add_source command registers a Sybase ASE source database with Oracle Audit Vault for audit data consolidation.

Where to Run This Command

Audit Vault Server:

  • UNIX: Set the appropriate environment variables, as described in Section 2.2.2.

  • Microsoft Windows: Go to the Audit Vault Server ORACLE_HOME\bin directory.

Syntax

avsybdb 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 Sybase ASE source database is running, and the port number is 5000.

-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 Sybase ASE source database.
-desc desc Enter a brief description of the source database. Optional.

Usage Notes

The avsybdb add_source command prompts for the source user name and password. This user account must exist on the source database.

Example

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

avsybdb add_source -src lnxserver:5000 -srcname sybdb4 -desc 'HR Database'
Enter a username : source_user_name
Enter a password : password

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

11.4 alter_collector

The avsybdb alter_collector command modifies the attributes of a SYBDB collector.

Where to Run This Command

Audit Vault Server:

  • UNIX: Set the appropriate environment variables, as described in Section 2.2.2.

  • Microsoft Windows: Go to the Audit Vault Server ORACLE_HOME\bin directory.

Syntax

avsybdb 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.

Enclose the attribute value in double quotation marks. For multiple values, enclose the entire set in double quotation marks and separate each value with a space. For example:

...="value1 value2 value3"

Usage Notes

  • You can modify one or more collector attributes at a time. Table 11-2 lists the collector attributes, whether the attribute is mutable, its default value, and a brief description.

  • Note the following case-sensitivity guidelines for specifying attributes:

    • Except for the AGENTNAME attribute, the attribute names are case sensitive. Enter them in upper-case letters.

    • All the attribute values, including the AGENTNAME attribute value, are case sensitive. Enter them in the case shown the following tables.

Table 11-2 SYBDB Collector Attributes

Attribute Description Mutable Default Value

AGENTNAME

Name of an agent to replace the agent that was specified by the avsybdb add_collector command that was used for this source database. This feature enables you to move a collector from one agent to another. It is useful for failover recovery if the host computer running the original agent fails. When you enter a value for AGENTNAME, enter it using the same case that you used when you ran the avca add_agent command.

After you replace the agent, you must run the avsybdb setup command and avctl start_collector command. See "Examples" for more information.

Yes

NULL

DESCRIPTION

The description for this collector. The value you enter is not case sensitive.

Yes

NULL

DBCONNECTION

Number of connections to the database

No

1

DELAY_TIME

The delay time (in milliseconds) for the SYBDB collector to sleep when it has no records to process at a particular time. After sleeping for this amount of time, the collector wakes up and checks to see if any events have arrived.

Yes

20000 (20 seconds)

ACTIVE_DELAY_TIME

The delay time (in milliseconds) in retrieving events from an active database. For example, suppose you set ACTIVE_DELAY_TIME to 10000 (for 10 seconds). Audit Vault will begin to capture events that are generated now (with the event time as current timestamp) only 10 seconds after now. The reason for this setting is that Audit Vault queries for events in between timestamp ranges (for example, fromTtimestamp 1 to Timestamp 2). This setting ensures that all events in this range are available for querying. It prevents the case in which events that have Timestamp 2 are in the process of being retrieved but are not available when an auditor tries to generate a report that includes the events.

A typical value that you may want to enter is between 2000 and 10000 milliseconds.

Yes

5000 (5 seconds)

NO_OF_RECORDS

The maximum number of records to be fetched by the collector

Yes

1000


Examples

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

avsybdb alter_collector -srcname sybdb4 -collname SybaseCollector 
NO_OF_RECORDS=1500 DESCRIPTION="Sybase collector 45" 

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

The following sequence of commands demonstrate how to move a collector from one collection agent to another agent:

  1. From the Audit Vault Server, configure two agents, A and B, on two separate hosts.

    For example:

    avca add_agent -agentname A -agenthost host1.example.com
    
    Adding agent...
    Enter agent user name: agent_user_name
    Enter agent user password: agent_user_pwd
    Re-enter agent user password: agent_user_pwd
    
    avca add_agent -agentname B -agenthost host2.example.com
    ...
    
  2. Configure collector L to run under agent A and collect from source S.

    For example:

    avorcldb add_collector -collname L -srcname S -agentname A
    
  3. The node that runs agent A fails.

  4. Move the collector L from agent A to agent B.

    For example:

    avorcldb alter_collector -collname L -srcname S agentname=B
    
  5. From the Audit Vault collection agent home, configure agent B to connect to source S.

    For example:

    avorcldb setup -srcname S
    
    Enter Source user name: source_user_name
    Enter Source password: password
    ...
    
  6. From the Audit Vault Server, restart the collector.

    For example:

    avctl start_collector -collname L -srcname S
    
    Starting Collector...
    Collector started successfully.
    

11.5 alter_source

The avsybdb alter_source command modifies the attributes of the Sybase ASE source database.

Where to Run This Command

Audit Vault Server:

  • UNIX: Set the appropriate environment variables, as described in Section 2.2.2.

  • Microsoft Windows: Go to the Audit Vault Server ORACLE_HOME\bin directory.

Syntax

avsybdb 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 SYBDB.

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 reside

Yes

None


Example

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

avsybdb alter_source -srcname sybdb4 DESCRIPTION="HR Database" 

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

11.6 drop_collector

The avsybdb drop_collector command disables (but does not remove) a SYBDB collector from Oracle Audit Vault. The drop_collector command does not delete the collector from Oracle Audit Vault; instead, it disables the collector. Therefore, you can neither add a collector by the same name as the one that was dropped nor enable a collector that has been dropped.

Where to Run This Command

Audit Vault Server:

  • UNIX: Set the appropriate environment variables, as described in Section 2.2.2.

  • Microsoft Windows: Go to the Audit Vault Server ORACLE_HOME\bin directory.

Syntax

avsybdb 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 the collector named SybaseCollector from Oracle Audit Vault:

avsybdb drop_collector -srcname sybdb4 -collname SybaseCollector

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

11.7 drop_source

The avsybdb drop_source command disables (but does not remove) a Sybase ASE source database from Oracle Audit Vault.

Where to Run This Command

Audit Vault Server:

  • UNIX: Set the appropriate environment variables, as described in Section 2.2.2.

  • Microsoft Windows: Go to the Audit Vault Server ORACLE_HOME\bin directory.

Syntax

avsybdb 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 sybdb4 from Oracle Audit Vault:

avsybdb drop_source -srcname sybdb4 

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

11.8 -help

The avsybdb -help command displays help information for the AVSYBDB commands.

Where to Run This Command

Either Audit Vault Server and collection agent:

  • UNIX: Set the appropriate environment variables, as described in Section 2.2.2 for Audit Vault Server or Section 2.2.3 for the collection agent.

  • Microsoft Windows: Go to the Audit Vault Server or collection agent ORACLE_HOME\bin directory.

Syntax

avsybdb -help

avsybdb command -help

Arguments

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

Usage Notes

None

Example

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

avsybdb -help

The following example shows how to display specific AVSYBDB Help for the add_source command in the Audit Vault Server home.

avsybdb add_source -help
  avsybdb 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:
     avsybdb add_source -src lnxserver:5000
        -desc 'HR Database'

11.9 setup

The avsybdb setup command adds the Sybase ASE 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:

  • UNIX: Set the appropriate environment variables, as described in Section 2.2.3.

  • Microsoft Windows: Go to the Audit Vault collection agent ORACLE_HOME\bin directory.

Syntax

avsybdb setup -srcname srcname

Arguments

Argument Description
-srcname srcname Enter the name of the 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 avsybdb 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 avsybdb setup command prompts for the source user name and password. This user account must exist on the source database.

Example

avsybdb setup -srcname sybdb4 
Enter a username : source_user_name
Enter a password : password

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

11.10 verify

The avsybdb verify command verifies that the Sybase ASE source database is compatible for setting up the specified collectors.

Where to Run This Command

Either Audit Vault Server and collection agent:

  • UNIX: Set the appropriate environment variables, as described in Section 2.2.2 for Audit Vault Server or Section 2.2.3 for the collection agent.

  • Microsoft Windows: Go to the Audit Vault Server or collection agent ORACLE_HOME\bin directory.

Syntax

avsybdb verify -src host:port

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 Sybase ASE source database is running, and the port number is 5000.


Usage Notes

  • The avsybdb verify command checks the following:

    • Whether the version of the database is supported: Sybase ASE 15.0.2 or Sybase ASE 12.5.4

    • 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 avsybdb 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 avsybdb verify command prompts for the source user name and password. This user account must exist on the source database.

Example

The following example verifies that the source is compatible with the SYBDB collector on a UNIX system.

avsybdb verify -src 192.0.2.7:5000
Enter a username : source_user_name
Enter a password : password
***** Source Verified *****