Running Subsets of Checks

Run a subset of compliance checks where necessary.

These subsets can be a logical grouping determined by Oracle Autonomous Health Framework based on what the check is about.

You can also determine the subsets at an individual check level where you want to exclude or run only specific checks.

Upgrade Readiness Mode (Oracle Clusterware and Oracle Database Upgrade Checks)

Use Upgrade Readiness Mode to assess the readiness of Oracle Clusterware and Oracle RAC databases before an upgrade and to verify their health after an upgrade.

Upgrade Readiness Mode automates many of the pre-upgrade and post-upgrade checks that would otherwise need to be performed manually as part of the upgrade process.

Two Upgrade Readiness modes are available:

• Pre-upgrade check - Run during the upgrade planning phase to identify potential issues early and allow sufficient time to address them before the upgrade.
• Post-upgrade check - Run after the upgrade to verify the health of the upgraded Oracle Grid Infrastructure and Oracle Database environment.

The Upgrade Readiness assessment provides the following information and checks:

• Evaluates the target Oracle Clusterware and Oracle Database versions. Upgrade readiness information is available for target releases later than 11.2.0.3.
• In pre-upgrade mode, automatically detects databases registered with Oracle Clusterware and displays the databases available for pre-upgrade checks.
• In post-upgrade mode, automatically detects databases registered with Oracle Clusterware and displays the databases available for post-upgrade checks.
• Does not perform post-upgrade checks for databases running Oracle Database 11.2.0.3 or earlier releases.
• Checks the Oracle Clusterware stack in both pre-upgrade and post-upgrade modes.
• Checks the operating system in both modes.

After the checks complete, the tool provides the location of the generated report.

Review the Upgrade Readiness report to:

• Identify issues that could affect the planned upgrade.
• Review the health of the environment after an upgrade.
• Examine findings and recommendations.
• Access links to additional information relevant to the upgrade.

Oracle Clusterware and Oracle Database Pre-Upgrade Checks

During the upgrade planning phase, run Oracle Autonomous Health Framework (AHF) in pre-upgrade mode to identify potential issues before upgrading Oracle Clusterware or Oracle Database.

Run the pre-upgrade checks as the Oracle Database owner or as the root user.

To run pre-upgrade checks with Oracle Orachk:

orachk -preupgrade

To run pre-upgrade checks with Oracle Exachk:

exachk -preupgrade

The tool prompts you to specify the target version to which you plan to upgrade.

After you specify the target version, Oracle Orachk or Oracle Exachk runs the applicable pre-upgrade checks for that version.

The generated report is similar to the standard HTML compliance report but focuses on checks relevant to upgrading Oracle Clusterware and Oracle Database to the specified target version.

Review the report before beginning the upgrade to identify and address issues that could affect the upgrade.

Oracle Clusterware and Oracle Database Post-Upgrade Checks

After completing an Oracle Clusterware or Oracle Database upgrade, run Oracle Autonomous Health Framework (AHF) in post-upgrade mode to identify issues and review applicable recommendations for the upgraded environment.

Run the post-upgrade checks as the Oracle Database software owner or as the root user.

To run post-upgrade checks with Oracle Orachk:

orachk -postupgrade

To run post-upgrade checks with Oracle Exachk:

exachk -postupgrade

The generated report is similar to a standard compliance check report but includes only the checks that are relevant after upgrading Oracle Clusterware and Oracle Database.

Review the report to identify post-upgrade issues and applicable recommendations.

Running Checks on Subsets of the Oracle Stack

Run checks on subsets of Oracle stack such as, database, cell, switch, and so on.

Running Database Checks

During Oracle Autonomous Health Framework (AHF) compliance checks, all Oracle Database logins use local connections.

The user running Oracle Orachk or Oracle Exachk must have operating system-authenticated system privileges for the databases being checked.

Oracle Database software is installed and owned by an Oracle software installation owner, commonly referred to as the Oracle user. An environment can have:

• Multiple Oracle Database homes owned by the same Oracle user, such as oracle.
• Multiple Oracle Database homes owned by different Oracle users, such as oracle1, oracle2, and oracle3.

If multiple Oracle Database homes are owned by different Oracle users, use one of the following methods:

• Run Oracle Orachk or Oracle Exachk as the root user.
• Log in as the Oracle software owner for each database that you want to check, and run the tool against the Oracle Database instance owned by that user.

By default, AHF displays a list of running databases registered with Oracle Grid Infrastructure. You can select:

• A single database.
• All databases.
• Multiple databases by specifying the corresponding numbers from the displayed list.

When checking database instances across multiple nodes in a cluster, you do not need to stage Oracle Orachk or Oracle Exachk separately on the other cluster nodes.

Check All Databases

Use the -dball option to run checks against all databases without prompting you to select databases.

For Oracle Orachk:

orachk -dball

For Oracle Exachk:

exachk -dball

Skip Database Checks

Use the -dbnone option to skip all database checks without prompting for database selection.

For Oracle Orachk:

orachk -dbnone

For Oracle Exachk:

exachk -dbnone

Check Specific Databases

Use the -dbnames option to run checks against specific databases.

Specify multiple database names as a comma-separated list.

For Oracle Orachk:

orachk -dbnames <db1>,<db2>,<db3>

For Oracle Exachk:

exachk -dbnames <db1>,<db2>,<db3>

For example:

orachk -dbnames db1,db2,db3

By default, AHF runs the applicable database checks on all database nodes in the cluster.

Check Specific PDBs

Use the -pdbnames option to run checks against specific pluggable databases (PDBs).

Specify multiple PDB names as a comma-separated list.

For Oracle Orachk:

orachk -pdbnames <pdb1>,<pdb2>,<pdb3>

For Oracle Exachk:

exachk -pdbnames <pdb1>,<pdb2>,<pdb3>

For example:

orachk -pdbnames pdb1,pdb2,pdb3

By default, AHF runs the applicable checks against all PDBs in the cluster.

Check Specific Cluster Nodes

Use the -clusternodes option to restrict checks to specific cluster nodes.

Specify multiple node names as a comma-separated list.

For Oracle Orachk:

orachk -clusternodes <node1>,<node2>,<node3>

For Oracle Exachk:

exachk -clusternodes <node1>,<node2>,<node3>

For example:

orachk -clusternodes node1,node2,node3

Check Only the Local Node

Use the -localonly option to restrict the compliance check to the local node.

For Oracle Orachk:

orachk -localonly

For Oracle Exachk:

exachk -localonly

Running Cell Checks

Use the -cell option to limit the scope of Oracle Orachk or Oracle Exachk compliance checks to specific storage servers.

Check a Single Cell

Use the -cell option to limit the compliance check to a single cell.

For Oracle Orachk:

orachk -cell

For Oracle Exachk:

exachk -cell

Check Specific Cells

To run compliance checks against multiple cells, specify the cell names as a comma-separated list.

For Oracle Orachk:

orachk -cell <cell1>,<cell2>,<cell3>

For Oracle Exachk:

exachk -cell <cell1>,<cell2>,<cell3>

For example:

exachk -cell cell1,cell2,cell3

The compliance check is limited to the specified storage servers.

Running Switch Checks

Use the -ibswitches option to limit the scope of Oracle Orachk or Oracle Exachk compliance checks to specific switches.

Check a Single Switch

Use the -ibswitches option to limit the compliance check to a single switch.

For Oracle Orachk:

orachk -ibswitches

For Oracle Exachk:

exachk -ibswitches

Check Specific Switches

To run compliance checks against multiple switches, specify the switch names as a comma-separated list.

For Oracle Orachk:

orachk -ibswitches <switch1>,<switch2>

For Oracle Exachk:

exachk -ibswitches <switch1>,<switch2>

For example:

exachk -ibswitches switch1,switch2

The compliance check is limited to the specified switches.

Running Checks on Other Elements of the Oracle Stack

Oracle Orachk and Oracle Exachk provide compliance checks for a broad range of Oracle software and hardware components. Compliance check coverage continues to expand with each Oracle Autonomous Health Framework (AHF) release.

Compliance checks are organized into logical groups called profiles. Profiles enable you to limit a compliance check run to a specific area of the Oracle stack rather than running all applicable checks.

Use the appropriate profile to run a targeted subset of compliance checks for the components or technologies that you want to assess.

See Using Profiles for information about the available profiles and how to run profile-specific compliance checks.

Oracle Autonomous Health Framework Support for Oracle Grid Infrastructure Without Oracle Database

Oracle Autonomous Health Framework (AHF) supports standalone Oracle Grid Infrastructure compliance checks in environments where Oracle Database is not installed.

Use the -nordbms option to run Oracle Grid Infrastructure checks without performing Oracle Database checks.

For Oracle Orachk:

orachk -nordbms

For Oracle Exachk:

exachk -nordbms

Use this option when you want to assess the health and compliance of an Oracle Grid Infrastructure installation on a system that does not have Oracle Database installed.

Using Profiles with Oracle Autonomous Health Framework

Profiles are logical groups of related compliance checks organized by role, task, or technology. Use profiles to run targeted checks for specific areas of the Oracle software and hardware stack.

The following profiles are available:

Profile	Description
asm	Oracle Automatic Storage Management (Oracle ASM) checks.
exatier1	Exadata checks with a critical alert level. These checks identify high-impact issues that should be addressed as soon as possible.
patches	Oracle patch checks.
bi_middleware	Oracle Business Intelligence checks.
clusterware	Oracle Clusterware checks.
compute_node	Compute node checks for Oracle Exalogic.
control_VM	Oracle Virtual Machine Control VM checks for ec1-vm, ovmm, db, pc1, and pc2. Does not perform cross-node checks.
corroborate	Oracle Exadata checks that require review to determine whether the result is a pass or failure.
dba	Database Administrator (DBA) checks.
ebs	Oracle E-Business Suite checks.
el_extensive	Extensive Oracle Exalogic checks.
el_lite	Oracle Exalogic Lite checks.
el_rackcompare	Data collection for the Oracle Exalogic Rack Comparison Tool.
emagent	Oracle Enterprise Manager Cloud Control Agent checks.
emoms	Oracle Enterprise Manager Cloud Control Management Server checks.
em	Oracle Enterprise Manager Cloud Control checks.
goldengate	Oracle GoldenGate checks.
hardware	Hardware-specific checks for Oracle Engineered Systems.
maa	Maximum Availability Architecture (MAA) checks.
nimbula	Nimbula checks for Oracle Exalogic.
oam	Oracle Access Manager checks.
obiee	Oracle Business Intelligence Enterprise Edition (OBIEE) checks for Oracle Exalytics.
oim	Oracle Identity Manager checks.
oud	Oracle Unified Directory server checks.
ovn	Oracle Virtual Networking checks.
peoplesoft	PeopleSoft best practice checks.
platinum	Oracle Platinum certification checks.
preinstall	Preinstallation checks.
prepatch	Checks to run before patching.
security	Security checks.
siebel	Siebel checks.
solaris_cluster	Oracle Solaris Cluster checks.
storage	Oracle Storage Server checks.
switch	InfiniBand switch checks.
sysadmin	System administrator checks.
timesten	Oracle TimesTen checks for Oracle Exalytics.
user_defined_checks	Runs user-defined checks from user_defined_checks.xml.
virtual_infra	Oracle VM Server (OVS), Control VM, Network Time Protocol (NTP), and stale virtual network interface card (VNIC) checks for Oracle Exalogic.
zfs	Oracle ZFS Storage Appliance checks for Oracle Exalogic.
netperf	Measures the maximum achievable network bandwidth between two nodes.

Running Specific Profiles

Use the -profile option to run only the checks associated with specified profiles.

Specify multiple profiles as a comma-separated list.

For Oracle Orachk:

orachk -profile dba,clusterware

For Oracle Exachk:

exachk -profile dba,clusterware

The resulting report uses the standard HTML report format but contains only checks associated with the specified profiles.

Using the Netperf Profile

Use the netperf profile to measure the maximum achievable network bandwidth between Oracle RAC nodes.

Run the profile with Oracle Orachk by specifying:

-profile netperf

If the required netperf binaries are not available in the AHF home directory, Oracle Orachk prompts you to download netperf.zip from ARU using your My Oracle Support (MOS) credentials.

After downloading the file:

1. Copy netperf.zip to the same location on all participating Oracle RAC nodes.
2. Extract the binaries on each node.

For subsequent runs, Oracle Orachk reuses the downloaded netperf binaries and does not prompt you to download them again.

To run netperf as a standalone profile between two Oracle RAC nodes:

./orachk -profile netperf -host_interface node1:eth0,node2:eth0

To add netperf to a regular health check run:

./orachk -includeprofile netperf -host_interface node1:eth0,node2:eth0

The netperf profile supports:

• Oracle RAC systems with at least two nodes.

The netperf profile does not support:

• Exadata systems.
• Single-instance databases.
• Oracle Restart systems.

Excluding Profiles

Use the -excludeprofile option to run all applicable checks except those associated with specified profiles.

Specify multiple profiles as a comma-separated list.

For Oracle Orachk:

orachk -excludeprofile dba,clusterware,ebs

For Oracle Exachk:

exachk -excludeprofile dba,clusterware,ebs

The generated report contains the applicable checks except those belonging to the excluded profiles.

Including Profiles

Use the -includeprofile option to add checks from specified profiles to the checks that would normally run.

Specify multiple profiles as a comma-separated list.

For ahfctl compliance:

ahfctl compliance -includeprofile <profile1>,<profile2>,...

For Oracle Orachk:

orachk -includeprofile <profile1>,<profile2>,...

For Oracle Exachk:

exachk -includeprofile <profile1>,<profile2>,...

For example:

orachk -includeprofile security,maa

Note:

You cannot use:

• -includeprofile and -profile together.
• -includeprofile and -excludeprofile together.

Use the profile options according to the scope of checks you want to run:

Option	Behavior
-profile	Runs only checks belonging to the specified profiles.
-includeprofile	Adds checks from the specified profiles to the checks that normally run.
-excludeprofile	Excludes checks belonging to the specified profiles from the compliance check run.

Excluding Individual Checks

Exclude individual compliance checks when you have reviewed the check results and determined that a particular check is not relevant to your environment or business requirements.

Excluding irrelevant checks helps streamline the compliance check HTML report so that it focuses on findings that require attention.

You can exclude individual checks in two ways. Both methods require the unique check IDs of the checks you want to exclude.

Excluding Checks with the -excludecheck Option

Use the -excludecheck option followed by a check ID.

To exclude multiple checks, specify their IDs as a comma-separated list.

For Oracle Orachk:

orachk -excludecheck <check_id1>,<check_id2>

For Oracle Exachk:

exachk -excludecheck <check_id1>,<check_id2>

For example:

orachk -excludecheck 0829D67E8B1549AFE05312C0E50AD04F,CB95A1BF5B1160ACE0431EC0E50A12EE

For Oracle Exachk:

exachk -excludecheck 0829D67E8B1549AFE05312C0E50AD04F,CB95A1BF5B1160ACE0431EC0E50A12EE

The excluded checks are listed in the Excluded Checks section of the generated report.

Excluding Checks with the excluded_check_ids.txt File

You can maintain a persistent list of checks to exclude by creating a file named excluded_check_ids.txt.

1. Create a file named:

   excluded_check_ids.txt

2. Add the check IDs that you want to exclude, with one check ID on each line.

   For example:

   0829D67E8B1549AFE05312C0E50AD04F
   CB95A1BF5B1160ACE0431EC0E50A12EE

3. Place the file in the appropriate directory based on your Oracle Exachk version:

   • Oracle Exachk 23.5 and earlier:

     $AHF_HOME/exachk/

     Use the following command to determine AHF_HOME:

     exachk -showahfhome

   • Oracle Exachk 23.6 and later:

     $EXACHK_DATA_DIR/

     Use the following command to determine EXACHK_DATA_DIR:

     exachk -showdatadir

   The file applies to Oracle Exachk runs performed manually or through another utility.

The excluded_check_ids.txt file remains in the specified directory. Each time Oracle Exachk runs, it executes all applicable compliance checks except those listed in the file.

The excluded checks are listed in the Excluded Checks section of the generated report.

Running Individual Checks

Run individual compliance checks when you want to evaluate specific conditions without running a complete Oracle Orachk or Oracle Exachk compliance check.

Running individual checks is useful when you want to:

• Quickly verify whether a specific issue has been resolved.
• Troubleshoot a problem or investigate the performance of specific checks.
• Develop and test user-defined checks.

Before running an individual check, identify its unique check ID.

Use the -check option to run a specific check:

orachk -check <check_id>

or:

exachk -check <check_id>

To run multiple checks, specify their check IDs as a comma-separated list.

For Oracle Orachk:

orachk -check 0829D67E8B1549AFE05312C0E50AD04F,CB95A1BF5B1160ACE0431EC0E50A12EE

For Oracle Exachk:

exachk -check 0829D67E8B1549AFE05312C0E50AD04F,CB95A1BF5B1160ACE0431EC0E50A12EE

Only the specified checks are included in the compliance check run.

Finding Which Checks Require Privileged Users

Use the Privileged User filter in the Health Check Catalog to identify Oracle Orachk or Oracle Exachk compliance checks that must be run by a privileged user, such as root.

Note:

Enable JavaScript in your browser before opening the Health Check Catalog.

To find checks that require privileged users:

1. Open My Oracle Support note 2550798.1.
2. Click the Health Check Catalog tab.
3. Click Open Oracle Orachk Health Check Catalog to open or download the ORAchk_Health_Check_Catalog.html file.
4. In the Health Check Catalog, open the Privileged User drop-down list.
5. Select or clear the appropriate check boxes to filter the catalog based on privileged-user requirements.

Use the filtered results to identify checks that require elevated privileges and plan the compliance check run accordingly.

Option to Run Only the Failed Checks

Use the -failedchecks option to rerun only the compliance checks that failed in a previous Oracle Orachk or Oracle Exachk run.

This option is useful for verifying corrective actions without running the complete set of compliance checks again.

A typical workflow is:

1. Run Oracle Orachk or Oracle Exachk and generate a compliance check report.
2. Review the failed checks and resolve the identified issues.

3. Rerun only the checks that failed previously by specifying the previous result:

   -failedchecks <previous_result>

   <previous_result> can be any of the following:

   • HTML report
   • Collection ZIP file
   • Collection output directory

For Oracle Orachk:

orachk -failedchecks <previous_result>

For Oracle Exachk:

exachk -failedchecks <previous_result>

The tool uses the previous result to identify the failed checks and runs only those checks, enabling you to verify whether the previously identified issues have been resolved.