Search <book_title>...

Cluster Server 8.0.2 Agent for Oracle Installation and Configuration Guide - Linux

Last Published: 2024-01-09

Product(s): InfoScale & Storage Foundation (8.0.2)

Platform: Linux

Attribute definitions for the Oracle agent

The Oracle agent attributes are classified as required, optional, and internal.

You must assign values to the following 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.

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.

You can configure the following optional attributes if they are necessary for your configuration.

Table: Optional attributes for Oracle agent

Optional Attributes	Type and Dimension	Definition
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 for traditional database and container database: STARTUP STARTUP_FORCE RESTRICTED RECOVERDB SRVCTLSTART CUSTOM SRVCTLSTART_FORCE Default is STARTUP_FORCE. Startup options for the Oracle instance in pluggable database. This attribute can take the following values: STARTUP STARTUP_FORCE RESTRICTED OPEN_RO
ShutDownOpt	string-scalar	Shut down options for the Oracle instance. This attribute can take the following values for traditional database and container database: IMMEDIATE TRANSACTIONAL SRVCTLSTOP CUSTOM SRVCTLSTOP_TRANSACT SRVCTLSTOP_ABORT SRVCTLSTOP_IMMEDIATE Default is IMMEDIATE. Shut down options for the Oracle instance in pluggable database 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. Note: It is mandatory from Oracle 21c and later versions for a client to configure .env file path in EnvFile attribute. This file must have ORACLE_BASE path added to work on Oracle virtual firedrill feature. Sample EnvFile content with ORACLE_BASE path for Oracle 21c [root@inaqalnx013 Oracle]# cat /opt/VRTSagents/ha/bin/Oracle/envfile ORACLE_BASE="/u02/app/oracle/product/21.0.0/dbhome_1/"; export ORACLE_BASE; Sample attribute value EnvFile = "/opt/VRTSagents/ha/bin/Oracle/envfile"
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. Note: This attribute is applicable only for traditional and container databases.
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 Note: If a node fails during a hot backup of container database or pluggable database, you must set AutoEndBkup attribute of the corresponding CDB resource to 1. When the AutoEndBkup is set to 1 for the CDB, it also ends the backup of both CDB and PDB during Online. See About VCS requirements for installing Oracle.
MonitorOption	integer-scalar	Monitor options for the Oracle instance. This attribute can take values 0 or 1. For traditional and container databases: 0 - Process check monitoring (recommended) 1 - Health check monitoring For pluggable databases: 0 - Basic monitoring You must set the value of this attribute as 1 to use the intentional offline functionality of the agent. Default = 0 The agent supports intelligent resource monitoring only for traditional and CDBs when the attribute value is set to 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 Note: IMF is supported only in traditional and container databases. 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: Second-level 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 8.0.2 agent, and if you had enabled detail monitoring in the previous version, set the value of the LevelTwoMonitorFreq attribute appropriately. 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`). Note: This attribute is not applicable for PDB resources.
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 "". Note: This attribute is not applicable for PDB resources.
IntentionalOffline		This resource-type level attribute defines how VCS reacts when Oracle is intentionally stopped outside of VCS control. If you stop Oracle traditional and container database 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 in the CDB. Note: If a CDB resource is configured with IntentionalOffline, and the configured CDB is brought down outside the VCS control, then the PDB resources will also report as offline. To enable this functionality, set the IntentionalOffline attribute to 1 for the PDB resource. See the 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.
PDBName	string-scalar	This attribute must be configured for a PDB. And the value should be set for a PDB database name. For traditional and CDB database, do not set this attribute.
UseSystemD	Boolean	systemD is a system and service manager for Linux operating systems. It helps manage applications across Linux distributions that support systemD feature. When Online Entry point is invoked with `UseSystemD` attribute enabled, the Oracle resource comes online as a service in system.slice. Without the `UseSystemD` attribute enabled, a typical online entry point starts the resource in user.slice. Consideration: Upon a system reboot, if application resource has been started under user.slice, there is a possibility that the processes are not stopped gracefully. This may cause the database to corrupt. This behavior is different for each Oracle application version. Hence, enable UseSystemD attribute for Oracle on you system. The application process can be viewed as *vcs-<resource_name>.service*, in /etc/systemd/system. Set the `UseSystemD` value to 0 or 1.
SystemDAttrList	string-scalar	Ensure that `UseSystemD` is enabled before you set the key-value pairs in the `SystemDAttrList` attribute. For more information, refer to the Red Hat website to know more about the different limits you can apply to the application. For example, # hares -modify oracle SystemDAttrList LimitLOCKS 44433 Where, LimitLOCKS is the key and 44433 is the value for the key.

Table: Internal attributes for Oracle agent lists the internal attribute for Oracle agent. This attribute is for internal use only. Veritas 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.

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 pluggable database (PDB)