AHFCTL Command Reference

Running AHFCTL Commands to Manage EMail Configuration for All AHF Tools

This page documents commands for configuring, viewing, validating, clearing, and testing SMTP settings used by AHF tools. ahfctl setsmtp manages server, credentials, sender and recipient addresses, ports, SSL, authentication, and copy recipients; getsmtp queries individual or all settings; checksmtp validates stored configuration and optional attachments; unsetsmtp removes selected or all settings, including defaults; and sendmail sends a test message with optional recipients, subject, body, and attachment.

Running AHFCTL Update Commands to Automatically Patch Oracle Autonomous Health Framework

This page describes AHF commands for configuring and executing automatic metadata updates, which require AHF install-user privileges. ahfctl setupdate configures the staging location, autoupdate state, REST service, filesystem type, and 1–30-day frequency; getupdate displays these settings; unsetupdate removes selected or all settings; and update downloads or processes available metadata, after which the update archive may need to be applied on cluster nodes. A staged update should be tested in pre-production before being distributed to production systems.

Running AHFCTL Update Commands to Apply AHF Metadata and Framework Updates

This page covers applying, inspecting, rolling back, and removing backups for AHF metadata, framework, Java, and configuration-file updates. applyupdate installs an update archive on the local node and must be run on every cluster node, queryupdate reports applied updates by ID or in full, rollbackupdate restores a specified or previous state, and deleteupdatebackup removes historical backup directories when space is required; deleting backups in order and never removing the current update preserves rollback capability. The page also describes Java-only updates and newer configuration-file updates, noting that these legacy commands are deprecated in favor of newer AHF software commands.

Running AHFCTL Upgrade Commands to Upgrade Oracle Autonomous Health Framework

This page documents root-level commands for configuring and performing complete AHF version upgrades. getupgrade reads upgrade settings from ahf.properties, optionally as JSON; setupgrade configures automatic upgrade, staging location, schedule, filesystem, temporary directory, installer cleanup, REST service, frequency, and related autoupdate behavior; unsetupgrade removes selected or all settings; and upgrade installs the newest available AHF version from a staging location or REST endpoint. Custom download ports must be configured separately when the default HTTPS port is not used.

Running AHFCTL Upload Commands to Upload Diagnostics

This page explains how to configure, inspect, validate, remove, and use AHF upload endpoints for diagnostics and reports. setupload defines HTTPS, SFTP, or SQLNet destinations, credentials, URLs, proxies, security, tokens, headers, database targets, and custom ports; getupload retrieves configuration details; checkupload validates a named configuration; unsetupload removes selected or all settings; and upload transfers a specified file, commonly to My Oracle Support. The mos configuration name is required for MOS integrations, and Object Store endpoints can support automatic AHF Insights report uploads.

Running AHFCTL Commands to Manage the Scheduler for Oracle Autonomous Health Framework Components

This page describes root- or sudo-level control of the AHF scheduler and its TFA and compliance daemons. startahf starts TFA, Oracle Orachk, and Oracle Exachk schedulers individually or together, with optional component arguments; statusahf reports daemon state, hosts, processes, versions, schedules, retention, previous and next runs, and system health; and stopahf stops selected or all scheduler components, including active compliance scheduling and related services.

Running AHFCTL Commands to Manage Cell Switches Databases and exacli Passwords

This page documents privileged password-management commands for cells, switches, databases, and exacli users. checkpassword verifies passwords for selected nodes, databases, users, or exacli accounts; setpassword establishes passwords for the specified targets; and unsetpassword removes them. Node and database selections are supplied as comma-delimited lists, with -user identifying the account and -exacli targeting a cell’s exacli user.

Running AHFCTL Commands to Get the Repository Locations of Oracle Autonomous Health Framework Components

This page describes the privileged ahfctl showrepo command, which displays repository information for all AHF components or specifically for TFA or compliance components. Output includes each node’s repository location, maximum capacity, current and free space, and repository status, enabling administrators to inspect storage allocation and availability across the environment.

Running AHFCTL Commands to Import Oracle Orachk or Oracle Exachk Wallet Details into Oracle Autonomous Health Framework Wallet and Configuration

This page documents the privileged ahfctl import command for migrating Oracle Orachk or Oracle Exachk wallet details from versions 19.2.0 or earlier into the AHF wallet and configuration. The command accepts the wallet import type and the filesystem location of the source wallet, allowing existing authentication details to be incorporated into AHF.

Running AHFCTL Commands to Limit CPU and Memory Usage

This page covers Linux 64 resource controls for TFA, requiring root or sudo privileges and, for setting limits, a full root installation of AHF. getresourcelimit displays CPU or memory limits, setresourcelimit applies CPU, kernel-memory, or combined memory-and-swap limits using cgroups v1 or v2, unsetresourcelimit removes them, and printresourcestats reports usage statistics for managed resources. CPU and memory values have defined minimums and maximums, while -force permits exceeding calculated maximums.

Running AHFCTL Commands to Collect Storage Server Diagnostic Package

This page documents the privileged ahfctl celldiagcollect command for collecting storage-server diagnostic packages. Administrators can specify the collection start time, duration of one to six hours, an eligibility timeframe, the destination path, and polling timeouts for newly submitted or previously submitted package requests. These options control which logs and traces are collected, where the package is copied, and how long AHF waits for package generation.

Running AHFCTL Commands to Manage Service Upload Parameters

This page documents the deprecated service-upload commands getserviceupload, setserviceupload, and unsetserviceupload, which were removed in AHF 23.3. They previously retrieved, configured, or cleared service upload credentials, HTTPS URLs, proxies, keystore types, and certificate-validation behavior, with root or non-root execution permitted. Administrators should use the newer named-endpoint commands getupload, setupload, and unsetupload instead.

AHFCTL Compliance Framework Oracle Orachk and Oracle Exachk Command-Line Options

The ahfctl compliance command runs compliance checks across Oracle Engineered and non-engineered systems, supporting check selection, database, node, cell, switch, and storage targeting, parallel or serial execution, discovery caching, profiles, upgrades, diagnostics, reporting, repair, encryption, email, remote execution, wallet configuration, and upload management. Deprecated upload and sanitization parameters were removed in release 23.3 and replaced by ahfctl setupload, unsetupload, getupload, checkupload, and redact; the command also includes specialized options for application continuity, CVU, Exadata, ORDS, pre- and post-upgrade checks, and autorun scheduling.

Running AHFCTL Commands to Sanitize Sensitive Information and Reverse Map Sanitized Elements

The ahfctl redact command sanitizes sensitive information in regular files, ZIP files, and directories using masking or substitution-map sanitization, optionally limited to system, database, or user-data entities and written to a specified output directory; it is unsupported on Microsoft Windows and does not redact automatic Service Request collections. The ahfctl rmap command reverse-maps sanitized values generated by Oracle Trace File Analyzer and Orachk, displaying either selected substituted strings or all available original values, and is also unsupported on Microsoft Windows.

Running AHFCTL Commands to Manage InfiniBand and RoCE Switches

The ahfctl switch command enables privileged AHF installation users with root privileges to configure, inspect, deconfigure, and debug InfiniBand and RoCE switch settings, with optional switch lists and JSON status output. RoCE switches are not discovered automatically and must be supplied through RAT_SWITCHES or the configuration command; alternate connection users can be specified with RAT_IBSWITCH_USER, and configuration can either receive a comma-delimited list or prompt interactively for switch names.

Running AHFCTL Commands to Uninstall AHF

The ahfctl uninstall command stops Oracle Orachk and Oracle Trace File Analyzer and removes the Oracle Autonomous Health Framework installation directory. By default, it uninstalls AHF across all configured nodes; -local limits removal to the local node, -silent suppresses uninstall prompts, and -deleterepo additionally deletes the AHF repository.
Read More: Running AHFCTL Commands to Uninstall AHF