This chapter provides information about the Oracle Identity and Access Environment Health Check Utility. In addition, it includes information about the directories and plugins used by the utility.
This chapter includes the following sections.
What is the Oracle Identity and Access Environment Health Check Utility
About Health Check Utility Directories, Plugins, and Properties File
Executing the Oracle Identity and Access Environment Health Check Utility
The Oracle Identity and Access Environment Health Check Utility is used to check the technical aspects of your Oracle Identity and Access Management setup and provides an overall measurement of various settings and configurations of your environment.
For example, it verifies network connectivity between different servers, ensures that database index configuration is consistent across servers, and examines error log files.
If you are using the Oracle Identity and Access Management Life Cycle Management (LCM) tools, then the Oracle Identity and Access Environment Health Check Utility is automatically invoked as part of the pre-installation and post-configuration steps.
Further, after installing and configuring Oracle Identity and Access Management Life Cycle Management tools, the product-specific plugins can be executed at any time to verify the health of the deployment.
If you are manually installing and configuring Oracle Identity and Access Management, then you can execute the Health Check Utility on-demand, at various stages, such as pre-installation, post-installation, pre-upgrade, post-configuration, and so on.
Note:
For more information about executing the Health Check Utility, see the following:
"Running the Health Check Utility to Verify Basic System Requirements" in the Deployment Guide for Oracle Identity and Access Management.
"Running the Environment Health Check Utility After Configuration" in the Installation Guide for Oracle Identity and Access Management.
For more information about the automated deployment method, see "About the Automated Deployment of Oracle Identity and Access Management" in the Deployment Guide for Oracle Identity and Access Management.
This section provides information about the following:
Understanding the Health Check Utility XML Files and Plugins
Understanding the idmhc.properties File of the Health Check Utility
The Oracle Identity and Access Environment Health Check Utility uses specific directories for executing plugins and for storing log files. Regardless of whether you run the utility from the automated LCM tools or the manual installation procedure, these directories are installed into the healthcheck directory inside the Oracle home.
The table below provides information about these directories.
Note:
The Oracle home directory is created when you install Oracle Identity and Access Management using the Oracle Identity and Access Management Installer or when you run the Life Cycle Management deployment wizard.Table 2-1 Environment Health Check Utility Directories
| Directory | Description |
|---|---|
|
|
Contains the execution scripts ( For more information about the For more information about the |
|
|
Contains the xml files that must be provided as input when running the For more information about the xml files and the plugins included in these files, see Section 2.2.2, "Understanding the Health Check Utility XML Files and Plugins." |
|
|
Contains relevant jar files. |
|
|
Contains log files. If a log directory is not specified when you run the Environment Health Check Utility, log files are stored in the |
This section provides information about all the xml files and the plugins that are used when the Oracle Identity and Access Environment Health Check Utility is executed.
The Oracle Identity and Access Environment Health Check Utility is run, either from the command line or by the automated LCM tools, by executing the idmhc.sh command (idmhc.bat on Windows).
The xml file that is passed to the Environment Health Check Utility contains the plugins that need to be executed. All relevant xml files reside in the ORACLE_HOME/healthcheck/config directory.
There are xml files for generic tests, such as PreInstallChecks_mandatory.xml, PreInstallChecks_mandatory_manual.xml, PreInstallChecks_db.xml, PreInstallChecks_optional.xml, and PostInstallChecks.xml. There are also xml files that are product specific, such as PostInstallChecks_oim.xml, PostConfigChecks_oudhost.xml, and PostInstallChecks_oam.xml.
Each xml file contains a set of plugins that are covered in the following sections:
The PreInstallChecks_mandatory.xml file includes several mandatory prerequisite checks that must be executed before installing an Oracle Identity and Access Management environment. The table below provides information about the plugins included in this xml file.
Table 2-2 PreInstallChecks_mandatory.xml Plugins
| Plugin | Description |
|---|---|
|
|
Checks whether the host has the recommended free main memory before performing an installation. As part of Oracle Identity and Access Management automated installer integration, the Health Check Utility automatically finds the products that are getting installed on a particular host, calculates the benchmark value for free memory, and then validates it. Note: This plugin is applicable only if you are using the Life Cycle Management (LCM) tools for installing Oracle Identity and Access Management. |
|
|
Checks the kernel parameters, such as |
|
|
Checks Operating System, Release, and Operating System architecture of the host, and compares that information against the benchmark value and then validates it. |
|
|
Checks whether the ports are free. The Environment Health Check Utility automatically finds the ports that need to be free on the current host. If you are manually executing the utility, you must update the For example:
<plugin id="FreePortsCheck"
description="Check whether ports are free"
invoke="7001;7101"
plugin.class="oracle.idm.healthcheck.plugins.
freeportcheck.FreePortsCheckPlugin"
class.path="$HC_LOCATION/lib/idmhcplugins.jar"
stoponerror="false"/>
If ports are not provided in this file, the check will be skipped. |
|
|
Checks whether the host has the recommended available disk space before performing an installation. The Environment Health Check Utility automatically finds the products that are getting installed on a particular host, calculates the benchmark value for disk space, and then validates it. |
|
|
Checks whether the hosts are reachable. The Environment Health Check Utility automatically finds the hosts that need to be pinged. If you are manually executing the utility, you must update the For example:
<plugin id="HostsCheck"
description="Check Reachability of hosts"
invoke="host1.example.com;host2.example.com"
plugin.class="oracle.idm.healthcheck.plugins.
hostcheck.PingHostsPlugin"
class.path="$HC_LOCATION/lib/idmhcplugins.jar"
stoponerror="false"/>
If the host names are not provided in this file, the check will be skipped. |
|
|
Validates values of various predefined parameters on Oracle Identity Manager (OIM), Oracle Internet Directory (OID), and Oracle Access Manager (OAM) databases installed on the host. In addition, it verifies character set, Oracle Text, Oracle JVM, and XATRANS View. In addition, details such as hosts, ports, user names, and passwords are automatically obtained by the Environment Health Check Utility. |
|
|
Checks whether the host has the required database schema in its database as part of product installation (OIM, OID, or OAM). These properties are automatically obtained by the Environment Health Check Utility. |
|
|
Checks whether the host has the recommended Java Virtual Machine version. |
|
|
Checks whether the host has all required packages and patches installed. |
|
|
Checks whether specific file directories have recommended read, write, and execute permissions. The permission check is done on repo location, idmtop, shared If you are manually executing the utility, you must update the Provide the directory paths and permissions in the following format: directory_path1=permissions_required;directory_path2=permissions_required Where For example:
<plugin id="PermissionsCheck"
description="Verifying Path Permissions"
invoke="/scratch/install=RWX;/u01/idmtop=RW"
plugin.class="oracle.idm.healthcheck.plugins.
verifyPermissions.PermissionsPlugin"
class.path="$HC_LOCATION/lib/idmhcplugins.jar"
stoponerror="false"/>
If directory paths and permissions are not provided in this file, the check will be skipped. |
|
|
Checks whether other user interfaces are displayed in the environments. |
The PreInstallChecks_mandatory_manual.xml file includes several mandatory prerequisite checks that must be manually executed before installing an Oracle Identity and Access Management environment. The table below provides information about the plugins included in this xml file.
Table 2-3 PreInstallChecks_mandatory_manual.xml Plugins
| Plugin | Description |
|---|---|
|
|
Checks Operating System, Release, and Operating System architecture of the host, compares that information against the benchmark value, and then validates it. |
|
|
Checks whether the host has the recommended Java Virtual Machine version. |
|
|
Checks whether the host has all required packages and patches installed. |
|
|
Checks whether other user interfaces are displayed in the environments. |
The PreInstallChecks_db.xml file includes a prerequisite check that must be manually executed on the Oracle Identity Manager database host before installing an Oracle Identity and Access Management environment. The table below provides information about the plugin included in this xml file.
Table 2-4 PreInstallChecks_db.xml Plugin
| Plugin | Description |
|---|---|
|
|
Checks whether the mandatory database patches are applied on the database host. For information about any patches that you must apply, see "Downloading and Applying Required Patches" in the Release Notes for Oracle Identity Management. |
The PreInstallChecks_optional.xml file includes generic prerequisite checks that are executed before installing an Oracle Identity and Access Management environment. The table below provides information about the plugins included in this xml file.
Table 2-5 PreInstallChecks_optional.xml Plugins
| Plugin | Description |
|---|---|
|
|
Checks the kernel parameters, such as |
|
|
Checks the processor and the number of cores on the host, and verifies if it meets the recommended values. |
The PostInstallChecks.xml file includes generic post-installation and post-configuration checks that must be manually executed after setting up an Oracle Identity and Access Management environment. The table below provides information about the plugins included in this xml file.
Table 2-6 PostInstallChecks.xml Plugins
| Plugin | Description |
|---|---|
|
|
Verifies whether the LDAP identity store is up and running, and whether a successful connection can be established to that server. |
|
|
Verifies the Oracle WebLogic Server configuration and ordering of authenticators. In addition, it checks if the |
|
|
Checks whether the identity store is properly configured for other components, such as Oracle Access Manager and Oracle Identity Manager, to work with this identity store. The Environment Health Check Utility checks if any attribute or properties are missing in the configuration. Note: This plugin is applicable only if you used the Life Cycle Management (LCM) tools to install Oracle Identity and Access Management. |
|
|
Verifies whether the product console URLs are up, and checks for OIM, OAM, WebLogic, and server consoles. The URLs are automatically formed and checked by the Environment Health Check Utility. Note: This plugin is applicable only if you used the Life Cycle Management (LCM) tools to install Oracle Identity and Access Management. |
|
|
Verifies if the Data sources configured in WebLogic Server are functioning properly. |
The PostInstallChecks_oim.xml file includes post-installation checks specific to Oracle Identity Manager that must be manually executed after setting up an Oracle Identity and Access Management environment. The table below provides information about the plugins included in this xml file.
Table 2-7 PostInstallChecks_oim.xml Plugin
| Plugin | Description |
|---|---|
|
|
Verifies all the SOA configurations, such as In addition, the plugin checks if |
|
|
Validates |
|
|
Checks the |
|
|
Checks whether the System Property Identity Auditor Feature set Availability is set to |
|
|
Checks if all the user defined attributes that are searchable have corresponding indexes defined for them. If indexes are not defined, the plugin will fail. |
|
|
This plugin verifies that during the installation phase, after the Repository Creation Utility was run to create Oracle Identity Manager and its dependent schemas, the authorization policies or application stripe is seeded correctly using the APM-UI cluster. |
|
|
Checks to ensure that the |
|
|
Checks to ensure that the Catalog is synchronized with base entities ( |
|
|
Checks recommended values for the JDBC Connection Pool. |
|
|
Checks to ensure that the properties Maximum Threads Constraint for work managers |
|
|
Checks whether the default values of
|
|
|
Checks whether the service account used for connectivity has rights to perform operations on the target. |
The PostConfigChecks_oudhost.xml file includes post-configuration checks specific to Oracle Unified Directory that must be manually executed after Oracle Unified Directory has been installed and configured. The table below provides information about the plugins included in this xml file:
Table 2-8 PostConfigChecks_oudhost.xml Plugins
| Plugin | Description |
|---|---|
|
|
Examines Oracle Unified Directory (OUD) error log files Note: As this plugin is run post-configuration, it will only check the error log files. If the logs have already rotated and created |
|
|
If OUD is deployed with replication enabled, this plugin ensures that the indexes are consistent on all the OUD replicated servers. Note: This check will only trigger warnings (and not failures) as it is acceptable to have inconsistent index definitions across replicated servers. Index inconsistency may cause issues if binary copy is used to initialize or restore servers, but will not harm the server. |
|
|
If Oracle Unified Directory is deployed with replication enabled, this plugin ensures that all the Oracle Unified Directory replicated servers are reachable and that the replication does not show any issues, such as missing changes or inconsistent number. |
The PostInstallChecks_oam.xml file includes post-installation checks specific to Oracle Access Manager (OAM) that must be manually executed after setting up an Oracle Identity and Access Management environment. The table below provides information about the plugins included in this xml file.
Table 2-9 PostnstallChecks_oam.xml
| Plugin | Description |
|---|---|
|
|
Ensures that |
|
|
Checks whether the XMS and XMX values are set to same level. |
|
|
Checks whether there is a cluster of OAM servers. |
This section provides information about the idmhc.properties file of the Environment Health Check Utility.
The Environment Health Check Utility uses the idmhc.properties file located in the healthcheck/bin directory to run the plugins listed in the XML files of the utility. The idmhc.properties file contains parameters that define the connectivity of identity store, schemas for various components of the Oracle Identity and Access Management suite, WebLogic Server schemas, Oracle Unified Directory (OUD) checks, and so on.
Example 2-1 displays the contents of the idmhc.properties file. Table 2-10 provides a description of the parameters listed in the idmhc.properties file.
Note:
You must provide certain passwords to the Health Check Utility for the utility to run successfully. Passwords can be set in theidmhc.properties file before running the utility. However, it is strongly recommended that you do not specify or store any of your passwords in this file. When executed, the Health Check Utility prompts you to enter values for any required passwords.Example 2-1 Sample idmhc.properties File
# Below parameters are needed for IDStore connectivity plugin IDSTORE_HOST: IDSTORE_PORT: IDSTORE_BINDDN: # If below SSL port is provided, then SSL connectivity will be validated. Not mandatory. IDSTORE_SSL_PORT: IDSTORE_GROUPSEARCHBASE: IDSTORE_USERSEARCHBASE: IDSTORE_SYSTEMIDSEARCHBASE: #Below parameters are needed for OID Schema Connecitivity OID_DB_HOST: OID_DB_PORT: OID_DB_SERVICE_NAME: OID_DB_USER: OID_DB_SYS_USER: OID_DB_CONNECTION_STRING: #Format of Connection String - db1^db2 where db1 is host:port@servicename . #Below parameters are needed for OAM Schema Connecitivity OAM_DB_HOST: OAM_DB_PORT: OAM_DB_SERVICE_NAME: OAM_DB_USER: OAM_DB_SYS_USER: OAM_DB_CONNECTION_STRING: #Format of Connection String - db1^db2 where db1 is host:port@servicename . #Below parameters are needed for OIM Schema Connecitivity OIM_DB_HOST: OIM_DB_PORT: OIM_DB_SERVICE_NAME: OIM_DB_USER: OIM_DB_SYS_USER: OIM_DB_CONNECTION_STRING: #Format of Connection String - db1^db2 where db1 is host:port@servicename . #Below parameters are needed for OMSM Schema Connecitivity OMSM_DB_HOST: OMSM_DB_PORT: OMSM_DB_SERVICE_NAME: OMSM_DB_USER: OMSM_DB_CONNECTION_STRING: #Format of Connection String - db1^db2 where db1 is host:port@servicename . #Below Parameters are needed for OAM Weblogic Server Connectivity OAM_WLS_ADMINSERVER_HOST: #Either port or SSL port is mandatory OAM_WLS_ADMINSERVER_PORT: OAM_WLS_ADMINSERVER_SSLPORT: OAM_WLSADMIN_USER: OAM_WLS_ADMINSERVER_TRUSTSTORE: OAM_WLS_ADMINSERVER_TRUSTSTORE_PASSPHRASE: #Below Parameters are needed for OIM Weblogic Server Connectivity OIM_WLS_ADMINSERVER_HOST: #Either port or SSL port is mandatory OIM_WLS_ADMINSERVER_PORT: OIM_WLS_ADMINSERVER_SSLPORT: OIM_WLSADMIN_USER: OIM_WLS_ADMINSERVER_TRUSTSTORE: OIM_WLS_ADMINSERVER_TRUSTSTORE_PASSPHRASE: #ORACLE_HOME in a database host. Required to check recommended patches via PreInstallChecks_dbhost.xml #eg: /u01/app/aime/product/11.2.0/dbhome_1 ORACLE_HOME: #Below parameters are needed for OIM Server Connectivity SOASERVER_HOST: OIMSERVER_HOST: OIMSERVER_PORT: OIMSERVER_SSL_PORT: OIMADMIN_USERNAME: SOAADMIN_USERNAME: OIMSERVER_SERVER_TYPE: SOASERVER_PORT: SOASERVER_SSL_PORT: # Refer to the Enterprise Deployment Guidelines for understanding relevant details. OIMSERVER_INTERNALLOADBALANCERURL: OIMSERVER_EXTERNALLOADBALANCERURL: # The home directory for the SOA suite installed on the machine. # eg: /u01/app/Oracle/Middleware/Oracle_SOA SOA_HOME: TRUST_STORE: TRUST_STORE_PASSPHRASE: TRUST_STORE_TYPE:JKS #Below parameters are needed for OUD checks OUD_HOST: OUD_ADMINPORT: # AdminUID is the uid of the global administrator configured for replication # Usual value is OUD_ADMINUID: admin # Leave empty if replication is not configured for this instance (the plugins # related to replication will be skipped) OUD_ADMINUID: # OUD_HOME is the path to OUD installation, for example /app/idm/Oracle_OUD1 # This property is optional. If not specified, it will be set to # $HC_LOCATION/.. where HC_LOCATION is the path to healthcheck #OUD_HOME: # OUD_INSTANCE_HOME is the path to OUD instance, for example /app/idm/asinst_1 OUD_INSTANCE_HOME: #HTTP proxy server details, to be provided if proxy is configured HTTP_PROXY_HOST: HTTP_PROXY_PORT: HTTP_PROXY_USERNAME: HTTP_PROXY_PASSWORD #Enter products installed in the current host in a comma separated manner.Valid options are OIM,OAM,OMSM,WEB,LDAP HOST_TYPE:
Table 2-10 Parameters Listed in idmhc.properties File
| Parameter | Description | Required For |
|---|---|---|
|
Parameters for LDAP and Oracle Database |
||
|
|
Enter the host name of the Identity and Policy Store directory for LDAP connectivity. |
|
|
|
Enter the port of the Identity and Policy Store directory for LDAP connectivity. |
|
|
|
Enter the Identity and Policy Store directory Bind DN for LDAP authentication. |
|
|
|
Enter the Identity and Policy Store directory password for LDAP Authentication. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the Identity and Policy Store directory SSL mode port for LDAP connectivity. This parameter is optional. The details of this parameter will be validated by the Health Check Utility if provided. |
|
|
|
Enter the Identity and Policy Store directory DN for Group Search Base. |
|
|
|
Enter the Identity and Policy Store directory DN for User Search Base. |
|
|
|
Enter the Identity and Policy Store directory DN for |
|
|
|
Enter the host name of the system where the Oracle Internet Directory (OID) database is installed. |
|
|
|
Enter the port of the OID database machine. |
|
|
|
Enter the service name of the OID database. |
|
|
|
Enter the prefix name of the OID database schema. |
|
|
|
Enter the password of the OID database schema. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the system user name of the OID database. |
|
|
|
Enter the system password of the OID database. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the connection string for OID RAC database in the following format:
where |
|
|
|
Enter host name of the system where the Oracle Access Manager (OAM) database is installed. |
|
|
|
Enter the port of the OAM database machine. |
|
|
|
Enter the service name of the OAM database. |
|
|
|
Enter the prefix name of the OAM database schema. |
|
|
|
Enter the password of the OAM database schema. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the system user name of the OAM database. |
|
|
|
Enter the system password of the OAM database. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the connection string for OAM RAC database in the following format:
where |
|
|
|
Enter the host name of the system where the Oracle Identity Manager (OIM) database is installed. |
|
|
|
Enter the port of the OIM database machine. |
|
|
|
Enter the service name of the OIM database. |
|
|
|
Enter the prefix name of the OIM database schema. |
|
|
|
Enter the password of the OIM database schema. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the system user name of the OIM database. |
|
|
|
Enter the system password of the OIM database. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the connection string for OIM RAC database in the following format:
where |
|
|
|
Enter the host name of the system where the Oracle Mobile Security Manager (OMSM) database is installed. |
|
|
|
Enter the port of the OMSM database machine. |
|
|
|
Enter the service name of the OMSM database. |
|
|
|
Enter the prefix name of the OMSM database schema. |
|
|
|
Enter the password of the OMSM database schema. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the connection string for OMSM RAC database in the following format:
where |
|
|
Parameters for Oracle Access Manager Oracle WebLogic Server Connectivity |
||
|
|
Enter the host name of the OAM Domain of the Oracle Weblogic Administration Server. |
|
|
|
Enter the OAM Domain port of the Oracle Weblogic Administration Server. This parameter is optional only if you specified a value for the |
|
|
|
Enter the OAM Domain SSL port of the Oracle WebLogic Server Administration Server. This parameter is optional only if you specified a value for the |
|
|
|
Enter the OAM Domain user name of the Oracle WebLogic Administration Server. |
|
|
|
Enter the OAM Domain password of the Oracle WebLogic Administration Server. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the absolute path to the OAM Domain Trust store file of the Oracle WebLogic Administration Server. The details of this parameter must be provided if SSL port is used. |
|
|
|
Enter the password of the OAM Domain Trust store file of the Oracle WebLogic Administration Server. The details of this parameter must be provided if SSL port is used. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
Parameters for Oracle Identity Manager Oracle WebLogic Server Connectivity |
||
|
|
Enter the host name of the OIM Domain of the Oracle WebLogic Administration Server. |
|
|
|
Enter the OIM Domain port of the Oracle Weblogic Administration Server. This parameter is optional only if you specified a value for the |
|
|
|
Enter the OIM Domain SSL port of the Oracle WebLogic Administration Server. This parameter is optional only if you specified a value for the |
|
|
|
Enter the OIM Domain user name of the Oracle WebLogic Administration Server. |
|
|
|
Enter the OIM Domain password of the Oracle WebLogic Administration Server. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the absolute path to the OIM Domain Trust store file of the Oracle WebLogic Administration Server. The details of this parameter must be provided if SSL port is used. |
|
|
|
Enter the password of the OIM Domain Trust store file of the Oracle WebLogic Administration Server. The details of this parameter must be provided if SSL port is used. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
Parameters for HTTP Proxy Server |
||
|
|
Enter the host name of the HTTP proxy server. |
|
|
|
Enter the port of the HTTP proxy server. |
|
|
|
Enter the user name of the HTTP proxy server. |
|
|
|
Enter the password of the HTTP proxy server. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
Parameters for Manual Installation Only |
||
|
|
Enter the products installed on the current host. Use commas to separate the products. This parameter is required to perform disk space and memory checks in a manual deployment scenario. For example:
|
|
|
|
Enter the absolute path of the Oracle home directory on the database host. This is the Oracle home where the Oracle Identity Manager database is installed. For example, This parameter is required to manually execute |
|
|
Parameters for Oracle Identity Manager |
||
|
|
Enter the host name of the Managed Server hosting Oracle SOA. |
|
|
|
Enter the host name of the Managed Server hosting Oracle Identity Manager. |
|
|
|
Specify the default TCP port that the Managed Server hosting Oracle Identity Manager uses to listen for regular (non-SSL) incoming connections. |
|
|
|
Specify the default TCP port that the Managed Server hosting Oracle Identity Manager uses to listen for SSL connections. |
|
|
|
Enter the Oracle Identity Manager administrator user name. |
|
|
|
Enter the Oracle Identity Manager administrator password. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the SOA administrator user name. |
|
|
|
Enter the SOA administrator password. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter |
|
|
|
Enter the default TCP port that the Managed Server hosting Oracle SOA uses to listen for regular (non-SSL) incoming connections. |
|
|
|
Enter the default TCP port that the Managed Server hosting Oracle SOA uses to listen for SSL connection requests. |
|
|
|
Enter the URL used to access the Oracle Identity Manager user interface. You can enter the load-balancer URL or web server URL depending on the application server, or single application server URL. This value is used by Oracle Identity Manager in the notification e-mails as well as the callback URL for SOA calls. |
|
|
|
Enter the details of single-node deployment that do not use Oracle HTTP Server to access Oracle Identity Manager Managed Server. This parameter is optional. For deployments with Single Sign-on (SSO) configured and that use Oracle HTTP Server to access the Oracle Identity Manager Managed Server, provide the SSO URL where the OIM user interface is available. |
|
|
|
Enter the password used for mail server configuration using Oracle User Messaging Service. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Specify the absolute directory path where SOA application is installed. |
|
|
|
Enter the file name and the absolute path to the Trust Keystore. |
|
|
|
Enter the password to the Trust Keystore. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the Trust Keystore type. The commonly used value for this parameter is |
|
|
Parameters for Oracle Unified Directory |
||
|
|
Specify the host name of the server where Oracle Unified Directory is installed. |
|
|
|
Enter the Oracle Unified Directory administration connector port. |
|
|
|
Specify the user name of the global administrator for Oracle Unified Directory replication. The default value of this parameter is |
|
|
|
Specify the password of the global administrator for Oracle Unified Directory replication. You can skip this parameter if the replication is not configured on the Oracle Unified Directory instance. This parameter is optional. If not provided, you will be prompted for this password when you run the Health Check Utility. |
|
|
|
Enter the path to directory where Oracle Unified Directory is installed. This parameter is optional. For example:
|
|
|
|
Specify the path to the Oracle Unified Directory instance. For example:
|
|
The Oracle Identity and Access Environment Health Check Utility performs validation checks against your Oracle Identity and Access Management setup. The utility gathers data from your environment, runs a set of health check plugins in an XML file, and generates a report that compares your environment configuration settings with various Oracle recommended configuration settings.
The idmhc.sh execution script (idmhc.bat for Windows) is required to run the Environment Health Check Utility and can be found in the healthcheck/bin directory.
Note:
Before running the Oracle Identity and Access Environment Health Check Utility,
Ensure that you have provided the required information about the environment in the idmhc.properties file. For more information, see Section 2.2.3, "Understanding the idmhc.properties File of the Health Check Utility."
Ensure that you have set the JAVA_HOME environment variable to the full path of the JDK directory.
The options used for executing this command vary depending on whether you completed a manual installation or an automated installation of Oracle Identity and Access Management.
This section describes the scenarios in which the Environment Health Check Utility can be executed:
Executing the Oracle Identity and Access Environment Health Check Utility in a Manual Install Setup
Executing Oracle Identity and Access Environment Health Check Utility in an Automated Install Setup
Perform the following steps to manually run the Oracle Identity and Access Environment Health Check Utility:
Change directory to the location that contains the executable file:
On Linux or UNIX:
cd ORACLE_HOME/healthcheck/bin
On Windows:
cd ORACLE_HOME\healthcheck\bin
Execute the Environment Health Check Utility by running the following command:
On Linux or UNIX:
idmhc.sh -manifest location_of_manifest_file -topology location_of_topology.xml_file -credconfig location_of_credconfig_folder -group group_name(s) [-recover true|false] [-logDir path_to_healthcheck_log_files] [-DlogLevel=loglevel]
On Windows:
idmhc.bat -manifest location_of_manifest_file -topology location_of_topology.xml_file -credconfig location_of_credconfig_folder -group group_name(s) [-recover true|false] [-logDir path_to_healthcheck_log_files] [-DlogLevel=loglevel]
For example:
idmhc.sh -manifest ORACLE_HOME/healthcheck/config/PostInstallChecks.xml -logDir ORACLE_HOME/healthcheck/bin/logs/healthchecker -DlogLevel=FINEST
Table 2-11 describes the various parameters you can use when you run the Environment Health Check Utility.
Table 2-11 Parameters for the Environment Health Check Utility Command
| Option | Description |
|---|---|
|
|
Enter the location of the plugin manifest file. This parameter is mandatory. It configure the plugins to be executed. The manifest files are located in the |
|
|
Enter the location of the If specified, you do not need to enter values for the parameters in the This option is applicable only if you are manually executing the Environment Health Check Utility in an automated install setup. |
|
|
Enter the location of the If specified, you do not need to enter values for the parameters in the This option is applicable only if you are manually executing the Environment Health Check Utility in an automated install setup. |
|
|
Specify the group names as defined in the manifest file. Use commas to separate the values. This parameter is optional. |
|
|
Specify either |
|
|
Specify the location where the Environment Health Check Utility will store the log files and reports.This parameter is optional. If not specified, the utility saves the Health Check summary reports in the |
|
|
Specify the level at which messages need to be recorded in the log file. Enter one of the following values:
This parameter is optional. If not specified, the default is |
You can use the options listed in Table 2-12 when executing the command.
Table 2-12 Options for the Environment Health Check Utility Command
| Option | Description |
|---|---|
|
|
Print product version and exit the tool. |
|
|
Print help information and exit the tool. |
Note:
For information on how to manually execute the Health Check Utility in a manual install setup after configuration, see "Running the Environment Health Check Utility After Configuration" in the Installation Guide for Oracle Identity and Access Management.If you installed Oracle Identity and Access Management using the Life Cycle Management tools, the Oracle Identity and Access Environment Health Check Utility is automatically invoked by the automated installer.
To manually execute the Health Check Utility in an automated install setup, follow the steps listed in Section 2.3.1.
Note:
For information on how to manually execute the Health Check Utility before installing the Life Cycle Management (LCM) tools, see "Running the Health Check Utility to Verify Basic System Requirements" in the Deployment Guide for Oracle Identity and Access Management.