12 Verifying Your Environment Using the Environment Health Check Utility

After installing and configuring Oracle Identity and Access Management, Oracle recommends you run the Oracle Identity and Access Environment Health Check Utility to verify that your environment has been configured successfully.

For more information, see the following topics:

12.1 Running the Environment Health Check Utility After Configuration

The Environment Health Check Utility is a tool available from the IAM_HOME/healthcheck directory that you can use to verify various configurations and perform validation checks against your Oracle Identity and Access Management setup. These checks help you verify that your environment has been installed and configured successfully. When you run the Health Check Utility, the utility retrieves data from your environment, uses the data to run a set of validation checks, and generates a report that provides detailed information about any issues the utility finds for each of the items it checks.

To run the utility, you specify a manifest file, which is used to group together specific validation checks and call plug-ins to run the various checks. To run general post-installation checks to verify general post-installation requirements, see Section 12.2.

For Oracle Identity Manager and Oracle Access Manager, it is also recommended you run the utility to perform component validation checks to ensure these components are set up correctly. To run component-specific checks for Oracle Identity Manager and Oracle Access Manager, see Section 12.3 and Section 12.4, respectively.

For more information about the Environment Health Check Utility, see "Understanding the Oracle Identity and Access Environment Health Check Utility" in Verifying Your Oracle Identity and Access Management Environment.

Note:

IAM_HOME is used to refer to the Oracle Home directory that includes Oracle Identity Manager, Oracle Access Management, Oracle Adaptive Access Manager, Oracle Entitlements Server, Oracle Privileged Account Manager, Oracle Access Management Mobile and Social, and Oracle Mobile Security Suite.

12.2 Running the Environment Health Check Utility to Verify Your Installation and Configuration

After installing and configuring Oracle Identity and Access Management, it is recommended you run the Health Check Utility to verify that your environment meets general post-installation requirements. To do this, you use the IAM_HOME/healthcheck/config/PostInstallChecks.xml manifest file to run the appropriate post-installation checks.

Note:

For more information about these checks performed by the Health Check Utility, see "PostInstallChecks.xml" in Verifying Your Oracle Identity and Access Management Environment

To ensure your environment has been installed and configured successfully, perform the following steps to run general post-installation checks:

  1. Open the idmhc.properties file in the IAM_HOME/healthcheck/bin directory.

  2. Set values for the necessary properties in this file to reflect your Oracle Identity and Access Management environment.

    For more information on how to update and use this file, see "Understanding the idmhc.properties File of the Health Check Utility" in Verifying Your Oracle Identity and Access Management Environment.

  3. Set the JAVA_HOME environment variable to the full path of the JDK directory.

  4. Change directory to the IAM_HOME/healthcheck/bin directory (on Linux or UNIX) or IAM_HOME\healthcheck\bin directory (on Windows).

    On Linux or UNIX:

    cd IAM_HOME/healthcheck/bin
    

    On Windows:

    cd IAM_HOME\healthcheck\bin
    
  5. Run the following command to perform post-installation validation checks:

    On Linux or UNIX:

    idmhc.sh -manifest IAM_HOME/healthcheck/config/PostInstallChecks.xml 
    

    On Windows:

    idmhc.bat -manifest IAM_HOME\healthcheck\config\PostInstallChecks.xml
     
    
  6. If any health checks fail, refer to the output in the Health Check Utility log files and reports to find the corrective actions. Note that the log file location will be printed on the screen after the utility is executed.

    The reports provide the status of each check and a list of corrective actions for any checks that fail validation. You can manually fix the issues and rerun the utility any number of times to ensure all checks are successful. For more information about the log files and reports, see "Analyzing Health Check Reports" in Verifying Your Oracle Identity and Access Management Environment.

12.3 Running the Environment Health Check Utility to Verify Oracle Identity Manager

After configuring Oracle Identity Manager, it is recommended you run the Health Check Utility to verify your Oracle Identity Manager configuration. To do this, you use the IAM_HOME/healthcheck/config/PostInstallChecks_oim.xml manifest file to run the appropriate Oracle Identity Manager checks.

Note:

For more information about the Oracle Identity Manager checks performed by the Health Check Utility, see "PostInstallChecks_oim.xml (Oracle Identity Manager)" in Verifying Your Oracle Identity and Access Management Environment.

To ensure Oracle Identity Manager has been configured successfully, perform the following steps to run Oracle Identity Manager validation checks:

  1. Open the idmhc.properties file in the IAM_HOME/healthcheck/bin directory.

  2. Set values for the necessary properties in this file to reflect your Oracle Identity and Access Management environment.

    For more information on how to update and use this file, see "Understanding the idmhc.properties File of the Health Check Utility" in Verifying Your Oracle Identity and Access Management Environment.

  3. Set the JAVA_HOME environment variable to the full path of the JDK directory.

  4. Change directory to the IAM_HOME/healthcheck/bin directory (on Linux or UNIX) or IAM_HOME\healthcheck\bin directory (on Windows).

    On Linux or UNIX:

    cd IAM_HOME/healthcheck/bin
    

    On Windows:

    cd IAM_HOME\healthcheck\bin
    
  5. Run the following command to perform Oracle Identity Manager validation checks:

    On Linux or UNIX:

    idmhc.sh -manifest IAM_HOME/healthcheck/config/PostInstallChecks_oim.xml 
    

    On Windows:

    idmhc.bat -manifest IAM_HOME\healthcheck\config\PostInstallChecks_oim.xml
     
    
  6. If any health checks fail, refer to the output in the Health Check Utility log files and reports to find the corrective actions. Note that the log file location will be printed on the screen after the utility is executed.

    The reports provide the status of each check and a list of corrective actions for any checks that fail validation. You can manually fix the issues and rerun the utility any number of times to ensure all checks are successful. For more information about the log files and reports, see "Analyzing Health Check Reports" in Verifying Your Oracle Identity and Access Management Environment.

12.4 Running the Environment Health Check Utility to Verify Oracle Access Manager

After configuring Oracle Access Manager, it is recommended you run the Health Check Utility to verify your Oracle Access Manager configuration. To do this, you use the IAM_HOME/healthcheck/config/PostInstallChecks_oam.xml manifest file to run the appropriate Oracle Access Manager checks.

Note:

For more information about the Oracle Access Manager checks performed by the Health Check Utility, see "PostInstallChecks_oam.xml (Oracle Access Manager)" in Verifying Your Oracle Identity and Access Management Environment.

To ensure Oracle Access Manager has been configured successfully, perform the following steps to run Oracle Access Manager validation checks:

  1. Open the idmhc.properties file in the IAM_HOME/healthcheck/bin directory.

  2. Set values for the necessary properties in this file to reflect your Oracle Identity and Access Management environment.

    For more information on how to update and use this file, see "Understanding the idmhc.properties File of the Health Check Utility" in Verifying Your Oracle Identity and Access Management Environment.

  3. Set the JAVA_HOME environment variable to the full path of the JDK directory.

  4. Change directory to the IAM_HOME/healthcheck/bin directory (on Linux or UNIX) or IAM_HOME\healthcheck\bin directory (on Windows).

    On Linux or UNIX:

    cd IAM_HOME/healthcheck/bin
    

    On Windows:

    cd IAM_HOME\healthcheck\bin
    
  5. Run the following command to perform Oracle Access Manager validation checks:

    On Linux or UNIX:

    idmhc.sh -manifest IAM_HOME/healthcheck/config/PostInstallChecks_oam.xml 
    

    On Windows:

    idmhc.bat -manifest IAM_HOME\healthcheck\config\PostInstallChecks_oam.xml
     
    
  6. If any health checks fail, refer to the output in the Health Check Utility log files and reports to find the corrective actions. Note that the log file location will be printed on the screen after the utility is executed.

    The reports provide the status of each check and a list of corrective actions for any checks that fail validation. You can manually fix the issues and rerun the utility any number of times to ensure all checks are successful. For more information about the log files and reports, see "Analyzing Health Check Reports" in Verifying Your Oracle Identity and Access Management Environment.