Cluster Server 7.3.1 Agent for Oracle Installation and Configuration Guide - Solaris

Last Published:
Product(s): InfoScale & Storage Foundation (7.3.1)
Platform: Solaris
  1. Introducing the Cluster Server agent for Oracle
    1. About the Cluster Server agent for Oracle
      1.  
        About the agent for Oracle ASM
    2.  
      Supported software for VCS agent for Oracle
    3.  
      Changes introduced in the 7.3.1 release
    4. How the agent makes Oracle highly available
      1.  
        How the Oracle and Netlsnr agents support intelligent resource monitoring
      2.  
        How the agent monitors Oracle instances running in Solaris zones
      3.  
        How the agent makes Oracle ASM instance highly available
      4.  
        How the agent supports container database (CDB) and pluggable database (PDB) in Oracle 12C
    5. About Cluster Server agent functions for Oracle
      1. Oracle agent functions
        1.  
          Startup and shutdown options for the Oracle agent
        2.  
          Startup and shutdown options for the pluggable database (PDB)
        3.  
          Recommended startup modes for pluggable database (PDB) based on container database (CDB) startup modes
        4.  
          Monitor options for the Oracle agent in traditional database and container database
        5.  
          Monitor for the pluggable database
        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.  
            Considerations to run the build_oraapi.sh script
          3.  
            Building the Oracle agent executable using the build_oraapi.sh script
      2.  
        Netlsnr agent functions
      3. ASMInst agent functions
        1.  
          ASMInst agent Startup options
        2.  
          ASMInst agent Shutdown options
        3.  
          Monitor options for the ASMInst agent
      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.  
        Replacing the long pathnames for $ORACLE_HOME in the agent attributes
      3.  
        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 for Oracle 11gR2 or 12c 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.  
        Enabling Oracle Cluster Synchronization Service daemon to start automatically
    7.  
      Configuring and starting up ASM on remaining nodes for 11gR2 or 12c
    8. Installing Oracle binaries on the first node of the cluster
      1.  
        Disabling the clustering daemon for Oracle 10g or later
    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 to use with VCS 7.3.1
    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
    5. 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
    6. 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.  
        Attribute definition for the Oracle agent
      2.  
        About the Sid attribute in a policy managed database
    3. Resource type definition for the Netlsnr agent
      1.  
        Attribute definition for the Netlsnr agent
    4. Resource type definition for the ASMInst agent
      1.  
        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 configuration for Oracle instances in Solaris zones
      1.  
        Zone root on local disk for single Oracle instance
      2.  
        Zone root on shared disk for single Oracle instance
      3.  
        Zone root on local disk for multiple Oracle instances
      4.  
        Zone root on shared disk for multiple Oracle instances
      5.  
        Zone root on local disk for Oracle instance with shared server support
      6.  
        Zone root on shared disk for Oracle instance with shared server support
      7.  
        Oracle instance in the context of project
      8.  
        Sample VCS configuration file for zone root on local disk or on shared disk
    7. 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
    8.  
      Sample configuration of Oracle pluggable database (PDB) resource in main.cf
    9.  
      Sample configuration of migratable Oracle pluggable database (PDB) resource in main.cf
    10.  
      Sample Configuration of Oracle supported by systemD
    11.  
      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 Netlsnr agent

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

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

Table: Required attributes for Netlsnr agent

Required attributes

Type and dimension

Definition

Owner

string-scalar

The Oracle user who has privileges to start or stop the listener process.

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.

Do not append a slash (/) at the end of the path.

Table: Optional attributes for Netlsnr agent lists the optional attributes for Netlsnr agent. You can configure the optional attributes if necessary.

Table: Optional attributes for Netlsnr agent

Optional attributes

Type and dimension

Definition

ContainerOpts

static-assoc-int

This resource-type level attribute specifies the container options for Netlsnr instances running in the context of Solaris containers (zones or projects).

These values are only effective when you set the ContainerInfo service group attribute. recommends that you do not change the following values.

  • RunInContainer (RIC)

    1 - The Netlsnr agent monitors the listener processes that run inside of the local container.

    0 - The Netlsnr agent monitors the listener processes that run outside the local container (in the global environment).

    Default is 1.

  • PassCInfo (PCI)

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

    Default is 0.

See the Cluster Server Administrator's Guide and the Veritas InfoScale 7.3.1 Solutions Virtualization Guide.

TnsAdmin

string-scalar

The $TNS_ADMIN path to directory in which the Listener configuration file resides (listener.ora).

Default is /var/opt/oracle.

Listener

string-scalar

Name of Listener. The name for Listener is considered case-insensitive by the Netlsnr agent and the Oracle database server.

Default is LISTENER.

LsnrPwd

string-scalar

The VCS encrypted password used to stop and monitor the listener. This password is set in the Listener configuration file.

Encrypt passwords only when entering them using the command-line. Passwords must be encrypted using the VCS Encrypt utility.

EnvFile

string-scalar

Specifies 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 listener environment such as LD_LIBRARY_PATH and so on.

The syntax for the contents of the file depends on the login shell of Owner. This file must readable by Owner. The file must not contain any prompts for user input.

IMF

integer-association

This resource-type level attribute determines whether the Netlsnr 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 attribute to a non-zero value in some cases where the agent requires to perform poll-based resource monitoring in addition to the intelligent resource 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 netlsnr_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. By default, the detail monitoring is enabled to monitor the listener process.

Note:

If the value of the attribute MonScript is set to an empty string, the agent disables detail monitoring.

The pathname to the supplied detail monitoring script is /opt/VRTSagents/ha/bin/Netlsnr/LsnrTest.pl.

MonScript also accepts a pathname relative to /opt/VRTSagents/ha. A relative pathname should start with "./", as in the path ./bin/Netlsnr/LsnrTest.pl.

LevelTwoMonitorFreq

integer-scalar

Specifies the frequency at which the agent for this resource type must perform second-level or detailed monitoring.

If you enabled detail monitoring, then set the value of the LevelTwoMonitorFreq attribute.

Default = 0

Encoding

string-scalar

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

For example, if Oracle output is in "JAPANESE_JAPAN.JA16EUC," then "eucJP" is the Solaris value for Encoding. Refer to the Oracle and Solaris documentation for respective encoding values.

Default is "".

IntentionalOffline

 

For future use.

Do not change the value of this attribute.

Default = 0

Table: Internal attributes for Netlsnr agent lists the internal attribute for Netlsnr agent. This attribute is for internal use only. Veritas recommends not to modify the value of this attribute.

Table: Internal attributes for Netlsnr agent

Optional Attributes

Type and Dimension

Definition

AgentDirectory

static-string

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

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

More Information

Encrypting Oracle database user and listener passwords