Attribute definition for the Oracle agent


Attribute definition for the Oracle agent
Prev	Resource type definition for the Oracle agent	Next

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

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

Table: 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.

The agent also supports LDAP users as Oracle user.

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.

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

Table: Optional attributes for Oracle agent

Optional Attributes

Type and Dimension

Definition

StartUpOpt

string-scalar

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

STARTUP
STARTUP_FORCE
RESTRICTED
RECOVERDB
CUSTOM
SRVCTLSTART
SRVCTLSTART_RO

Default is STARTUP_FORCE.

ShutDownOpt

string-scalar

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

IMMEDIATE
TRANSACTIONAL
CUSTOM
SRVCTLSTOP
SRVCTLSTOP_TRANSACT
SRVCTLSTOP_ABORT
SRVCTLSTOP_IMMEDIATE

Default is IMMEDIATE.

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.

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 About ApplicationHA requirements for installing Oracle.

MonitorOption

integer-scalar

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

0 - Process check monitoring
1 - Health check monitoring

You must set the value of this attribute as 1 to use the intentional offline functionality of the agent.

Default = 0

IMF

integer-association

This resource-type level attribute determines whether the Oracle agent must perform intelligent resource monitoring. You can also override the value of this attribute at resource-level.

This attribute includes the following keys:

Mode: Define this attribute to enable or disable intelligent resource monitoring.

Valid values are as follows:
- 0 - Does not perform intelligent resource monitoring
- 1 - Performs intelligent resource monitoring for offline resources and performs poll-based monitoring for online resources
- 2 - Performs intelligent resource monitoring for online resources and performs poll-based monitoring for offline resources
- 3 - Performs intelligent resource monitoring for both online and for offline resources
Default: 3
MonitorFreq: This key value specifies the frequency at which the agent invokes the monitor agent function. The value of this key is an integer.

Default: 5

You can set this key to a non-zero value for cases where the agent requires to perform both poll-based and intelligent resource monitoring. If the value is 0, the agent does not perform poll-based process check monitoring.

After the resource registers with the AMF kernel driver, the agent calls the monitor agent function as follows:
- After every (MonitorFreq x MonitorInterval) number of seconds for online resources
- After every (MonitorFreq x OfflineMonitorInterval) number of seconds for offline resources
RegisterRetryLimit: If you enable intelligent resource monitoring, the agent invokes the oracle_imf_register agent function to register the resource with the AMF kernel driver. The value of the RegisterRetryLimit key determines the number of times the agent must retry registration for a resource. If the agent cannot register the resource within the limit that is specified, then intelligent monitoring is disabled until the resource state changes or the value of the Mode key changes.

Default: 3

LevelTwoMonitorFreq

integer-scalar

This resource-type level attribute specifies the frequency at which the agent for this resource type must perform second-level or detailed monitoring.

You can also override the value of this attribute at resource-level. The value indicates the number of monitor cycles after which the agent must perform second-level or detailed monitoring.

For example, the value 5 indicates that the agent will perform detailed monitoring every five online monitor intervals.

Note:

Upgrade from Symantec ApplicationHA 5.1 SP2 to Symantec ApplicationHA 6.1 fails if the DetailMonitor attribute had been used for detailed monitoring. If you are upgrading to Symantec ApplicationHA 6.1, set the value of the DetailMonitor attribute to the LevelTwoMonitorFreq attribute and reset the value of the DetailMonitor attribute to 0.

Note:

If you set the AutoEndBkup attribute value to 0, then make sure that the LevelTwoMonitorFreq attribute value is set to 1 for detail monitoring.

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 path of 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 ApplicationHA Encrypt utility.

Table

string-scalar

Table for update by User/Pword.

IntentionalOffline

static-boolean

This resource-type level attribute defines how VCS reacts when Oracle is intentionally stopped outside of VCS control.

If you stop Oracle out of VCS control, the agent behavior is as follows:

0 - The Oracle agent registers a fault and initiates the failover of the service group.
1 - The Oracle agent takes the Oracle resource offline when Health check monitoring is enabled.

If Health check monitoring is not enabled, the agent registers a fault and initiates the failover of the service group.

Note:

If you want to use the intentional offline functionality of the agent, you must set the value of the MonitorOption attribute as 1 to enable Health check monitoring.

Default = 0

See Symantec ApplicationHA User's Guide.

PDBName

string-scalar

PDBName must be configured for a pluggable database (PDB) and the value must be set for the PDB name. For traditional database and container database (CDB), do not set this attribute.

Table: 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.

Table: 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.

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.