1.8 Oracle ORAchk and Oracle EXAchk Command-Line Options
Most command-line options apply to both Oracle ORAchk and Oracle EXAchk.
Syntax
$ ./orachk [options]
[-h] [-a] [-b] [-v] [-p] [-m] [-u] [-f] [-o]
[-clusternodes clusternames]
[-failedchecks previous_result]
[-nordbms]
[-output path]
[-dbnames dbnames]
[-localonly]
[-debug]
[-dbnone | -dball]
[-c]
[-upgrade | -noupgrade]
[-syslog]
[-skip_usr_def_checks]
[-checkfaileduploads]
[-uploadfailed all | comma-delimited list of collections]
[-fileattr [start | check | remove ] [-includedir path ] [-excludediscovery] [-baseline path [-fileattronly]
[-testemail all | "NOTIFICATION_EMAIL
=comma-delimited list of email addresses"]
[-setdbupload all | db upload variable, for example, RAT_UPLOAD_CONNECT_STRING
, RAT_UPLOAD_PASSWORD
]
[-unsetdbupload all | db upload variable, for example, RAT_UPLOAD_CONNECT_STRING
, RAT_UPLOAD_PASSWORD
]
[-checkdbupload]
[-getdbupload]
[-cmupgrade]
[-sendemail "NOTIFICATION_EMAIL
=comma-delimited list of email addresses"]
[-nopass]
[-noscore]
[-showpass]
[-show_critical]
[-diff Old Report New Report [-outfile Output HTML] [-force]]
[-merge report 1 report 2 [-force]]
[-tag tagname]
[-nodaemon]
[-profile asm
| clusterware
| corroborate
| dba
| ebs
| emagent
| emoms
| em
| goldengate
| hardware
| maa
| oam
| oim
| oud
| ovn
| peoplesoft
| preinstall
| prepatch
| security
| siebel
| solaris_cluster
| storage
| switch
| sysadmin
| timesten
| user_defined_checks
| zfs
]
[-excludeprofile asm
| clusterware
| corroborate
| dba
| ebs
| emagent
| emoms
| em
| goldengate
| hardware
| maa
| oam
| oim
| oud
| ovn
| peoplesoft
| preinstall
| prepatch
| security
| siebel
| solaris_cluster
| storage
| switch
| sysadmin
| timesten
| user_defined_checks
| zfs
]
[-acchk -javahome path to jdk8
-asmhome path to asm-all-5.0.3.jar -appjar directory where jar files are present for concrete class -apptrc directory where trace files are present for coverage class]
[-check check ids | -excludecheck check ids]
[-zfsnodes nodes]
[-zfssa appliance names]
[-dbserial | -dbparallel [n] | -dbparallelmax]
[-idmpreinstall | -idmpostinstall | -idmruntime] [-topology topology.xml |
-credconfig credconfig] | -idmdbpreinstall | -idmdbpostinstall | -idmdbruntime]
[-idm_config IDMCONFIG] [-idmdiscargs IDMDISCARGS]
[-idmhcargs IDMHCARGS | -h]
Syntax
$ ./exachk [options]
[-h] [-a] [-b] [-v] [-p] [-m] [-u] [-f] [-o]
[-clusternodes clusternames]
[-failedchecks previous_result]
[-nordbms]
[-output path]
[-dbnames dbnames]
[-localonly]
[-debug]
[-dbnone | -dball]
[-c]
[-upgrade | -noupgrade]
[-syslog] [-skip_usr_def_checks]
[-checkfaileduploads]
[-uploadfailed all | comma-delimited list of collections]
[-fileattr start | check | remove [-includedir path [-excludediscovery] [-baseline path[-fileattronly]
[-testemail all | "NOTIFICATION_EMAIL
=comma-delimited list of email addresses"]
[-setdbupload all | db upload variable, for example, RAT_UPLOAD_CONNECT_STRING
, RAT_UPLOAD_PASSWORD
]
[-unsetdbupload all | db upload variable, for example, RAT_UPLOAD_CONNECT_STRING
, RAT_UPLOAD_PASSWORD
]
[-checkdbupload]
[-getdbupload]
[-cmupgrade] [-sendemail "NOTIFICATION_EMAIL
=comma-delimited list of email addresses"]
[-nopass]
[-noscore]
[-showpass]
[-show_critical]
[-diff Old Report New Report [-outfile Output HTML] [-force]]
[-merge report 1 report 2 [-force]]
[-tag tagname]
[-auto_restart -initsetup | -initdebugsetup | -initrmsetup | -initcheck | -h]
[-d start|start -debug|stop|status|info|stop_client|nextautorun|-h]
[-nodaemon]
[-unlockcells all | -cells comma-delimited list of names or IPs of cells] [-lockcells all | -cells comma-delimited list of names or IPs of cells]
[-usecompute]
[-exadiff Exalogic collection1 Exalogic collection2]
[-vmguest ]
[-hybrid [-phy nodes]]
[-profile asm
| bi_middleware
| clusterware
| compute_node
| exatier1
| control_VM
| corroborate
| dba
| ebs
| el_extensive
| el_lite
| el_rackcompare
| emagent
| emoms
| em
| goldengate
| hardware
| maa
| nimbula
| obiee
| ovn
| peoplesoft
| platinum
| preinstall
| prepatch
| security
| siebel
| solaris_cluster
| storage
| switch
| sysadmin
| timesten
| user_defined_checks
| virtual_infra
]
[-excludeprofile asm
| bi_middleware
| clusterware
| compute_node
| exatier1
| control_VM
| corroborate
| dba
| ebs
| el_extensive
| el_lite
| el_rackcompare
| emagent
| emoms
| em
| goldengate
| hardware
| maa
| nimbula
| obiee
| ovn
| peoplesoft
| platinum
| preinstall
| prepatch
| security
| siebel
| solaris_cluster
| storage
| switch
| sysadmin
| timesten
| user_defined_checks
| virtual_infra
]
[-check check ids | -excludecheck check ids]
[-cells cells]
[-ibswitches switches]
[-torswitches]
[-extzfsnodes nodes]
[-dbserial | -dbparallel [n] | -dbparallelmax | -allserial]
[-allserial | -dbnodeserial |-cellserial | -switchserial]
- Running Generic Oracle ORAchk and Oracle EXAchk Commands
List of command options common to Oracle ORAchk and Oracle EXAchk. - Controlling the Scope of Checks
Use the list of commands in this section to control the scope of checks. - Managing the Report Output
Use the list of commands in this section to manage the report output. - Uploading Results to Database
Use the list of commands in this section to upload results to the database. - Controlling the Behavior of the Daemon
Use the list of commands in this section to control the behavior of the daemon. - Tracking File Attribute Differences
Use the list of commands in this section to find file attribute differences. - Running Oracle Health Check Collections Manager Commands
List of commands to manage Oracle Health Check Collections Manager. - Command-Line Options to Generate Password Protected Collection zip Files
Use the list of commands in this section to encrypt and decrypt diagnostic collectionzip
files. - Applying Patch Between Releases
Use the list of commands to manage patches. - Caching Discovery Data
Use the list of commands to manage caching of discovery data. - Configuring REST
Use the list of commands to configure REST.
1.8.1 Running Generic Oracle ORAchk and Oracle EXAchk Commands
List of command options common to Oracle ORAchk and Oracle EXAchk.
Syntax
[-a]
[-v]
[-debug]
[-nodaemon]
[-f]
[-upgrade]
[-noupgrade]
[-testemail all | "NOTIFICATION_EMAIL=comma-delimited list of email addresses"]
[-sendemail “NOTIFICATION_EMAIL=comma-delimited list of email addresses"]
[-dbserial]
[-dbparallel [n]]
[-dbparallelmax]
Parameters
Table 1-7 Generic Commands
Option | Description |
---|---|
|
Runs all checks, including the best practice checks and the recommended patch check. If you do not specify any options, then the tools run all checks by default. |
|
Shows the version of Oracle ORAchk and Oracle EXAchk tools. |
|
Runs in debug mode. The generated |
|
Does not send commands to the daemon, usage is interactive. |
|
Runs Offline. The tools perform health checks on the data already collected from the system. |
|
Forces an upgrade of the version of the tools being run. |
|
Does not prompt for an upgrade if a later version is available under the location specified in the |
|
Sends a test email to validate email configuration. |
|
Specify a comma-delimited list of email addresses. Emails the generated HTML report on completion to the specified email addresses. |
|
Runs the |
|
Runs the Default is 25% of CPUs. |
|
Runs the |
Parent topic: Oracle ORAchk and Oracle EXAchk Command-Line Options
1.8.2 Controlling the Scope of Checks
Use the list of commands in this section to control the scope of checks.
Syntax
[-b]
[-p]
[-m]
[-u –o pre]
[-u –o post]
[-clusternodes nodes]
[-failedchecks previous_result]
[-nordbms]
[-dbnames db_names]
[-dbnone]
[-dball]
[-localonly]
[-cells cells]
[-ibswitches switches]
[-profile profile]
[-excludeprofile profile]
[-check check_id]
[-excludecheck check_id]
[-skip_usr_def_checks]
Parameters
Table 1-8 Scope of Checks
Command | Description |
---|---|
|
Runs only the best practice checks. Does not run the recommended patch checks. |
|
Runs only the patch checks. |
|
Excludes the checks for Maximum Availability Architecture (MAA) scorecards. |
|
Runs the pre-upgrade checks for Oracle Clusterware and database. |
|
Runs the post-upgrade checks for Oracle Clusterware and database. |
|
Specify a comma-delimited list of node names to run only on a subset of nodes. |
|
Runs only checks from the presious_result, which had failed. |
|
Runs Oracle Grid Infrastructure checks only in environments with no Oracle Database checks performed. |
|
Specify a comma-delimited list of database names to run only on a subset of databases. |
|
Does not prompt for database selection and skips all the database checks. |
|
Does not prompt for database selection and runs the database checks on all databases discovered on the system. |
|
Runs only on the local node. |
|
Specify a comma-delimited list of storage server names to run the checks only on a subset of storage servers. |
|
Specify a comma-delimited list of InfiniBand switch names to run the checks only on a subset of InfiniBand switches. |
|
Specify a comma-delimited list of profiles to run only the checks in the specified profiles. |
|
Specify a comma-delimited list of profiles to exclude the checks in the specified profiles. |
|
Specify a comma-delimited list of check IDs to run only the checks specified in the list check IDs. |
|
Specify a comma-delimited list of check IDs to exclude the checks specified in the list of check IDs. |
|
Does not run the checks specified in the user-defined |
Related Topics
- Oracle Clusterware and Oracle Database Pre-Upgrade Checks
- Oracle Clusterware and Oracle Database Post-Upgrade Checks
- Running Database Checks
- Running Switch Checks
- Running Cell Checks
- Using Profiles with Oracle ORAchk and Oracle EXAchk
- Excluding Individual Checks
- Running Individual Checks
- Authoring User-Defined Checks
Parent topic: Oracle ORAchk and Oracle EXAchk Command-Line Options
1.8.3 Managing the Report Output
Use the list of commands in this section to manage the report output.
Syntax
[-syslog] [-tag tagname]
[-o]
[-nopass]
[-noscore]
[-diff old_report new_report [-outfile output_HTML]]
[-merge [-force] collections]
Parameters
Table 1-9 Managing Output
Option | Description |
---|---|
|
Writes JSON results to syslog. |
|
Appends the The |
|
Argument to an option. If If the |
|
Does not show passed checks in the generated output. |
|
Does not print health score in the HTML report. |
|
Reports the difference between the two HTML reports. Specify a directory name or a ZIP file or an HTML report file as |
|
Merges a comma-delimited list of collections and prepares a single report. |
1.8.4 Uploading Results to Database
Use the list of commands in this section to upload results to the database.
Syntax
[-setdbupload all|list of variable names]
[-unsetdbupload all|list of variable names]
[-checkdbupload]
[-getdbupload]
[-checkfaileduploads]
[-uploadfailed all|list of failed collections]
Parameters
Table 1-10 Uploading Results to Database
Option | Description |
---|---|
|
Sets the values in the wallet to upload health check run results to the database.
variable_names: Specify a comma-delimited list of variables to set. |
|
Unsets the values in the wallet to upload health check run results to the database.
variable_names: Specify a comma-delimited list of variables to unset. |
|
Checks if the variables are set correctly for uploading the health check run results to the database. |
|
Prints the variables with their values from wallet for uploading the health check run result to the database. |
|
Reports any failed collection uploads. |
|
Reattempts to upload one or more failed collection uploads.
list of failed collections: Specify a comma-delimited list of collections to upload. |
Related Topics
Parent topic: Oracle ORAchk and Oracle EXAchk Command-Line Options
1.8.5 Controlling the Behavior of the Daemon
Use the list of commands in this section to control the behavior of the daemon.
Syntax
[-id id] –set daemon_option
[-id id] -unset daemon_option | all
[-id id] -get parameter | all
[-d start]
[-d start -debug]
[-d stop]
[-d stop_client]
[-d status]
[-d start -ords]
[-d start -ords ords_path]
[-d start -ords [-ordscollectionretention size_mbs]]
[-d info]
[-id id] -d nextautorun
[-initsetup]
[-initrmsetup]
[-initcheck]
Parameters
Table 1-11 Daemon Options
Option | Description |
---|---|
|
Optionally use |
|
Unsets the parameter. Use with |
|
Displays the value of the specified parameter or all the parameters. Use with |
|
Starts the daemon. |
|
Starts the daemon in debug mode. |
|
Stops the daemon. |
|
Forces a running daemon client to stop. |
|
Checks the current status of the daemon. |
|
Starts the daemon to serve Oracle Rest Data Service (ORDS) API requests. Run the |
|
Starts the daemon to serve Oracle Rest Data Service (ORDS) API requests. Requires Oracle Rest Data Service (ORDS) to be up and running at the specified path, |
|
Starts the daemon to serve Oracle Rest Data Service (ORDS) API requests, and sets the ORDS collection retention to the specified size, size_mbs MB. The default collection retention value is 1024 MB. |
|
Displays details about the daemon. The details include installation and when the daemon was started. |
|
Displays details about when the next scheduled automatic run occurs. |
|
Sets the daemon auto restart function that starts the daemon when the node starts. |
|
Removes the automatic restart functionality. |
|
Checks if the automatic restart functionality is set up. |
1.8.6 Tracking File Attribute Differences
Use the list of commands in this section to find file attribute differences.
Parameters
Table 1-12 File Attribute Differences
Option | Description |
---|---|
|
Takes file attributes snapshot of discovered directories and stores the snapshot in the output directory. By default, the tool takes snapshot of Oracle Grid Infrastructure home and all the installed database homes. If the user doesn't own a particular directory, then the tool does not take snapshot of the directory. |
|
Takes a recent snapshot of discovered directories and compares with the previous snapshot |
|
Removes the file attribute snapshots and related files. |
|
Includes the directories specified at the command-line to check file attributes. For example:
|
|
Excludes the discovered directories.
|
|
For example:
|
|
Performs file attributes check and exits ORAchk.
|
Parent topic: Oracle ORAchk and Oracle EXAchk Command-Line Options
1.8.7 Running Oracle Health Check Collections Manager Commands
List of commands to manage Oracle Health Check Collections Manager.
Table 1-13 Oracle Health Check Collections Manager Commands
Command | Description |
---|---|
Or
|
Upgrades Oracle Health Check Collections Manager from Oracle ORAchk or Oracle EXAchk. Oracle Health Check Collections Manager upgrades to the latest version of whichever application your database supports. You get the new theme interface only if you have APEX 5. |
Parent topic: Oracle ORAchk and Oracle EXAchk Command-Line Options
1.8.8 Command-Line Options to Generate Password Protected Collection zip Files
Use the list of commands in this section to encrypt and decrypt diagnostic collection zip
files.
Table 1-14 Encrypt and Decrypt Diagnostic Collection zip Files
Option | Description |
---|---|
|
Starts the daemon with The daemon prompts for a password when it starts. The daemon then encrypts the subsequent on-demand and scheduled runs collections with that password. Note: When |
|
Encrypts the run result. Prompts for the password, and encrypts the collections created at the end of the run with that password. You can use For example:
Note: When |
|
Encrypts the already generated collection. Prompts for the password, encrypts the zip file specified with that password, and then renames the collections as, for example, Note: When |
|
Decrypts the encrypted collection. Prompts for the password, decrypts the |
Parent topic: Oracle ORAchk and Oracle EXAchk Command-Line Options
1.8.9 Applying Patch Between Releases
Use the list of commands to manage patches.
Syntax
orachk –applypatch orachk_bug_id.zip
exachk –applypatch exachk_bug_id.zip
orachk –querypatch all
exachk –querypatch all
orachk –querypatch bug_id
exachk –querypatch bug_id
orachk –rollbackpatch bug_id
exachk –rollbackpatch bug_id
Table 1-15 Managing Patches
Command | Description |
---|---|
|
Applies a new patch for the specified bug ID. |
|
Lists the details of all of the installed patches or for the specified bug ID. |
|
Rolls back the applied patch to its previous state, the state at which the patch was applied. |
Example 1-23 -applypatch
./orachk -applypatch orachk_27836477.zip
Patched file /scratch/test_user/lib/messages.pyc
Patched file /scratch/test_user/lib/utils.pyc
Patched file /scratch/test_user/lib/help.pyc
Patched file /scratch/test_user/lib/watchdog.pyc
Patched file /scratch/test_user/lib/constant.pyc
Patched file /scratch/test_user/lib/execute_checks.pyc
Patched file /scratch/test_user/lib/security.pyc
Patched file /scratch/test_user/orachk.pyc
Patching of file orachk_27836477.zip completed
orachk Patched to 18.4.1(PATCH1) from 18.4.0(DEV)
orachk Patch fixes 27836477
Example 1-24 -querypatch all
./orachk -querypatch all
Patch: ORACHK_PATCH_18.4.1
Status: INSTALLED
Fixes: 27836477
Applied on: Fri Oct 26 10:50:53 2018
Example 1-25 -querypatch bug_id
./orachk -querypatch 27836477
Patch: ORACHK_PATCH_18.4.1
Status: INSTALLED
Fixes: 27836477
Applied on: Fri Oct 26 10:50:53 2018
Example 1-26 –rollbackpatch
./orachk -rollbackpatch 27836477
Rolled-back file /scratch/test_user/lib/security.pyc
Rolled-back file /scratch/test_user/lib/execute_checks.pyc
Rolled-back file /scratch/test_user/lib/utils.pyc
Rolled-back file /scratch/test_user/lib/help.pyc
Rolled-back file /scratch/test_user/lib/watchdog.pyc
Rolled-back file /scratch/test_user/lib/constant.pyc
Rolled-back file /scratch/test_user/lib/messages.pyc
Rolled-back file /scratch/test_user/orachk.pyc
orachk Rolled-back to 18.4.0(DEV) from 18.4.1(PATCH1)
orachk Rolled-back fixes for 27836477
Parent topic: Oracle ORAchk and Oracle EXAchk Command-Line Options
1.8.10 Caching Discovery Data
Use the list of commands to manage caching of discovery data.
Syntax
orachk -discovery -discoverydir location
exachk -discovery -discoverydir location
orachk -checkdiscovery
exachk -checkdiscovery
orachk -usediscovery -discoverydir location
exachk -usediscovery -discoverydir location
orachk -refreshdiscovery
exachk -refreshdiscovery
orachk -rmdiscovery
exachk -rmdiscovery
Table 1-16 Manage Caching of Discovery Data
Command | Description |
---|---|
|
Caches discovery data, which Oracle ORAchk and Oracle EXAchk can use for future runs.
|
|
Verifies discovery data. |
|
Uses discovery data.
|
|
Refreshes discovery data. |
|
Removes cached discovery data. |
Parent topic: Oracle ORAchk and Oracle EXAchk Command-Line Options
1.8.11 Configuring REST
Use the list of commands to configure REST.
Syntax
orachk -ordssetup [dir [-configdir dir_to_store configuring ORDS]] [-ordshomedir any_directory_with_write_permission]
exachk -ordssetup [dir [-configdir dir_to_store configuring ORDS]] [-ordshomedir any_directory_with_write_permission]
orachk -ordsrmsetup
exachk -ordsrmsetup
orachk -ordscheck
exachk -ordscheck
Table 1-17 Configure REST
Command | Description |
---|---|
|
Sets up ORDS on the target host.
|
|
Removes ORDS setup. Running the command stops the daemon if running and deletes the ORDS user's home directory if no collections are found. If collections from previous runs are found, then the command prompts the user before a decision is made to remove the setup or not. |
|
Running the command lets the user know if ORDS is setup or not. If ORDS is setup, then the command prints the URL to use to submit runs using REST APIs. |
Related Topics
Parent topic: Oracle ORAchk and Oracle EXAchk Command-Line Options