RDA 4 - HCVE Users' Guide and Available Rule Sets

RDA Documentation Links
Getting Started	FAQ	Man Pages	Troubleshooting Guide	Training	RDA Documentation Index

In This Document

HCVE 4.x Overview

Note: Please carefully review installation and execution instructions below. Prior standalone HCVE engine and rulesets is no longer available, the latest Health Check Validation Ruleset have now become part of RDA (Remote Diagnostic Agent) framework.

The HCVE rule engine is a tool that runs inside Remote Diagnostic Agent Framework.

Functional Overview

The purpose of HCVE is to provide a generic engine to execute assessment checks for customers and on the Oracle server side environment using very abstract rules provided by the product experts. These abstract rules are visible to the global support community and customers via our knowledge content repository. The methodology is patterned after work related to ANSI organization.

The Validation rules engine was built for the following reasons:

Develop and deploy solutions in short period of time
Provide the ability to gather environmental and system trace and configuration data based on the outcome of conditional validation tests.
Develop an architecture where support services derived rules can be easily managed and extended under a common framework.
Provide built-in self dependencies for all Rules and Rule sets (for example, prologue header information related to required input and output.)
Develop a re-usable macro finite state language API that can be used in assessment testing frameworks.

HCVE Rule sets

There is currently a limited number of rule sets / tests available covering following Supported Oracle products. The full collection of the most recent rule sets are are part of the RDA package which can be downloaded from here, see below on how to run HCVE from within RDA.

Pre-install check for 10g RDBMS (10.1.x)
- AIX Platforms - view
- HP-UX Platforms - view
- Linux Platforms - view
- Apple MAC OS X Platforms - view
- Tru64 Platforms - view
- Sun Solaris Platforms - view
Pre-install check for 10g RDBMS (10.2.x)
- AIX Platforms - view
- HP-UX Platforms - view
- Linux Platforms - view
- Sun Solaris Platforms - view
Pre-install check for 11g RDBMS (11.1.x)
- AIX Platforms - view
- HP-UX Platforms - view
- Linux Platforms - view
- Sun Solaris Platforms - view
Pre-install check for 11g RDBMS (11.2.x)
- AIX Platforms - view
- HP-UX Platforms - view
- Linux-x86 Platforms - view
- Sun Solaris Platforms - view
- Windows Platforms - view
Pre-install check for Oracle Application Server 10g (9.0.x)
- AIX Platforms - view
- HP-UX Platforms - view
- Linux Platforms - view
- Sun Solaris Platforms - view
Pre-install check for Oracle Application Server 10g R2 (10.1.2)
- HP-UX Platforms - view
- Linux Platforms - view
- Sun Solaris Platforms - view
Pre-install check for Oracle Application Server 10g R2 (10.1.3)
- Linux Platforms - view
Pre-install check for Oracle Fusion Middleware 11g R1 (11.1.1)
- AIX Platforms - view
- HP-UX Platforms - view
- Linux Platforms - view
- Sun Solaris Platforms - view
- Windows Platforms - view
Pre-install check for Oracle Portal
- All Platforms - view
Pre-install check for Oracle Identity Management 10g (10.1.4)
- AIX Platforms - view
- HP-UX Platforms - view
- Linux Platforms - view
- Sun Solaris Platforms - view
Pre-install check for Oracle Business Intelligence Enterprise Edition 11.1.1
- All Platforms - view
Network Charging and Control Preinstallation
- Sun Solaris Platforms - view
Pre-install check for Oracle E-Business Suite Release 11i (11.5.10)
- AIX Platforms - view
- HP-UX Platforms - view
- Linux-x86 Platforms - view
- Sun Solaris Platforms - view
Pre-install check for Oracle E-Business Suite Release 12 (12.1.1)
- AIX Platforms - view
- HP-UX Platforms - view
- Linux-x86 Platforms - view
- Sun Solaris Platforms - view
Oracle Enterprise Performance Management 11.1.2 Server Preinstall
- All Platforms - view
Oracle Enterprise Performance Management 11.1.2 Client Preinstall
- Windows Platforms - view
Post-install check for Oracle WebLogic Server 10
- All Platforms - view
Post-install check for Oracle WebLogic Server 12
- All Platforms - view
Post-install check for Oracle Portal
- All Platforms - view
Post-install check for Oracle Container for Java
- All Platforms - view
Post-install check for Oracle SOA 11g (11.1.1)
- All Platforms - view
Post-install check for Oracle OSB 11gR1 (11.1)
- All Platforms - view
RAC 10G DB and OS Best Practices
- Linux-x86 Platforms - view
Post-install check for Oracle Data Guard
- All Platforms - view
Post-install check for Network Charging and Control (DB)
- All Platforms - view
Post-install check for Network Charging and Control (System)
- Sun Solaris Platforms - view

Additional new Oracle products will be supported in future releases. We are constantly enhancing and refining HCVE/RDA, so make sure you have the latest version!

Download

The first step in order to utilize is the HCVE framework is to download the latest version of Remote Diagnostic Agent from Knowledge Article 314422.1.

Installation Instructions

Instructions for Installing RDA - UNIX type operating systems

Choose or create a directory/area that will be used exclusively for RDA on your Unix server. Make sure you have ample space for RDA output (~150MB) in that location you have chosen. It does not matter where you create this directory or what it is named, but it should be owned by the same user that will run RDA. Do not use a directory that contains an older version of RDA unless you have deleted the older version of RDA first; if need be prior setup files can be reused.

Note: Each rda package (.zip, .tar, and .tar.gz) will create a directory named " rda" containing all files for you when you extract it.
FTP the downloaded rda.tar, rda.tar.gz, or rda.zip file to your Unix server in binary mode and place it in the directory chosen in step 1.
Extract the tar or .tar.gz archive contents into a new directory (don't create a directory called "rda"), preserving the directory structure of the archive. Do not extract into a directory that contains an older RDA version.
Example:
tar xvf rda.tar
or
gunzip rda.tar.gz
tar xvf rda.tar
or
unzip rda.zip

Note: Each rda package (.zip, .tar, and .tar.gz) will create a directory named " rda" containing all files for you when you extract it.
Make sure the RDA command (rda.sh and rda.pl, noted as from now on) is executable. To verify, enter the following command:
chmod +x

Note: Do not extract the contents of the RDA archive (rda.tar and rda.tar.gz) on a Windows client first. If you do, you will have to remove the ^M characters from the end of each line in all of the shell scripts in order for them to run. You can verify the RDA installation using the following command:
-cv

Instructions for Installing RDA - Microsoft Windows based operating systems

Choose or create a directory/area that will be used exclusively for RDA on your server. Make sure you have ample space for RDA output (~150MB) in that location you have chosen. It does not matter where you create this directory or what it is named, but it should be owned by the same user that will run RDA. Do not use a directory that contains an older version of RDA unless you have deleted the older version of RDA first; if need be prior setup files can be reused.
FTP the downloaded rda.zip file to your Unix server in binary mode and place it in the directory chosen in step 1.
Extract the .zip archive contents into a new directory (don't create a directory called "rda"), preserving the directory structure of the archive. Do not extract into a directory that contains an older RDA version.
Example:
unzip *.zip

Note: Each rda package (.zip) will create a directory named " rda" containing all files for you when you extract it.

Running HCVE from the RDA framework

Note: It is impossible to tell how long HCVE will take to execute, as it depends on many variables, such as system activity, the options chosen, network settings, etc. On an average system, HCVE rule set should takes just a few minutes to run. Most scripts are designed to stop if for some reason they cannot complete within 30 seconds, (for example, the lsnrctl status command will stop if the listener is hung.) It is not unusual for HCVE rules to take 15 minutes or more on a very busy server.

Instructions for UNIX type operating systems:

Before you begin: Log on as the UNIX user that will own the Oracle installation. On some operating systems, this user will not have the necessary permissions to run all of the commands and utilities called by RDA (e.g. sar, top, vmstat, etc). If you are running RDA to assist in resolving a tar, the analyst will most likely need the information pertaining to the Oracle owner.

Note: If you use su to connect to root or a privileged user, do not use "su -" as the minus resets the environment.
Select the RDA command line script. that you will be using, either:

rda.sh Use this command if Perl is not available.

rda.pl Use the following command to verify Perl is installed and available in the path:

perl -V

Inspect the command output, checking that '.' (i.e. the current directory) is present in @INC section.

Note: The RDA command you selected above is represented as in the rest of this procedure. Therefore substitute rda.sh, rda.pl, or perl rda.pl
in place of .
The data collection requires an initial setup to determine which information should be collected. Enter the following command to initiate the set up:
-T hcve

Including the dot ensures that RDA is executed from the local directory.

At this point, you should see a list of HCVE rules sets that are available for your operating system, just select the test you want to perform. For Example, for a Linux x86 operating system you would see:

 
[test]$ perl rda.pl -T hcve
Processing HCVE tests ...
Available Pre-Installation Rule Sets:
   1. Oracle Database 10g R1 (10.1.0) Preinstall (Linux)
   2. Oracle Database 10g R2 (10.2.0) Preinstall (Linux)
   3. Oracle Database 11g R1 (11.1) Preinstall (Linux)
   4. Oracle Database 11g R2 (11.2.0) Preinstall (Linux)
   5. Oracle Application Server 10g (9.0.4) Preinstall (Linux)
   6. Oracle Application Server 10g R2 (10.1.2) Preinstall (Linux)
   7. Oracle Application Server 10g R3 (10.1.3) Preinstall (Linux)
   8. Oracle Fusion Middleware 11g R1 (11.1.1) Preinstall (Linux)
   9. Oracle Portal Preinstall (Generic)
  10. Oracle Identity Management 10g (10.1.4) Preinstall (Linux)
  11. Oracle Business Intelligence Enterprise Edition 11.1.1 Preinstall
  (Generic)
  12. Oracle E-Business Suite Release 11i (11.5.10) Preinstall (Linux x86 and
  x86_64)
  13. Oracle E-Business Suite Release 12 (12.1.1) Preinstall (Linux x86 and
  x86_64)
  14. Oracle Enterprise Performance Management 11.1.2 Server Preinstall
  (Generic)
Available Post-Installation Rule Sets:
  15. Oracle WebLogic Server 10 Post Installation (generic)
  16. Oracle WebLogic Server 12 Post Installation (generic)
  17. Oracle Portal Postinstall (generic)
  18. RAC 10G DB and OS Best Practices (Linux)
  19. Data Guard Postinstall (Generic)
Enter the HCVE rule set number
Hit 'Return' to accept the default (1)

The -d option flag can be added, it allows you to view the collection progression. For example like ./rda.sh -dT hcve.

Once you select a test the step above you will see the test results on the screen. The test results are also written to a HTML file that is located in the RDA output directory. You can review the test results by using a Web Browser to open the following file located in:

 
Test "" executed at Sun Aug 25
22:16:55 2006

Test Results
~~~~~~~~~~~~
ID NAME RESULT VALUE
===== ==================== ====== ========================================
10 OS certified? PASSED Certified with 10g RDBMS
20 User in /etc/passwd? PASSED userOK
30 Group in /etc/group? PASSED GroupOK
40 Input ORACLE_HOME RECORD /home/oracle
50 ORACLE_HOME valid? PASSED OHexists
60 O_H perms OK? PASSED CorrectPerms
70 Umask set to 022? PASSED UmaskOK
80 LDLIBRARYPATH unset? FAILED IsSet
100 Other O_Hs in PATH? PASSED NoneFound
110 oraInventory perms PASSED oraInventoryOK
120 /tmp adequate? PASSED TempSpaceOK
130 Swap (in Mb) RECORD 2996
140 RAM (in Mb) PASSED 1502
150 Swap OK? PASSED SwapOK
160 Disk Space OK? PASSED DiskSpaceOK
170 Kernel params OK? PASSED KernelOK
180 Got ld,nm,ar,make? PASSED ld_nm_ar_make_found
190 ulimits OK? FAILED StackTooSmall NoFilesTooSmall Maxupro..>
203 RHEL21 rpms ok? PASSED NotRHEL21
204 RHEL3 rpms ok? PASSED RHEL3rpmsOK
205 SuSE SLES8 rpms ok? PASSED NotSuSE
206 SuSE SLES9 rpms ok? PASSED NotSuSE
207 3006854 installed? PASSED NotRequired
208 LD_ASSUME_KERNEL set FAILED NotSet
209 ip_local_port_range FAILED LowTooHigh
210 Tainted Kernel? PASSED NotTainted
220 other OUI up? PASSED NoOtherOUI

Result file: output/RDA_HCVE_res_A200DB10_lin.htm

If the HCVE test was generated to assist in resolving a Service Request, send the report to Oracle Support by uploading the file via My Oracle Support. If FTP'ing the file, please be sure to FTP in BINARY format. Do not rename the file, as the file name helps Oracle Support quickly identify that RDA output is attached to the service request.

Instructions for Microsoft Windows

based operating systems

==================================================================

Select the RDA command line to confirm RDA is configured:
-cv

Should check for issues and the results should be "No issues found".
The data collection requires an initial setup to determine which information should be collected. Enter the following command to initiate the set up:
-T hcve

Including the dot ensures that RDA is executed from the local directory.

At this point, you should see a list of HCVE rules sets that are available for your operating system, just select the test you want to perform. For Example, for a MS Windows operating system you would see:

 
D:\RDA-Downloads\rda_ocm_win_x86-110225\rda>rda.cmd -T hcve
Processing HCVE tests ...
Available Pre-Installation Rule Sets:
   1. Oracle Fusion Middleware 11g R1 (11.1.1) Preinstall (Windows)
   2. Oracle Portal Preinstall (Generic)
Available Post-Installation Rule Sets:
   3. Oracle Portal Postinstall (generic)
   4. Data Guard Postinstall (Generic)
Enter the HCVE rule set number
Hit 'Return' to accept the default (1)
>

The -d option flag can be added, it allows you to view the collection progression. For example like ./rda.cmd -dT hcve.

Once you select a test the step above you will see the test results on the screen. The test results are also written to a HTML file that is located in the RDA output directory. You can review the test results by using a Web Browser to open the following file located in:

Example of a HCVE pre-install result file-name: output/RDA_HCVE_res_A200DB10_lin.htm
If the HCVE test was generated to assist in resolving a Service Request, send the report to Oracle Support by uploading the file via My Oracle Support. If FTP'ing the file, please be sure to FTP in BINARY format. Do not rename the file, as the file name helps Oracle Support quickly identify that RDA output is attached to the service request.

==================================================================

Special Note on the Output Directory

To limit security vulnerabilities, the permissions of the RDA output directory should be set as restrictive as possible. The output directory could contain sensitive configuration information and, when no other mechanism is available, temporary data collection files.

Viewing Output Files

RDA output is not encrypted and can be viewed by anyone. You can view the RDA report files using almost any web browser by opening the /RDA_HCVE___start.htm. We recommend using Mozilla 1.x ( or Higher), Netscape 4.x (or higher), or Internet Explorer 4.x (or higher).

Reporting Problems or Feedback

Note: If you have issues with the Remote Diagnostic Agent (RDA) , please file a Service Request via My Oracle Support by selecting OSS Support Tools from the product list of values on the Create a SR screen (OSS is above Oracle in the product list). Then select the "*Remote Diagnotic Agent (RDA) Issue*" as the problem type and complete the SR.

Please DO NOT let an RDA issue prevent you from progressing on your technical issue that you are running RDA for. Please inform. the engineer that owns your technical issue that you are having trouble with RDA and request that he/she give you instructions on collecting necessary data manually to resolve the issue. RDA is designed to speed up the resolution time of technical issues and we do not want it to interfere with resolution. However, it is important that we get the RDA issues resolved so that it can be used to help speed up resolution for future technical issues.

Legal Notices And Terms Of Use

By downloading and using RDA you agree to the following : Warranties And Disclaimers.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle is actively engaged with other market- leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, visit the Oracle Accessibility Program Web site at

http://www.oracle.com/accessibility/

Accessibility of Code Examples in Documentation JAWS, a Windows screen reader, may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, JAWS may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation. This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

FOLDER:CRMOD.Reserved Folder for Orion Data TOPIC:Reserved Topic for Orion Data DOCUMENT-ID:250262.1 ALIAS: SOURCE:AWIZ DOCUMENT-TYPE:DIAGNOSTIC TOOLS ZCXNTECH TITLE:RDA 4 - Health Check / Validation Engine Guide IMPACT:LOW SKILL-LEVEL:CASUAL 09 STATUS:PUBLISHED DISTRIBUTION:EXTERNAL ZCXPUBLIC ZCXCURRENT AUTHOR:AGEBBERT.AU AUTHOR:EMOORHOUS.US AUTHOR:HSPATEL.US AUTHOR:JJUSTISO.US AUTHOR:LDENS.BE AUTHOR:RPBOWMAN.US KEYWORD:HCVE KEYWORD:DIAGNOSTIC KEYWORD:RDA PRODID--1 COMPONENT: MINVER: MAXVER: PORTID-0 FDRSEG-1066 FDRSEG-1067

References

NOTE:225559.1 - SET Script. Disclaimer Statement
NOTE:250262.1 - RDA 4 - Health Check / Validation Engine Guide
NOTE:330362.1 - Remote Diagnostic Agent (RDA) 4 - Troubleshooting Guide
NOTE:314422.1 - Remote Diagnostic Agent (RDA) 4 - Getting Started
NOTE:330363.1 - Remote Diagnostic Agent (RDA) 4 - FAQ
NOTE:330344.1 - Remote Diagnostic Agent (RDA) 4 - Training
NOTE:330364.1 - Remote Diagnostic Agent (RDA) 4 - Main Man Page
NOTE:414966.1 - RDA Documentation Index