Configuring the agent by using the silent response file

The silent response file contains the agent configuration parameters. You can edit the silent response file to modify the values of these parameters, and run the configuration script to create an instance or update the agent configuration values. This mode of configuration is called the silent mode.

About this task

The silent response file contains the agent configuration parameters with default values that are defined for some parameters. You can edit the silent response file to specify different values for the configuration parameters.

After you update the configuration values in the silent response file, you must run the configuration script to configure the agent with these updated values.

Procedure

Open the oracle_silent_config.txt file in a text editor:

Linux®/UNIX®:

<install_dir>/samples/oracle_database_silent_config.txt

Windows®:

<install_dir>\samples\oracle_database_silent_config.txt

For Default Username, type the name of the default database user for database connections that are created for this agent instance. For example, KRZ_CONN_USERID=user1.

Note: This user must have sufficient privileges to complete the tasks that this agent does while it is connected to the database, such as querying tables.
For Default Password, you must enter the password that is associated with the specified default database user. For example, KRZ_CONN_PASSWORD=Password.
Enter the Oracle JDBC Jar File. It is the full path to the Oracle JDBC driver jar file used to communicate with the Oracle database.

The Oracle Java® Database Connectivity (JDBC) driver that supports the Oracle database versions that are monitored by the Oracle agent must be available on the agent computer.
Leave the Net Configuration Files Directories field blank and thus the default directory is used. The Oracle Database agent uses this file path to obtain the tnsnames.ora file. This directory is defined by the TNS_ADMIN environment variable for each Oracle database instance. The default directory is $ORACLE_HOME/network/admin or %ORACLE_HOME%\NETWORK\ADMIN. If you enter this setting with multiple net configuration file directories, use ;for Windows® or : for Linux®/UNIX® to separate the directories.

If you are monitoring Oracle databases remotely, you can copy net configuration files from the remote system to the system where the agent is installed. Also, you can merge the content of net configuration files on the remote system to the net configuration files on the system where the agent is installed.
For Dynamic listener, check if the default dynamic listener is configured. The default dynamic listener is (PROTOCOL=TCP)(HOST=localhost)(PORT=1521). If the default dynamic listener is configured, set this value to TRUE as shown here: KRZ_DYNAMIC_LISTENER=TRUE.

The valid values are TRUE and FALSE.
Leave the Customized SQL definition file name blank. It is not used.
Beginning here the actual database connection instances are defined. You need to add at least one. Entries for one instance are given in the oracle_silent_config.txt with the instance name config1. If you change the instance name, be sure to change all references.

This alias can be anything that you choose to represent the database connection with the following restrictions. Only letters, Arabic numerals, the underline character, and the minus character can be used in the connection name. The maximum length of a connection name is 25 characters.
For Connection Type, specify one of the following connection types: Basic, TNS, or Advanced. For example, KRZ_CONN_TYPE.config1=Basic.
For the connection type that you selected in the previous step, specify the required parameters:
- Basic
  - For Hostname, specify the host name or the IP address of the Oracle database, for example: KRZ_CONN_HOST.config1=hostname.
  - For Port, specify the Listener port for the Oracle database, for example: #KRZ_CONN_PORT.config1=1521.
  - For Service Name, specify the logical representation of the database by using a string for the global database name, for example: KRZ_CONN_SERVICE.config1=orcl.
    
    Important: If you do not define the Service Name, you must specify the Oracle System Identifier (SID).
    
    For the Oracle System Identifier (SID), specify an SID that identifies a specific instance of a running database, for example: KRZ_CONN_SID.config1sid.
- TNS
  
  For TNS alias, specify the Network alias name from the tnsnames.ora file. For example, KRZ_CONN_TNS.config1=tnsalias.
- Advanced
  
  For Oracle Connection String, specify the database connection string for OCI. For example, KRZ_CONN_STR.config1=//host:port/service
  
  This string supports all Oracle Net naming methods as shown here.
  1. For an SQL Connect URL string:
```
 //host:[port][/service name]
```
  2. For an Oracle Net keyword-value pair:
```
 "(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp) (HOST=dlsun242) (PORT=1521)) (CONNECT_DATA=(SERVICE_NAME=bjava21)))"
```
    This string also supports TNSNAMES entries, for example, inst1 where the TNS_ADMIN or the ORACLE_HOME environment variable is set and the configuration files are configured.
    
    Important: This attribute applies only to the advanced type of connection.
For Database Username, you can specify the name of the database user for the connection, for example: KRZ_CONN_USERID=UserID.

This user must have sufficient privileges to complete the tasks that the agent requires while it is connected to the database, for example, creating, editing, and deleting tables.

If this field is empty, the agent uses the default username in the default database configuration section. If Database Username was not configured, the default user name is used for this connection.
For Database Password, you can specify the password that is associated with the specified database user, for example: KRZ_CONN_PASSWORD=Passsword.

If this field is empty, the agent uses the default password in the default database configuration section.

If Database Password was not configured, the default password is used for this connection.
For Role, you can specify the set of privileges that are associated with the connection, for example: KRZ_CONN_MODE.config1=DEFAULT.

The valid values include SYSDBA, SYSOPER, SYSASM, and DEFAULT.

For a user that is granted the SYSDBA system privilege, you can specify a connection that includes this privilege. If this item is not defined, you can assign the DEFAULT role to the user.
For Oracle Alert Log File Paths, when the alert log file name is included, you can specify the absolute file path of the mapped alert log files for the remote database instances in this database connection. For example, KRZ_LOG_PATHS.config1=AlertLogPath.

For Windows®, use a semicolon (;) to separate the multiple files.

For Linux®/UNIX®, use a colon (:) to separate the multiple files.

Each file is matched to a database instance by the alert_instance.log file name pattern. Alternatively, it is ignored if it is not matched.

The local database instance alert log files are discovered automatically.

If Oracle Alert Log File Paths was not configured, the Alert Log is not available.
For Oracle Alert Log File Charset, you can specify the code page of the mapped alert log files. For example, KRZ_LOG_CHARSET.config1=CharSet.

If this field is empty, the system's current locale setting is used as shown here:
```
ISO8859_1: ISO 8859-1 Western European encoding
UTF-8: UTF-8 encoding of Unicode
GB18030: Simplified Chinese GB18030 encoding
CP950: Traditional Chinese encoding
EUC_JP: Japanese encoding
```
Save and close the oracle_database_silent_config.txt file. Enter the command:
```
<install_dir>/bin/oracle_database-agent.sh config <instance_name> <install_dir>/samples/oracle_database_silent_config.txt
```
Where <instance_name> is the name that you want to give to the instance.

To start the agent, enter the command:

<install_dir>/bin/oracle_database-agent.sh start <instance_name>

Configuring the agent by using the silent response file

About this task

Procedure

What to do next