Attribute definition for the ASMInst agent

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

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

Table: Required attributes for ASMInst agent

Required attributes

Type and dimension

Definition

Sid

string-scalar

The variable $ORACLE_SID that represents the ASM instance. The Sid is considered case-sensitive by the ASMInst agent.

Owner

string-scalar

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

The agent also supports LDAP users as Oracle user.

Home

string-scalar

The $ORACLE_HOME path to Oracle ASM 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 ASMInst agent lists the optional attributes for ASMInst agent. You can configure the optional attributes if necessary.

Table: Optional attributes for ASMInst agent

Optional Attributes

Type and Dimension

Definition

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 of ASM instance 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.

MonitorOption

integer-scalar

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

  • 0 - Process check monitoring (recommended)

  • 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

DBAUser

string-scalar

The ASM user who has sysasm privileges to start or stop the ASM instance. You can create ASM users for Oracle 11g R1 and later.

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.

See Encrypting Oracle database user and listener passwords.

Encoding

string-scalar

Specifies operating system encoding that corresponds to Oracle encoding for the displayed Oracle output. Default is "".

StartUpOpt

string-scalar

Startup option for the Oracle ASM instance. The agent uses the sqlplus command to start the Oracle ASM instance.

This attribute can take the following values:

  • STARTUP

  • STARTUP_MOUNT

  • STARTUP_OPEN

  • SRVCTLSTART

  • SRVCTLSTART_MOUNT

  • SRVCTLSTART_OPEN

Default is "STARTUP".

Note:

recommends to use STARTUP or SRVCTLSTART option for ASMInst resource.

ShutDownOpt

string-scalar

Shut down option for the Oracle ASM instance. By default the agent uses the sqlplus command to stop the Oracle ASM instance. To stop the ASM instance using srvctl utility set the option to SRVCTLSTOP.

Default is "".

UseSystemD

(RHEL 7, SLES 12)

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 in RHEL 7 or SLES 12, 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

(RHEL 7, SLES 12)

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 ASMInst agent lists the internal attribute for ASMInst agent. This attribute is for internal use only. Veritas recommends not to modify the value of this attribute.

Table: Internal attributes for ASMInst agent

Optional Attributes

Type and Dimension

Definition

AgentDirectory

static-string

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

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

More Information

Using the SPFILE in a VCS cluster

Monitor options for the ASMInst agent