InfoScale™ 9.0 Agent for Oracle Installation and Configuration Guide - Linux

Last Published:
Product(s): InfoScale & Storage Foundation (9.0)
Platform: Linux
  1. Introducing the Cluster Server agent for Oracle
    1.  
      About the Cluster Server agent for Oracle
    2.  
      About the agent for Oracle ASM
    3.  
      Supported software for VCS agent for Oracle
    4. How the agent makes Oracle highly available
      1.  
        How the Oracle and Netlsnr agents support intelligent resource monitoring
      2.  
        How the agent makes Oracle ASM instance highly available
      3.  
        How the agent supports Oracle container databases (CDBs) and pluggable databases (PDBs)
    5. About Cluster Server agent functions for Oracle
      1. Oracle agent functions
        1.  
          Startup and shutdown options for the Oracle agent
        2.  
          Monitor options for the Oracle agent in traditional database and container database
        3.  
          Startup and shutdown options for the pluggable database (PDB)
        4.  
          Monitor for the pluggable database
        5.  
          Recommended startup modes for pluggable database (PDB) based on container database (CDB) startup modes
        6.  
          How the agent handles Oracle error codes during detail monitoring
        7.  
          Info entry point for Cluster Server agent for Oracle
        8.  
          Action entry point for Cluster Server agent for Oracle
        9. How the Oracle agent supports health check monitoring
          1.  
            Generating the executable required for Oracle health check monitoring
          2.  
            Prerequisites for linking Oracle libraries using the build_oraapi.sh script
          3.  
            Considerations for running build_oraapi.sh
          4.  
            Building Oracle agent executable using build_oraapi.sh
      2.  
        Netlsnr agent functions
      3. ASMInst agent functions
        1.  
          ASMInst agent Startup options
        2.  
          ASMInst agent Shutdown options
      4.  
        ASMDG agent functions
    6.  
      Typical Oracle configuration in a VCS cluster
    7.  
      About setting up Oracle in a VCS cluster
  2. Installing and configuring Oracle
    1.  
      About installing Oracle in a VCS environment
    2.  
      Before you install Oracle in a VCS environment
    3. About VCS requirements for installing Oracle
      1.  
        Location of the $ORACLE_HOME
      2.  
        Failing over Oracle after a VCS node failure during hot backup
    4. About Oracle installation tasks for VCS
      1.  
        Installation tasks for $ORACLE_HOME on shared disks
      2.  
        Installation tasks for $ORACLE_HOME on local disks
      3.  
        Installation tasks for Oracle using ASM
    5. Installing ASM binaries in a VCS environment
      1.  
        Configuring VCS to support Oracle Restart function
    6. Configuring Oracle ASM on the first node of the cluster
      1.  
        Enabling the clustering daemon for ASM-managed database
      2.  
        Disabling automatic startup of ASM
    7.  
      Configuring and starting up ASM on remaining nodes
    8. Installing Oracle binaries on the first node of the cluster
      1.  
        Disabling the clustering daemon
    9.  
      Configuring the Oracle database
    10.  
      Copying the $ORACLE_BASE/admin/SID directory
    11.  
      Copying the Oracle ASM initialization parameter file
    12.  
      Verifying access to the Oracle database
  3. Installing and removing the agent for Oracle
    1.  
      Before you install or upgrade the agent for Oracle
    2.  
      Installing the VCS agent for Oracle software
    3. Upgrading the VCS agent for Oracle
      1.  
        Upgrading VCS agent for Oracle
    4.  
      Disabling the Cluster Server agent for Oracle
    5.  
      Removing the Cluster Server agent for Oracle
  4. Configuring VCS service groups for Oracle
    1.  
      About configuring a service group for Oracle
    2. Configuring Oracle instances in VCS
      1.  
        Configuring a single Oracle instance in VCS
      2.  
        Configuring multiple Oracle instances (single listener) in VCS
      3.  
        Configuring multiple Oracle instances (multiple listeners) in VCS
      4.  
        Configuring an Oracle instance with shared server support in VCS
    3. Before you configure the VCS service group for Oracle
      1.  
        Importing the type definition files for Cluster Server agent for Oracle
    4. Configuring the VCS service group for Oracle
      1.  
        Configuring the VCS service group for Oracle using Cluster Manager (Java console)
      2. Configuring the VCS service group for Oracle using the command-line
        1.  
          Encrypting Oracle database user and listener passwords
      3. Setting up detail monitoring for VCS agents for Oracle
        1. Setting up detail monitoring for Oracle
          1.  
            Enabling and disabling detail monitoring for Oracle resource
        2.  
          Setting up detail monitoring for Netlsnr
      4. Enabling and disabling intelligent resource monitoring for agents manually
        1.  
          Administering the AMF kernel driver
  5. Administering VCS service groups for Oracle
    1.  
      About administering VCS service groups
    2.  
      Bringing the service group online
    3.  
      Taking the service group offline
    4.  
      Switching the service group
    5.  
      Modifying the service group configuration
  6. Pluggable database (PDB) migration
    1.  
      Migrating Pluggable Databases (PDB) between Container Databases (CDB)
  7. Troubleshooting Cluster Server agent for Oracle
    1.  
      About troubleshooting Cluster Server agent for Oracle
    2.  
      Error messages common to the Oracle and Netlsnr agents
    3.  
      Error messages specific to the Oracle agent
    4.  
      Error messages specific to the Netlsnr agent
    5.  
      Error messages specific to the ASMInst agent
    6.  
      Error messages specific to the ASMDG agent
    7.  
      Troubleshooting issues specific to Oracle in a VCS environment
    8. Verifying the Oracle health check binaries and intentional offline for an instance of Oracle
      1.  
        Verifying the intentional offline behavior of the VCS Oracle agent
    9.  
      Disabling IMF for a PDB resource
  8. Appendix A. Resource type definitions
    1.  
      About the resource type and attribute definitions
    2. Resource type definition for the Oracle agent
      1.  
        Resource type definition for systemD Support
      2.  
        Attribute definitions for the Oracle agent
      3.  
        About the Sid attribute in a policy managed database
      4. Using systemD attributes for Oracle application service
        1.  
          Adding key-value pairs to SystemDAttrList attribute
        2.  
          Customizing the Oracle service unit file with systemD attributes
        3.  
          Configuring HugePages for Oracle on Linux
    3. Resource type definition for the Netlsnr agent
      1.  
        Attribute definition for the Netlsnr agent
    4. Resource type definition for the ASMInst agent
      1.  
        Resource type definition for the ASMInst agent to support systemD
      2.  
        Attribute definition for the ASMInst agent
    5. Resource type definition for the ASMDG agent
      1.  
        Attribute definition for the ASMDG agent
  9. Appendix B. Sample configurations
    1.  
      About the sample configurations for Oracle enterprise agent
    2. Sample single Oracle instance configuration
      1.  
        Sample VCS configuration file for single Oracle instance
    3. Sample multiple Oracle instances (single listener) configuration
      1.  
        Sample VCS configuration file for multiple Oracle instances (single listener)
    4. Sample multiple instance (multiple listeners) configuration
      1.  
        Sample VCS configuration file for multiple Oracle instances (multiple listeners)
    5. Sample Oracle configuration with shared server support
      1.  
        Sample VCS configuration file for Oracle instance configured with shared server support
    6. Sample Oracle ASM configurations
      1. Sample configuration for ASM disks as raw disks
        1.  
          Sample VCS configuration file for ASM-managed Oracle instance
      2. Sample configuration for ASM disks as VxVM volumes
        1.  
          Sample VCS configuration file for ASM disks as VxVM disks
      3. Sample configuration for ASM disks as CVM volumes
        1.  
          Sample VCS configuration file for ASM that uses CVM volumes
    7.  
      Sample configuration of Oracle pluggable database (PDB) resource in main.cf
    8.  
      Sample configuration of migratable Oracle pluggable database (PDB) resource in main.cf
    9.  
      Sample Configuration of Oracle supported by systemD
    10.  
      Sample configuration of ASMInst supported by systemD
  10. Appendix C. Best practices
    1.  
      Best practices for multiple Oracle instance configurations in a VCS environment
  11. Appendix D. Using the SPFILE in a VCS cluster for Oracle
    1.  
      About the Oracle initialization parameter files
    2.  
      Starting an Oracle instance
    3.  
      Using the SPFILE in a VCS cluster
  12. Appendix E. OHASD in a single instance database environment
    1.  
      About OHASD in a single instance database environment
    2.  
      Configuring the Application agent to make OHASD highly available

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.

DBAUser

string-scalar

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

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:

Arctera 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

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 ASMInst agent lists the internal attribute for ASMInst agent. This attribute is for internal use only. Arctera 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