Symantec logo

Oracle attribute definitions

Review the description of the Oracle agent attributes. The agent attributes are classified as required, optional, and internal.

Required attributes

Required attributes for Oracle agent lists the required attributes. You must assign values to the required attributes.

Required attributes for Oracle agent

Required attributes

Type and dimension

Definition

Sid 

string-scalar 

The variable $ORACLE_SID that represents the Oracle instance. The Sid is considered case-sensitive by the Oracle agent and by the Oracle database server. 

Owner 

string-scalar 

The Oracle user, as the defined owner of executables and database files in /etc/passwd. 

Home 

string-scalar 

The $ORACLE_HOME path to Oracle binaries and configuration files. For example, you could specify the path as /opt/ora_home.  


  Note   Do not append a slash (/) at the end of the path.


Optional attributes

Optional attributes for Oracle agent lists the optional attributes for Oracle agent. You can configure the optional attributes if necessary.

Optional attributes for Oracle agent

Optional Attributes

Type and Dimension

Definition

ContainerType 

string-scalar 

For future use. Do not configure the attribute. 

StartUpOpt 

string-scalar 

Startup options for the Oracle instance. This attribute can take the following values: 

  • STARTUP
  • STARTUP_FORCE
  • RESTRICTED
  • RECOVERDB
  • SRVCTLSTART
  • CUSTOM

Default is STARTUP_FORCE. 

See Startup options 

ShutDownOpt 

string-scalar 

Shut down options for the Oracle instance. This attribute can take the following values: 

  • IMMEDIATE
  • TRANSACTIONAL
  • SRVCTLSTOP
  • CUSTOM

Default is IMMEDIATE. 

See Shutdown options 

EnvFile 

string-scalar 

The full path name of the file that is sourced by the entry point scripts. This file contains the environment variables set by the user for the Oracle database server environment such as LD_LIBRARY_PATH, NLS_DATE_FORMAT, and so on.  

The syntax for the contents of the file depends on the login shell of Owner. File must be readable by Owner. The file must not contain any prompts for user input. 

Pfile 

string-scalar 

The name of the initialization parameter file with the complete path of the startup profile. 

You can also use the server parameter file. Create a one-line text initialization parameter file that contains only the SPFILE parameter. See the Oracle documentation for more information. 

See Using the SPFILE in a VCS cluster 

AutoEndBkup 

integer-scalar 

Setting the AutoEndBkup attribute to a non-zero value takes the datafiles in the database out of the backup mode, during Online. 

Default = 1 

See Hot backup of Oracle database and VCS

MonitorOption 

integer-scalar 

Monitor options for the Oracle instance. This attribute can take values 0 or 1. 

  • 0 - Process check monitoring (recommended)
  • 1 - Health check monitoring

Default = 0 

See Monitor options for Oracle agent 

DetailMonitor 

integer-scalar 

Setting this flag to a non-zero enables detail monitoring for Oracle. The value indicates the number of monitor cycles after which the agent will monitor Oracle in detail. For example, the value 5 indicates that the agent will monitor Oracle in detail every five monitor intervals. 

Default = 0 

MonScript  

string-scalar 

Pathname to the script provided for detail monitoring. The default (basic monitoring) is to monitor the database PIDs only. 


  Note   Detail monitoring is disabled if the value of the attribute MonScript is invalid or is set to an empty string.


The pathname to the supplied detail monitor script is /opt/VRTSagents/ha/bin/Oracle/SqlTest.pl. 

MonScript also accepts a pathname relative to /opt/VRTSagents/ha. A relative pathname should start with "./", as in the path ./bin/Oracle/SqlTest.pl. 

User  

string-scalar 

Internal database user. Connects to the database for detail monitoring. 

Pword  

string-scalar 

Encrypted password for internal database-user authentication. 

Encrypt passwords only when entering them using the command-line. Passwords must be encrypted using the VCS Encrypt utility. 

See Encrypting passwords

Table  

string-scalar 

Table for update by User/Pword

Encoding 

string-scalar 

Specifies operating system encoding that corresponds to Oracle encoding for the displayed Oracle output. For example, if Oracle output is in "JAPANESE_JAPAN.JA16EUC," then "eucJP" is the Solaris value for Encoding. Refer to the Oracle and Solaris documentation for respective encoding values. Default is "". 

AgentDebug 

boolean-scalar 

Additional debug messages are logged when this flag is set. 

Default = 0 

ContainerName 

string-scalar 

For future use. Do not configure the attribute. 

Internal attribute

Internal attributes for Oracle agent lists the internal attribute for Oracle agent. This attribute is for internal use only. Symantec recommends not to modify the value of this attribute.

Internal attributes for Oracle agent

Optional Attributes

Type and Dimension

Definition

AgentDirectory 

static-string 

Specifies the location of binaries, scripts, and other files related to the Oracle agent.  

Default is /opt/VRTSagents/ha/bin/Oracle.