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

Last Published:
Product(s): InfoScale & Storage Foundation (8.0.2)
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. Configuring VCS service groups for Oracle using the Veritas High Availability Configuration wizard
    1.  
      Typical VCS cluster configuration in a virtual environment
    2.  
      About configuring application monitoring using the Veritas High Availability solution for VMware
    3.  
      Getting ready to configure VCS service groups using the wizard
    4.  
      Before configuring application monitoring
    5.  
      Launching the Veritas High Availability Configuration wizard
    6.  
      Configuring the agent to monitor Oracle
    7. Understanding service group configurations
      1.  
        Resource dependency
      2.  
        Service group dependency
      3.  
        Infrastructure service groups
    8. Understanding configuration scenarios
      1.  
        Configuring a single instance/multiple instances in VCS
      2.  
        Configuring multiple Oracle instances in VCS using multiple runs of the wizard
      3.  
        Configuring multiple applications
    9.  
      Veritas High Availability Configuration wizard limitations
    10. Troubleshooting
      1.  
        Veritas High Availability Configuration wizard displays blank panels
      2.  
        The Veritas High Availability Configuration wizard displays the 'hadiscover is not recognized as an internal or external command' error
      3.  
        Running the 'hastop - all' command detaches virtual disks
      4.  
        Log files
    11. Sample configurations
      1.  
        Sample VCS configuration file for single Oracle instance (VxVM)
      2.  
        Sample VCS configuration file for single Oracle instance (LVM)
  6. 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
  7. Pluggable database (PDB) migration
    1.  
      Migrating Pluggable Databases (PDB) between Container Databases (CDB)
  8. 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
  9. 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
  10. 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
  11. Appendix C. Best practices
    1.  
      Best practices for multiple Oracle instance configurations in a VCS environment
  12. 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
  13. 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

Action entry point for Cluster Server agent for Oracle

The Cluster Server agent for Oracle supports the Action entry point, which enables you to perform predefined actions on a resource.

To perform an action on a resource, type the following command:

    # hares -action res token [-actionargs arg1 ...] \
    [-sys system] [-clus cluster]

You can also add custom actions for the agent.

For further information, refer to the Cluster Server Agent Developer’s Guide.

See Table: Predefined virtual fire drill actions. describes the agent's predefined virtual fire drill actions.

Table: Predefined agent actions describes the agent's predefined actions.

Table: Predefined agent actions

Action

Description

VRTS_GetInstanceName

Retrieves the name of the configured instance. You can use this option for the Oracle and the Netlsnr resources.

VRTS_GetRunningServices

Retrieves the list of processes that the agent monitors. You can use this option for the Oracle and the Netlsnr resources.

DBRestrict

Changes the database session to enable the RESTRICTED mode.

DBUndoRestrict

Changes the database session to disable the RESTRICTED mode.

DBSuspend

Suspends a database.

DBResume

Resumes a suspended database.

DBTbspBackup

Backs up a tablespace; actionargs contains name of the tablespace to be backed up.

Note:

VRTS_GetRunningServices, DBRestrict, DBResume, DBSuspend, DBTbspBackup, and DBUndoRestrict action entry points are not supported for Oracle PDB resources.

Table: Predefined virtual fire drill actions lists the virtual fire drill actions of the Cluster Server agent for Oracle that lets you run infrastructure checks and fix specific errors.

Table: Predefined virtual fire drill actions

Virtual fire drill action

Description

getid

(Oracle agent)

Verifies that the Oracle Owner exists on the node.

home.vfd

(Oracle agent)

Verifies the following:

  • ORACLE_HOME is mounted on the node and corresponding entry is in the fstab.

    If the ORACLE_HOME is not mounted, the action entry point checks if any other resource has already mounted ORACLE_HOME.

  • Pfile is provided and it exists on the node.

  • Password file from $ORACLE_HOME/dbs/orapw[SID] is present.

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"

owner.vfd

(Oracle agent)

Verifies the uid and gid of the Oracle Owner attribute. Checks if uid and gid of Owner attribute is the same on the node where the Oracle resource is currently ONLINE.

pfile.vfd

(Oracle agent)

Checks for the presence of pfile or spfile on the local disk. If both pfile and spfile are not present, the agent function exits. If the Oracle resource is online in the cluster, the agent function logs a message that the spfile must be on the shared storage because the Oracle resource is online.

tnsadmin.vfd

(Netlsnr agent)

Checks if listener.ora file is present. If the listener.ora file is not present, it checks if ORACLE_HOME is mounted and displays appropriate messages.