TFACTL Command Reference

Learn about the command-line tools and commands for installing, configuring, managing, monitoring, and running compliance checks with Oracle Autonomous Health Framework (AHF).

Running Oracle Trace File Analyzer Administration Commands

Oracle Trace File Analyzer administration commands require root access to tfactl or equivalent sudo privileges. Basic commands start, stop, enable, disable, uninstall, synchronize nodes, restrict protocols, and report daemon status on the local node.

tfactl access

The tfactl access command manages controlled non-root access to Oracle Trace File Analyzer and diagnostic collections. It supports listing, adding, removing, blocking, unblocking, promoting, demoting, granting, revoking, resetting, and removing users, with optional local or JSON output. AHF provides platinum and privileged-compliance-checks roles with additional diagnostic, configuration, metadata, auto-upgrade, and root compliance-check privileges; Oracle Home owners, DBA groups, and ASM groups are added by default during installation or upgrade.

tfactl availability

The tfactl availability command enables or disables Availability Score resources and searches telemetry-cache data. Resources can be selected by type, key, and value or listed for selection; disabling supports temporary periods specified in days, hours, or minutes, with a seven-day default. The dumpcache operation optionally filters results by data type.

tfactl blackout

The tfactl blackout command adds, removes, or displays granular diagnostic-collection suppressions for hosts, Clusterware, ASM, databases, backups, Data Guard, tablespaces, PDBs, listeners, services, and operating-system records. Blackouts can target specific or all resources and events, apply locally or cluster-wide, include containers or PDBs, specify a reason and timeout, and optionally permit diagnostic collection; the default duration is 24 hours.

tfactl cell

The tfactl cell command displays and manages storage-cell configuration, particularly for Exadata environments. status reports cell availability, config shows configuration and wallet details, configure enables cell collections that were not completed during installation or upgrade, and deconfigure removes all storage-cell configuration.

tfactl checkupload

The deprecated tfactl checkupload command validates configured upload parameters and can be run by root or non-root users. It optionally accepts a configuration name, such as a My Oracle Support upload profile; Oracle recommends using ahfctl checkupload instead.

tfactl dbcheck

The tfactl dbcheck command collects diagnostic information from an Oracle Exadata machine to identify operating-system, filesystem, memory, and I/O issues. It is available only on Exadata machines running Oracle Linux and reports checks as successful or failed, including filesystem usage and kernel-parameter comparisons with expected values.

tfactl diagnosetfa

The tfactl diagnosetfa command collects Oracle Trace File Analyzer diagnostic data from the local node to investigate TFA issues. Options specify a repository directory, a tag for the collection directory, and whether diagnostics should run only locally.

tfactl disable

The tfactl disable command stops automatic restarting of the Oracle Trace File Analyzer daemon and prevents it from restarting after failures or system reboots.

tfactl enable

The tfactl enable command enables automatic restarting of the Oracle Trace File Analyzer daemon after a failure or system reboot.

tfactl get

The tfactl get command displays Oracle Trace File Analyzer configuration values for selected parameters and optionally across specified nodes, with matching output support. Available settings cover diagnostics, tracing, repositories, retention and purge policies, disk monitoring, compliance indexes, redaction, discovery, inventory, networking, and collection behavior.

tfactl floodcontrol

The tfactl floodcontrol command controls repeated collection of identical events within a defined time window. It can print, update, or clear event rules and configure the event name, collection limit, initial limit interval in minutes, and pause interval in minutes.

tfactl getresourcelimit

The deprecated tfactl getresourcelimit command reports Oracle Trace File Analyzer CPU and memory usage limits, optionally filtered by tool or resource type. Only TFA can currently be selected as the tool, and Oracle recommends using ahfctl getresourcelimit instead.

tfactl getupload

The deprecated tfactl getupload command displays configured upload settings and can be run by root or non-root users. It supports retrieving all settings or selected connection, authentication, proxy, HTTPS, security, database, table, and header parameters for a named upload configuration; Oracle recommends using ahfctl getupload instead.

tfactl host

The tfactl host command adds or removes hosts from the Oracle Trace File Analyzer cluster configuration. Added hosts are authenticated through synchronized certificates, and their host lists are synchronized before registration; once successfully added, cluster-wide commands become available across registered nodes. The current host list is displayed with tfactl print hosts.

tfactl insight

The tfactl insight command generates AHF Insights reports from selected or all cluster nodes over a specified time range. It supports refreshing data, retaining input collections, identifying the requestor, checking status, and uploading reports to a pre-authenticated URL; the -onlyinsightsupload option uploads only the Insights archive.

tfactl index

The tfactl index command indexes Oracle ORAchk and EXAchk compliance data supplied as a JSON string or file. The result category indexes compliance-check results, while metadata indexes run metadata.

tfactl print

The tfactl print command reads and displays Oracle Trace File Analyzer information from Berkeley DB, including status, components, configuration, scanned directories, cluster hosts, actions, repository usage, run mode, suspended collections, protocols, SMTP settings, and collections. Collection output can be filtered by status or time and formatted as standard text, JSON, pretty JSON, or CSV; configuration output includes operational limits, tracing, monitoring, retention, and purge settings.

tfactl print inventory

The tfactl print inventory command displays metadata for inventoried files, optionally for a specified file path and selected nodes. Results identify the hostname, absolute path, component, filename, date pattern, and last-modified time.

tfactl print syncstatus

The tfactl print syncstatus command reports whether Oracle Trace File Analyzer is synchronized across cluster nodes. Normal output lists each node and its synchronization state, while -short returns a single TRUE or FALSE summary indicating whether all nodes are synchronized.

tfactl purgeindex

The tfactl purgeindex command deletes indexed Oracle ORAchk or EXAchk compliance results or metadata, optionally matching JSON content or data from a specified number of preceding hours or days. Compliance-index retention can also be controlled through maximum run-count and maximum-size thresholds, which remove older or recent data when limits are exceeded.

tfactl purgeinventory

The tfactl purgeinventory command deletes file metadata from the Oracle Trace File Analyzer inventory for a specified file and node scope. The optional -delayreload flag postpones restoration of the file data until the next inventory operation.

tfactl queryindex

The tfactl queryindex command searches indexed compliance results or metadata using filters such as check ID, target, severity, check name, selected fields, and time range. Results can be narrowed to targets or specific checks and returned in structured JSON, with result records containing compliance status, execution details, target information, and associated metadata.

tfactl rediscover

The tfactl rediscover command discovers newly added components and updates Oracle Trace File Analyzer inventory. It performs a full discovery by default, or a lighter discovery when -mode lite is specified.

tfactl refreshconfig

The tfactl refreshconfig command refreshes and manages Oracle Trace File Analyzer cron jobs. It can refresh background jobs, list configured entries and schedules, reload jobs after configuration changes, or specify the TFA configuration environment role.

tfactl refreshconfig modifycron

The tfactl refreshconfig modifycron command modifies a specific Oracle Trace File Analyzer cron entry. It enables or disables the entry and sets or clears the environments where it is valid or excluded, using the cron identifier and supported deployment types.

tfactl restrictprotocol

The tfactl restrictprotocol command restricts a specified communication protocol, optionally forcing the change. For example, it can restrict TLSv1.

tfactl sendmail

The tfactl sendmail command sends a test email to a specified address to verify that the configured SMTP server and email settings are functioning correctly.

tfactl set

The tfactl set command enables, disables, or modifies Oracle Trace File Analyzer configuration settings, including automatic diagnostics, insights, trimming, logging, repository size and location, retention and purge policies, security, disk-usage monitoring, collection limits, Data Guard metrics, indexing, and network behavior. Options such as -c and -local control whether settings apply across the cluster or only to the local node; examples demonstrate configuring automatic collection, repository size, trace levels, log limits, ports, disk monitoring, snapshot intervals, alert-log trimming, and rediscovery.

tfactl setresourcelimit

The deprecated tfactl setresourcelimit command restricts Oracle Trace File Analyzer CPU or memory consumption and should be replaced by ahfctl setresourcelimit. It supports CPU limits within defined minimum and maximum bounds, system memory limits through kmem, combined system and swap limits through swmem, and currently applies to the TFA tool.

tfactl setupload

The deprecated tfactl setupload command configures upload endpoints and should be replaced by ahfctl setupload. It supports HTTPS, SFTP, and SQLNET destinations; credentials, servers, URLs, proxies, authentication behavior, security validation, tokens, headers, requests, database connect strings, and upload tables can be configured by root or non-root users. A named configuration, commonly mos, can then be used to upload collections to My Oracle Support.

tfactl showrepo

The deprecated tfactl showrepo command displays repository locations for Oracle Autonomous Health Framework components and should be replaced by ahfctl showrepo. Users can display repositories for all components, Oracle Trace File Analyzer only, or compliance tools such as Oracle ORAchk and Oracle EXAchk.

tfactl start

The tfactl start command starts the Oracle Trace File Analyzer daemon on the local node and can also start a specified support tool.

tfactl startahf

The deprecated tfactl startahf command starts schedulers for Oracle Autonomous Health Framework components and should be replaced by ahfctl startahf. It can start Oracle Trace File Analyzer, compliance daemons, or both, optionally passing supported TFA, Oracle ORAchk, and Oracle EXAchk startup arguments.

tfactl status

The tfactl status command checks the current run status of Oracle Trace File Analyzer.

tfactl statusahf

The deprecated tfactl statusahf command checks scheduler and daemon status for Oracle Autonomous Health Framework components and should be replaced by ahfctl statusahf. It reports the status of TFA, compliance components, or all supported components.

tfactl stop

The tfactl stop command stops the Oracle Trace File Analyzer daemon on the local node and can also stop a specified support tool.

tfactl stopahf

The deprecated tfactl stopahf command stops schedulers for Oracle Autonomous Health Framework components and should be replaced by ahfctl stopahf. It can stop TFA, compliance daemons, or all supported component daemons.

tfactl syncnodes

The tfactl syncnodes command generates and distributes Oracle Trace File Analyzer certificates among TFA nodes. It can regenerate certificates with a specified key size, remove certificates, operate only on the local node, and run silently in the background without interactive prompts.

tfactl uninstall

The tfactl uninstall command removes Oracle Autonomous Health Framework by stopping Oracle ORAchk and TFA and deleting the installation directory. It can uninstall locally or across configured nodes, suppress confirmation prompts, and optionally delete the AHF repository.

tfactl upload

The tfactl upload command uploads collections or files on demand and can be run by root or non-root users. It accepts an upload configuration name, Service Request or target identifier, and file name; configured destinations such as My Oracle Support can also be used through related diagnostic-collection workflows.

tfactl unsetresourcelimit

The deprecated tfactl unsetresourcelimit command removes CPU or memory restrictions previously applied to Oracle Trace File Analyzer and should be replaced by ahfctl unsetresourcelimit. It supports selecting the TFA tool and either CPU or memory resources.

tfactl unsetupload

The deprecated tfactl unsetupload command removes configured upload parameters and should be replaced by ahfctl unsetupload. It can unset all settings or selected endpoint attributes, including configuration names, credentials, servers, URLs, proxies, authentication, tokens, headers, security settings, database connection strings, and upload tables.

tfactl version

The tfactl version command reports the versions of Oracle Autonomous Health Framework components. It can display versions for all components, Oracle Trace File Analyzer, or compliance tools such as Oracle ORAchk and Oracle EXAchk.

Running Oracle Trace File Analyzer Summary and Analysis Commands

This section introduces Oracle Trace File Analyzer commands for viewing deployment and operational summaries, checking status, and reviewing changes and events detected across the environment.

tfactl analyze

The tfactl analyze command analyzes database, ASM, Grid Infrastructure, ACFS, system, OSWatcher, and related logs. It can summarize common messages, search for text within specified time ranges, classify messages as errors, warnings, or generic events, analyze OSWatcher statistics, filter by component and node, produce verbose or file output, and generate timelines for selected logs. Time filters, component selection, message type, database context, JSON-like search behavior, and oratop options provide targeted investigation capabilities.

tfactl changes

The tfactl changes command reports configuration and system changes detected by Oracle Trace File Analyzer over a specified interval or date. Reports can be filtered by change type and node and optionally generated in JSON format; supported categories include database and operating-system parameters, packages, Oracle homes, and patches.

tfactl events

The tfactl events command displays detected database, ASM, Clusterware, and alert-log events. Users can filter by keyword, component, database, instance, source file, node-related time range, or date, and can request JSON output containing all or selected fields. TFA recognizes a broad set of Oracle error and failure events, including internal errors, instance failures, corruption, resource exhaustion, ASM issues, and Clusterware problems.

tfactl isa

The tfactl isa command displays the Infrastructure Service Automation score. It can include the availability score, show all available details, and limit results to selected nodes, all nodes, or the local node.

tfactl param

The tfactl param command displays operating-system and database parameter values and replaces tfactl run param. Users can filter by parameter type, parameter name, database, and node, request JSON output, or refresh the underlying parameter data; supported examples include SGA settings, database uniqueness, and shared-memory limits.

tfactl run

The tfactl run command executes inventory, one-time scans, or Oracle Trace File Analyzer support tools, although tfactl run param is being replaced by tfactl param. Available tools include Oracle ORAchk, oratop, OSWatcher Analyzer, Procwatcher, alert summaries, Clusterware logs, grep, history, file searches, log management, menus, parameter inspection, process and stack inspection, system summaries, log tailing, triage, and file editing.

tfactl search

The tfactl search command searches metadata stored in the Oracle Trace File Analyzer index. It accepts JSON search criteria, can restrict returned JSON fields, and can display available datatypes or the fields associated with a selected datatype.

tfactl summary

The tfactl summary command provides a deployment and system-status summary for Oracle Trace File Analyzer. It can report overview, Clusterware, ASM, ACFS, database, Exadata, patch, listener, network, operating-system, TFA, and summary metadata information, with options for JSON or HTML output, console printing, silent operation, history, node selection, and help.

tfactl toolstatus

The tfactl toolstatus command displays the deployment, version, and runtime status of Oracle Trace File Analyzer support tools across nodes. Results distinguish tools that are deployed and available, configured but not running, and currently running, covering development tools, support-tool bundles, and TFA utilities.

Running Oracle Trace File Analyzer Diagnostic Collection Commands

This section introduces Oracle Trace File Analyzer commands used to collect diagnostic data for troubleshooting and support.

tfactl collection

The tfactl collection command manages existing diagnostic collections. It can stop a collection by ID and list the contents of a specified collection archive or all archives within a named collection, including nested ZIP files.

tfactl diagcollect

The tfactl diagcollect command performs on-demand diagnostic collections, including default, event-driven SRDC, custom, and AHF Insights collections. It supports component, node, cell, time-range, output, tagging, trimming, copying, dry-run, background, core-file, directory and file selection, redaction or sanitization, archive merging, upload, and foreground-log filtering options. Collections may require authorized users, and from AHF 25.3 diagnostic or insights periods must be at least 15 minutes; AHF also supports uploading Insights reports to pre-authenticated locations.

Smart Problem Classification to Help Oracle Support Resolve Service Requests Faster

Smart Problem Classification helps AHF identify the specific problem associated with a diagnostic collection by analyzing relevant events and presenting selectable events or hierarchical problem categories. It records the selected problem, time, and location to support faster Service Request resolution, is enabled by default for applicable tfactl diagcollect operations, and can be disabled or bypassed with configuration or command options. The feature is unavailable on AIX and Microsoft Windows and is not used with several specialized collection switches and modules.

tfactl diagcollect -srdc

The tfactl diagcollect -srdc command runs a Service Request Data Collection using a specified profile, database, time range, tag, and output filename. Profiles cover database, ASM, Clusterware, listener, Data Pump, RMAN, performance, installation, upgrade, Enterprise Manager, GoldenGate, operating-system, and many Oracle error scenarios. The command can also collect CRS, ASM, and cell information when cells are configured in TFA, including support for selected cell-related CRS errors and explicit cell-node targeting.

tfactl directory

The tfactl directory command adds, removes, modifies, and lists directories whose trace or log files are analyzed and collected by Oracle Trace File Analyzer. Directory settings control public or private access, filename and time exclusions, collect-all behavior, and node scope. Added directories are recorded in TFA metadata, and when their component or database context cannot be inferred, the user must provide the appropriate classification details.

tfactl ips

The tfactl ips command collects and manages Automatic Diagnostic Repository diagnostic data through Incident Packaging Service operations. It supports creating, populating, correlating, finalizing, generating, inspecting, deleting, and unpacking diagnostic packages; adding or removing incidents and files; copying files into or out of ADR; managing remote incident keys; viewing problems, incidents, files, package details, manifests, and metadata; and changing or displaying packaging configuration. Packages may be built from incidents, problems, problem keys, or time ranges, with BASIC, TYPICAL, or ALL correlation levels, and generated as complete or incremental ZIP archives.

tfactl managelogs

The tfactl managelogs command manages ADR log and trace files by purging data or displaying storage usage and volume changes. Purging can target files older than a specified number of minutes, hours, or days, Oracle Grid Infrastructure logs, selected or all database logs, or HAMI trace and output directories; the -dryrun option estimates or reports files that would be removed without deleting them. Show operations provide corresponding usage or variation information for these scopes.

tfactl purge

The tfactl purge command deletes aged collections and log files from AHF components on the local node. It can target TFA data, compliance data, component collections, OSWatcher files, managelogs files, or other support-tool directories, with age thresholds specified in hours or days. The default scope covers applicable purgeable data, while -dryrun lists files eligible for removal without deleting them; successful executions report the deleted paths.
Read More: tfactl purge