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

Attribute definition for the Oracle agent

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.

For a policy managed database, the Sid attribute should be set to Sid prefix.

Owner

string-scalar

The Oracle user who has privileges to start or stop the database instance.

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

ContainerOpts

static-assoc-int

This resource-type level attribute specifies the container options for the Oracle instances that run in the context of AIX WPARs.

The values for the following keys are only effective when you set the ContainerInfo service group attribute. Symantec recommends that you do not change the following values.

  • RunInContainer (RIC)

    1 - The Oracle agent monitors the Oracle instances that run inside of the local container.

    0 - The Oracle agent monitors the Oracle instances that run outside the local container (in the global environment).

    Default is 1.

  • PassCInfo (PCI)

    The Oracle agent receives the container information that is defined in the service group's ContainerInfo attribute.

    Default is 0.

See the Symantec Cluster Server Administrator's Guide and the Symantec Storage Foundation and High Availability Solutions Virtualization Guide.

DBAUser

string-scalar

The database user who has sysdba privileges to start or stop the database.

DBAPword

string-scalar

Encrypted password for DBAUser.

Encrypt passwords only when entering them using the command-line. Passwords must be encrypted using the VCS Encrypt Utility (/opt/VRTSvcs/bin/vcsencrypt).

StartUpOpt

string-scalar

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

  • STARTUP

  • STARTUP_FORCE

  • RESTRICTED

  • RECOVERDB

  • SRVCTLSTART

  • SRVCTLSTART_RO

  • CUSTOM

Default is STARTUP_FORCE.

ShutDownOpt

string-scalar

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

  • IMMEDIATE

  • TRANSACTIONAL

  • SRVCTLSTOP

  • SRVCTLSTOP_TRANSACT

  • SRVCTLSTOP_ABORT

  • SRVCTLSTOP_IMMEDIATE

  • CUSTOM

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

boolean-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 VCS 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.

The agent supports intelligent resource monitoring only when this attribute value is set to 0.

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

See Enabling and disabling intelligent resource monitoring for agents manually.

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.

LevelTwoMonitorFreq

integer-scalar

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 will monitor Oracle in detail. For example, the value 5 indicates that the agent will monitor Oracle in detail every five online monitor intervals.

If you manually upgraded to the VCS 6.1 agent, and if you had enabled detail monitoring in the previous version, then do the following:

  • Set the value of the LevelTwoMonitorFreq attribute to the same value of that of the DetailMonitor attribute.

Note:

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

Default = 0

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 (/opt/VRTSvcs/bin/vcsencrypt).

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.

Default is "".

IntentionalOffline

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.

See the Symantec Cluster Server Administrator’s Guide.

DBName

string-scalar

Set this attribute only when the database is a policy managed RAC database. The value of this attribute must be set to the database unique name.

ManagedBy

string-scalar

Default value for this attribute is ADMIN. In a policy managed RAC database this attribute must be set to POLICY.

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.

More Information

About the Sid attribute in a policy managed database

Encrypting Oracle database user and listener passwords

Startup and shutdown options for the Oracle agent

Startup and shutdown options for the Oracle agent

Using the SPFILE in a VCS cluster

Failing over Oracle after a VCS node failure during hot backup

Monitor options for the Oracle agent

Encrypting Oracle database user and listener passwords

Prev Up Next
Resource type definition for the Oracle agent Home About the Sid attribute in a policy managed database