Target AVCLI Commands

The AVCLI target commands enable you to configure both database and nondatabase targets for Audit Vault Server.

The terms TARGET and SECURED TARGET are generally synonymous in this release of Oracle Database Security Central.

About the Target AVCLI Commands

The target AVCLI commands enable you to perform tasks such as registering or altering a target.

ALTER TARGET

Use the ALTER TARGET command to modify the attributes of targets.

The ALTER TARGET command modifies the attributes of a target.

Syntax

ALTER TARGET <target_name>
   SET <attribute>=<value> [, <attribute>=<value>]

Arguments

Argument Description

Argument	Description
attribute`=`value	The key/value pair for the target attributes of the target to be modified. You can modify one or more target attributes at a time using a space on the command line. See Also: Table A-5 for target attributes. Audit Collection Attributes as some types of targets also require collection attributes. LIST ATTRIBUTE FOR TARGET to find a list of attribute values for a target.
service	REQUIRED FOR ORACLE DATABASE ONLY: The service name or SID

attribute=value

The key/value pair for the target attributes of the target to be modified. You can modify one or more target attributes at a time using a space on the command line.

Attribute	Description
`NAME`	The name of the target database to be modified. The name is case-sensitive. This must not be defined already in the Audit Vault Server for another target. Special characters (`&<>"/;,*\|=% --`) cannot be used for target names. See Also: LIST TARGET to find a list of existing targets.
`LOCATION`	The location of the target. Note: In case the target location was not specified during registration and if credentials are required to connect to the target, then the credentials must be specified along with the target location.
`CREDENTIALS`	The new username used to connect to the target. Audit Vault Server prompts for the new password. Credentials in `/` format is accepted through a `.av` file.
`DESCRIPTION`	The description for this target database instance
`MAXIMUM_ENFORCEMENT_POINT_THREADS`	The maximum number of monitoring point threads for the target. The valid range is between 1 and 16 (inclusive). The default value is 1.

General Usage Examples

avcli> ALTER TARGET sample_source SET name=sample_source2;

The target name of sample_source changed to sample_source2.

avcli> ALTER TARGET sample_source SET credentials=scott;

The credentials used to connect to the target, sample_source, are changed.

avcli> ALTER TARGET sample_source SET description='This is a new description';

Number of monitoring point threads is set for target, sample_source.

avcli> ALTER TARGET sample_source SET maximum_enforcement_point_threads=14;

The description for the target, sample_source, is changed.

avcli> ALTER TARGET sample_source set maximum_enforcement_point_threads = 10;

Sets the maximum number of monitoring point threads for target sample_source to 10.

Oracle Example:

avcli> ALTER TARGET target sample_source set
 location=jdbc:oracle:thin:@//new_sample_host:1521:sample_db;

The location of the target, sample_source, changes.

DROP TARGET

Learn how to use the DROP TARGET command to remove the registration of a specified target from Oracle Audit Vault Server.

The DROP TARGET command removes the registration of the specified target from Audit Vault Server.

Syntax

DROP TARGET <target_name>

Arguments

Argument	Description
target_name	The name of the target. To find all registered targets, see “LIST TARGET”.

Usage Notes

Ensure that all trails associated with this target are in stopped state before dropping the target. Otherwise, the DROP TARGET command fails. See HELP STOP COLLECTION for an explanation of how to stop active trails.

Dropping a target stops the Audit Vault Server from monitoring it. Any audit data collected earlier continues to be available in the Audit Vault Server repository.

Examples

avcli> DROP TARGET sample_source;

Drops the sample_source target.

LIST ATTRIBUTE FOR TARGET

Use the LIST ATTRIBUTE FOR TARGET command to list the attributes of targets.

The LIST ATTRIBUTE FOR TARGET command lists the attributes of a given target.

Syntax

LIST ATTRIBUTE FOR TARGET target name;

Arguments

Argument	Description
target name	The name of the target. To find all registered targets, see “LIST TARGET”.

LIST AUDITORUSERS OF TARGET GROUP

This command lists the various auditors of a target group specified by <target-group>. Outputs the auditor name.

Syntax

LIST AUDITORUSERS OF TARGET GROUP <target-group>;

Example

avcli> LIST AUDITORUSERS OF TARGET GROUP tg1;

LIST METRICS

Use the LIST METRICS command to list the metrics of a given target, such as various trails.

The LIST METRICS command lists the metrics of a given target, such as various trails.

Syntax

LIST METRICS FOR TARGET <target_name>

Arguments

Argument	Description
target_name	The name of the target To find all registered targets, see "LIST TARGET".

Argument

Description

target_name

The name of the target

To find all registered targets, see "LIST TARGET".

Usage Notes

The LIST METRICS command has the same usage for all target types.

Examples

avcli> LIST METRICS FOR TARGET sample_source;

Metrics available for the target, sample_source, are listed.

LIST TARGET

Use the LIST TARGET command to list various active targets that are registered with Audit Vault Server.

The LIST TARGET command lists the active targets registered with the Audit Vault Server.

Syntax

LIST TARGET;

Lists the active target names registered with Audit Vault Server.

LIST TARGET TYPE

Use the LIST TARGET TYPE command to list various target types that are registered with Audit Vault Server.

The LIST TARGET TYPE command lists various target types currently registered in the Audit Vault Server.

Syntax

LIST TARGET TYPE

Example

avcli> list target type;

Lists various target type names currently registered with the Audit Vault Server.

REGISTER TARGET

Use the REGISTER TARGET command to register targets to be monitored by Audit Vault Server.

The REGISTER TARGET command registers a target to be monitored by Audit Vault Server.

Syntax

REGISTER TARGET <secured_target_name> OF TARGET TYPE <secured_target_type> [AT <location>] [AUTHENTICATED BY <username>] [DEPLOYMENT MODE deployment mode]

Arguments

Argument	Description
securedtargetname	Name of target. Must be unique. Special characters (`&<>"/;,*\|=% --`) cannot be used for target names.
secured_target_type	A valid target type, for example `"Oracle"`. See Also: LIST TARGET TYPE to find a list of supported target types.
location	The target database connection information. See Also: ALTER TARGET This is optional. It can be added later. The location is an opaque string that specifies how to connect to the target, typically a JDBC connect string. The syntax that you use depends on the target type. See the database-specific Usage Notes below. If location is not provided, certain features such as entitlement retrieval, audit settings management, SPA retrieval, and audit trail collection are disabled if applicable to this target type.
user_name	Optional. Credentials to connect to the target. After you enter the `username` argument, Audit Vault Server prompts you for the password of the target user account. For target databases, this account must exist on the target database. Optional. See the database specific usage notes in the following sections.
DEPLOYMENT MODE	Optional. Deployment mode of target. For Oracle Database having Active Data Guard with Unified Auditing, specify the `DEPLOYMENT MODE` as `ADG`. For additional information, refer to Additional Information for Audit Collection from Oracle Active Data Guard.

General Examples

avcli> HELP REGISTER TARGET;

Displays detailed help for the REGISTER TARGET command.

Oracle Database Usage Notes and Examples

Authentication credentials must be specified along with the target location if credentials are required to connect to the target.
For the location argument, enter the host name, port number, and service ID (SID), separated by a colon. Use the following syntax:

AT host:port:service

JDBC connect string format for different target types are specified below. For example:

Oracle Database: jdbc:oracle:thin:@//<host>:<port>/<service name | SID>

IBM DB2 DBARS and IBM DB2 LUW: jdbc:av:db2://<host>:<port>/<database name>

MySQL: jdbc:av:mysql://<host>:<port>/mysql
If you are unsure of this connection information, then run the lsnrctl status listener_name command on the computer where you installed the target database.
For the AUTHENTICATED BY command, enter the user name, and Audit Vault Server prompts you for the password. AUTHENTICATED BY <username>/<password> is accepted from file input through .av file. This user account must exist in the target database.

To find this user, query the SESSION_PRIVS and SESSION_ROLES data dictionary views.
For Oracle Database having Active Data Guard with Unified Auditing, specify the DEPLOYMENT MODE as ADG.

Oracle Database Examples

avcli> REGISTER TARGET sample_source OF TARGET TYPE "Oracle Database"
   AT jdbc:oracle:thin:@//anymachinename:1521/example.com
   AUTHENTICATED BY system DEPLOYMENT MODE ADG;

Registers an Oracle target, sample_source, of target type Oracle Database, reachable using connect string jdbc:oracle:thin:@//anymachinename: 1521/example.com using credentials system and deployment mode ADG.

SQL Server Example With DB

avcli > REGISTER TARGET sample_mssqldb OF TARGET TYPE "Microsoft SQL Server" AT jdbc:av:sqlserver://hostname:port authenticated by <user>;

SQL Server Example with Windows Authentication

avcli > REGISTER TARGET sample_mssqldb OF TARGET TYPE "Microsoft SQL Server" AT "jdbc:av:sqlserver://<Host Name>:<Port>;authenticationMethod=ntlmjava;domain=<domain name>" authenticated by <windows user>;

IBM DB2 Example

avcli> REGISTER TARGET sample_db2db OF TARGET TYPE "IBM DB2 LUW" AT jdbc:av:db2://host:port authenticated by sa;

Registers a DB2 target, sample_db2db, of target type "IBM DB2 LUW", reachable using connect string jdbc:av:db2://host:port using credentials authenticated by sa.

UPLOAD OR DELETE WALLET FILE

Use the UPLOAD OR DELETE WALLET FILE to upload or delete target wallet files.

This command is used to upload and delete a target wallet file.

Syntax

ALTER TARGET <Target name> SET WALLET_FILE=<Path of the wallet file>

ALTER TARGET <Target name> DROP ATTRIBUTE WALLET_FILE

Arguments

Argument	Description
`<Target name>`	Name of the target.
`WALLET_FILE`	Name of wallet attribute (Key).
`<Path of the wallet file>`	Path to wallet file (Value).

Examples

alter target mysource set wallet_file=/dir1/dir2/wallet.sso;

Uploads the target wallet file to the specified location of the Audit Vault Server using a TCPS connection.

alter target mysource drop attribute wallet_file;

Deletes the target wallet from the location using a TCPS connection.

Target AVCLI Commands

About the Target AVCLI Commands

ALTER TARGET

Syntax

Arguments

General Usage Examples

Oracle Example:

DROP TARGET

Syntax

Arguments

Usage Notes

Examples

LIST ATTRIBUTE FOR TARGET

Syntax

Arguments

LIST AUDITORUSERS OF TARGET GROUP

Syntax

Example

LIST METRICS

Syntax

Arguments

Usage Notes

Examples

LIST TARGET

Syntax

LIST TARGET TYPE

Syntax

Example

REGISTER TARGET

Syntax

Arguments

General Examples

Oracle Database Usage Notes and Examples

Oracle Database Examples

SQL Server Example With DB

SQL Server Example with Windows Authentication

IBM DB2 Example

Related Topics

UPLOAD OR DELETE WALLET FILE

Syntax

Arguments

Examples