9.2.13.1 ahfctl compliance
Note:
The -setserviceupload
,
-unsetserviceupload
, -getserviceupload
,
-checkserviceupload
, -setdbupload
,
-unsetdbupload
, -getdbupload
,
-checkdbupload
, and -sanitize
parameters
have been deprecated and removed in 23.3. Oracle recommends using the following
commands instead.
ahfctl setupload
replaces-setserviceupload
and-setdbupload
ahfctl unsetupload
replaces-unsetserviceupload
and-unsetdbupload
ahfctl getupload
replaces-getserviceupload
and-getdbupload
ahfctl checkupload
replaces-checkserviceupload
and-checkdbupload
ahfctl redact
replaces-sanitize
Syntax
ahfctl compliance -h
[-a]
[-acchk]
[-appjar]
[-applypatch]
[-apptrc]
[-asmhome]
[-asynch]
[-attachment]
[-autorun_id]
[-autoselect]
[-autostart]
[-autostart reset]
[-autostatus]
[-autostop]
[-autostop unset]
[-b]
[-baseline]
[-basic]
[-cellparallel]
[-cellparallelmax]
[-cells]
[-cellserial]
[-celltmpdir]
[-check]
[-checkdiscovery]
[-checkfaileduploads]
[-checkservicefaileduploads]
[-ciphers]
[-classicjson]
[-cleanup]
[-clusternodes]
[-cmupgrade]
[-configdir]
[-createprofile]
[-credfile]
[-cvuhome]
[-cvuonly]
[-db_config_name]
[-dball]
[-dbconfig]
[-dbnames]
[-dbnone]
[-dbparallel]
[-dbparallelmax]
[-dbserial]
[-debug]
[-decode]
[-decodezip]
[-deleteprofile]
[-diagpath]
[-diff]
[-disabledbupload]
[-disableserviceupload]
[-discovery]
[-discoverydir]
[-download]
[-downloadchecks]
[-duration]
[-ebs32bit]
[-ecra]
[-email_debuglevel]
[-enabledbupload]
[-enableserviceupload]
[-encode]
[-encodezip]
[-env]
[-escs_mgmt_proxy]
[-escs_user]
[-event]
[-excludecheck]
[-excludecvu]
[-excludedbnames]
[-excludediscovery]
[-excludemaa]
[-excludeprofile]
[-extzfsnodes]
[-f]
[-failedchecks]
[-fileattr]
[-fileattronly]
[-force]
[-from]
[-get]
[-getcheckxml]
[-getfromwallet]
[-getoutputdir]
[-h]
[-hardwaretype]
[-header]
[-help]
[-ibswitches]
[-ibtmpdir]
[-id]
[-identifier]
[-identitydir]
[-includecvu]
[-includedir]
[-includeprofile]
[-insecure]
[-javahome]
[-jdbcver]
[-json]
[-key]
[-localonly]
[-localuser]
[-lockcells]
[-logconf]
[-loglevel]
[-m]
[-merge]
[-modifyprofile]
[-module]
[-monthlyschedule]
[-mos_config_name]
[-mserver_conf]
[-nocleanup]
[-nocvu]
[-nodaemon]
[-nodeparallel]
[-nodeparallelmax]
[-nodeserial]
[-nopass]
[-noproxy]
[-nordbms]
[-noreport]
[-noscore]
[-noupgrade]
[-o]
[-orainst]
[-ordscheck]
[-ordsrmsetup]
[-ordssetup]
[-oss_config_name]
[-outfile]
[-output]
[-p]
[-packpollingtimeout]
[-perf_path]
[-postupgrade]
[-preupgrade]
[-probe]
[-profile]
[-purge_size]
[-querypatch]
[-r]
[-readenvconfig]
[-rediscovery]
[-remotedestdir]
[-remotehost]
[-remoteuser]
[-repair]
[-rmap]
[-rmdiscovery]
[-rollbackpatch]
[-rpackpollingtimeout]
[-runasroot]
[-s]
[-sendemail]
[-set]
[-setasm]
[-setcrs]
[-setemagent]
[-setinvloc]
[-setinwallet]
[-setjava]
[-setjdbcver]
[-setwls]
[-short]
[-show_critical]
[-showahfhome]
[-showdatadir]
[-showpass]
[-showrepair]
[-silentforce]
[-skip_security]
[-skip_usr_def_checks]
[-switches]
[-switchparallel]
[-switchparallelmax]
[-switchserial]
[-syslog]
[-systemtype]
[-t]
[-tag]
[-targetversion]
[-testemail]
[-tfa_version]
[-timeframe]
[-tls]
[-tmpdir]
[-torswitches]
[-trace]
[-u]
[-universal]
[-unlockcells]
[-unset]
[-unsetinwallet]
[-updatezip]
[-upgrade]
[-uploadfailed]
[-uploadservicefailed]
[-usediscovery]
[-username]
[-usesocket]
[-usessh]
[-v]
[-wallet_loc]
[-withdebugger]
[-withrepairdata]
[-zfsnodes]
[-zfssa]
[-zipfile]
Parameters
Table 9-39 ahfctl compliance Command Parameters
Parameter | 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. |
-acchk |
Runs application continuity checks.
Set the following environment variable before using the
-acchk option:
If the above environment variables are set,
Passing values in command line instead of environment
variables.
Optional
variable Note: -acchk can be run
either for both database coverage and concrete classes or can be
run only for database coverage or concrete class
separately.
|
|
Specify the directory where |
|
Applies a new Applies a new |
|
Use |
|
Specify to set asm home for |
|
Used to send remote |
|
When specified with |
|
Exits |
|
Used to specify identity files directory where identity files to all remote host are present.
Identity file name must follow the naming convention
as follows:
For example: RSA is the default SSH encryption. For DSA SSH encryption, set
|
|
Autostart will automatically set and run the
|
|
Starts and loads the default schedulers. |
|
Checks the status of the scheduler. |
|
Use Note: The daemon will start when AHF is restarted. |
|
Removes all default unmodified schedulers. |
|
Runs only the best practice checks. |
|
Use |
|
Use -basic encrypt/decrypt using
utf-8 character encoding.
|
|
Runs n: Specify the number of child processes to run on cells. Default is 25% of CPUs. |
|
Runs Number of child processes will be equal to the minimum number of CPUs and number of cells. |
|
Specify a comma-delimited storage server names or file
containing storage server names separated by newline to run
|
|
Runs |
|
Sets |
|
Runs a specific set of checks. Specify check IDs at the command prompt. |
|
Checks if |
|
Prints a list of collections for which upload failed. |
|
Prints a list of collections for which service upload failed. |
|
Specify ciphers for curl OSS upload. |
|
Generates valid JSON files with results, exceptions, and recommendations. |
|
Cleans up the temporary directory. |
|
Specify a comma-delimited list of node names or file containing node names separated by newline to run only on a subset of nodes. |
|
Upgrades the Collection Manager if a new version of Collection
Manager is available and database upload parameters are set in
the |
|
Use to configure ORDS. |
|
Creates a custom profile. Specify a custom profile name followed by a list of comma-delimited check IDs to populate. |
|
Use to specify a credential file. You need this credential file to run in non-interactive mode. |
|
You can specify a different Cluster Verification Utility (CVU) home with this parameter. When not specified, CVU from GRID home is run. |
|
Runs only Cluster Verification Utility (CVU) related checks. |
|
Use to set the name of database upload configuration. |
|
Runs the database checks on all databases discovered on the system. Does not prompt for database selection. |
|
Specify a comma-delimited list of database homes with corresponding names to run only on a subset of databases. Does not prompt for database selection. Database home and corresponding names are separated by '%' while dbnames corresponding to home are separated by ':'. |
|
Specify a comma-delimited list of database names to run only on a subset of databases. |
|
Skips all the database checks. Does not prompt for database selection. |
|
Runs n: Specify the number of child processes. Default is 25% of CPUs. |
|
Runs Number of child processes will be equal to the minimum number of CPUs and number of databases. |
|
Runs |
|
Runs |
|
Use to decrypt the encrypted collection. |
|
Deletes the specified custom created profile. |
|
Specify the path where storage server diagnostic package will be copied. |
|
Reports the difference between the two HTML reports. For example: Specify a directory name, or a ZIP file, or an HTML report file as old_report and new_report. |
|
Disables database upload if database upload parameters are set in the wallet. Default behavior of database upload is enabled. |
|
Disables service upload if service upload parameters are set in the wallet. Default behavior of service upload is enabled. |
|
Cache discovery data, which can use for future
|
|
Specify |
|
Downloads the |
|
Downloads the |
|
The duration parameter specifies the number of hours of logs and traces to include in the storage server diagnostic package. Valid values are from 1 (default) to 6. |
|
Runs |
|
Use to specify that |
|
When specified, displays debug messages for email connection and for all messages sent to and received from the server. |
|
Enables database upload if database upload parameters are set in the wallet. Default behavior of database upload is enabled. |
|
Enables service upload if service upload parameters are set in the wallet. Default behavior of service upload is enabled. |
|
Encrypts the collection. |
|
Sets the environment type. Specify
|
|
Use to specify that |
|
The Specify a user to run checks with user for which
|
|
Applicable to daemon mode. Sets
|
|
Excludes specific set of checks, enter check IDs at the command prompt. |
|
When specified, excludes Cluster Verification Utility (CVU) related checks. |
|
Specify a comma-delimited list of database names to exclude. |
|
Excludes the discovered directories. Use with |
|
Excludes Maximum Available Architecture. |
|
Excludes specified profiles. |
|
Specify a comma-delimited external ZFS storage appliance names to
run |
|
Use to run Specify an HTML file, or collections, or an output directory containing the HTML file. |
|
Checks file attribute changes. Options:
|
|
Performs file attributes check and exits
Use with |
|
Use With With |
|
Specify when to start collecting the logs and traces for storage server diagnostic package. The format of cell diagpack start time is as follows:
|
|
Displays the value of the specified daemon parameter or all the parameters. Use with Supported parameters are:
|
|
Gets user-defined checks for execution. User-defined checks are written in XML format. |
|
Gets an entry for a key in the wallet. |
|
Prints the output directory. |
|
Specify hardware generation and socket for a system so that
|
|
Stores the |
|
Specify a comma-delimited InfiniBand switch names to run
|
|
Sets Creates |
|
Specify an SR or a BUG number. |
|
Specify identity files directory where identity files to all remote host are present. Options:
|
|
Includes Cluster Verification Utility (CVU) related check. |
|
Includes the directories specified at the command-line to check file attributes. Use with |
|
Specify a comma-delimited list of profiles to the existing checks list.
Note: You cannot:
|
|
Enables or disables security. |
|
Use |
|
Use to specify JDBC version for |
|
Use to generate valid JSON files. |
|
When specified, use this key for encryption or decryption. |
|
Runs checks only on the local node. |
|
The |
|
Locks the storage cells. Applicable only to Exadata and SuperCluster. |
|
Specify the file containing logging configuration. |
|
Sets the logging level. |
|
Excludes checks for Maximum Availability Architecture (MAA) scorecards. |
|
Merges reports by providing a comma-delimited list of directories or zip files. Option:
|
|
Modifies a custom profile. Specify the profile name followed by a comma-delimited check IDs. If the checks are present in the profile, they will be removed. If not, check would be added. |
|
Runs Valid modules are:
|
|
Specify the name of MOS upload configuration. |
|
Email server configuration details. Options:
|
|
Specify not to clean the temporary directory. |
|
Excludes Cluster Verification Utility (CVU) related checks. |
|
Does not send commands to the daemon, usage is interactive. |
|
Run n: Specify the number of child processes to run on the remote node. Default is 25% of CPUs. |
|
Runs Number of child processes will be equal to the minimum number of CPUs and the number of remote nodes. |
|
Runs |
|
Skips PASSed checks to print in |
|
Use to disable or enable proxy. |
|
If CRS is installed, but Oracle Database is not installed and
still the user wants to run |
|
Specify not to generate HTML report. |
|
Specify not to print healthscore in the
|
|
Specify -noupgrade option if you do
not want to be prompted for an upgrade even if a later version is
available under the location specified by
RAT_UPGRADE_LOC .
|
|
Lets you know if ORDS is setup or not. If ORDS is setup, then it prints the URL to be used to submit runs using REST APIs. |
|
Removes ORDS setup. It stops the daemon running and deletes the ORDS user's home directory if no collections are found . If collections from previous runs are found, then it prompts the user before a decision is made to remove the setup or not. |
|
Sets up ORDS on a system. Options
|
|
Specify the name of OSS upload configuration. |
|
Use |
|
Sets |
|
Runs patch checks only. |
|
Specify the amount of time for which |
|
Runs post-upgrade best practice checks for 11.2.0.4 databases and above. |
|
Runs pre-upgrade best practice checks for 11.2.0.4 databases and above . |
|
Generates probe XML for Enterprise Manager. |
|
Specify a comma-delimited list of profiles to run only the checks in the specified profiles. |
|
Specify to purge compliance data larger than a certain size. |
|
Lists the details of all of the installed |
|
Reads configuration file. This file contains parameters
previously which were set using |
|
Refreshes cache discovery data, which can be used for future
|
|
Specify the remote destination directory so that
|
|
Use to launch |
|
Specify the remote user to run |
|
Repairs checks. Options:
|
|
Prints reverse map for sanitized elements. |
|
Removes cache discovery data. |
|
Rolls back the applied patch
Rolls back the applied data patch
|
|
Specify the amount of time for which |
|
Runs as |
|
Emails |
|
Sets parameter(s) for autorun. Configures the If |
|
Sets ASM HOME. |
|
Sets |
|
Sets EM Agent home. |
|
Sets inventory location. |
|
Sets an entry for the key:value pair in the wallet. |
|
Sets Java home. |
|
Sets JDBC version. |
|
Sets Weblogic server home. |
|
Prints short version. |
|
Shows critical checks in the |
|
Shows AHF home directory. |
|
Shows |
|
Shows PASSed checks in the |
|
Displays check repair command. checkid : Shows repair command for the given check ID. |
|
Runs |
|
Skips security validation. |
|
Does not run the checks specified in the user-defined XML file. |
|
Specify a comma-delimited switch names to run
orachk on switches.
|
|
Runs n: Specify the number of child processes to run on switches. Default is 25% of CPUs. |
|
Runs Number of child processes will be equal to the minimum number of CPUs and number of switches. |
|
Runs |
|
Sets |
|
Appends tagname to the report name. Tagname must contain only alphanumeric characters. |
|
Use |
|
Sends a test email to validate email configuration. |
|
|
|
Specify the version of TLS for curl OSS upload. |
|
Sets |
|
Specify a comma-delimited Top of Rack switch names to run
|
|
Specify identity files directory where identity files to all remote host are present. Options:
|
|
Unlocks the storage cells. Applicable only for Exadata and SuperCluster. Options:
|
|
Unsets set parameter(s). If |
|
Deletes an entry for the key:value pair in the wallet. |
|
Updates |
|
Force upgrades the version of |
|
Uploads collections to the database. |
|
Uploads collections to the service. |
|
Specify to use cache discovery data for the
|
|
Specify a user name. User name is required for retrieving URL. |
|
Specify to use Oracle Trace File Analyzer socket to run. |
|
In full AHF installation, |
|
Displays version. |
|
Specify the custom location of the wallet. Setting this would override the default location of the wallet. |
|
Specify a comma-delimited list of ZFS storage appliance names to
run |
|
Specify a comma-delimited list of ZFS storage appliance names to
run |
|
Sets zip for MOS upload. |