2. Command Line Reference
  3. TFACTL Command Reference
  4. Running Oracle Trace File Analyzer Administration Commands

9.3.1 Running Oracle Trace File Analyzer Administration Commands

You need root access to tfactl, or sudo access to run all administration commands.

Table 9-44 Basic tfactl commands

Command Description

tfactl start

Starts the Oracle Trace File Analyzer daemon on the local node.

tfactl stop

Stops the Oracle Trace File Analyzer daemon on the local node.

tfactl enable

Enables automatic restart of the Oracle Trace File Analyzer daemon after a failure or system reboot.

tfactl disable

Stops any running Oracle Trace File Analyzer daemon and disables automatic restart.

tfactl uninstall

Removes Oracle Trace File Analyzer from the local node.

tfactl syncnodes

Generates and copies Oracle Trace File Analyzer certificates from one Oracle Trace File Analyzer node to other nodes.

tfactl restrictprotocol

Restricts the use of certain protocols.

tfactl status

Checks the status of an Oracle Trace File Analyzer process.

The output is same as tfactl print status.

  • tfactl access
    Use the tfactl access command to enable non-root users to have controlled access to Oracle Trace File Analyzer, and to run diagnostic collections.
  • tfactl availability
    Use the tfactl availability command to enable or disable resources for Availability Score, and to search a specific data type in the telemetry cache.
  • tfactl blackout
    Use the tfactl blackout command to suppress diagnostic collections at a more granular level. By default, blackout will be in effect for 24 hours.
  • tfactl cell
    Use the tfactl cell command to print or modify various storage cell configuration.
  • tfactl checkupload
    Use the tfactl checkupload command to validate the configured upload parameters.
  • tfactl dbcheck
    Use the tfactl dbcheck command to collect diagnostic data from the Oracle Exadata machine to identify issues with operating system, file system, memory, and I/O system.
  • tfactl diagnosetfa
    Use the tfactl diagnosetfa command to collect Oracle Trace File Analyzer diagnostic data from the local node to identify issues with Oracle Trace File Analyzer.
  • tfactl disable
    Use the tfactl disable command to prevent the Oracle Trace File Analyzer daemon from restarting.
  • tfactl enable
    Use the tfactl enable command to enable automatic restart of the Oracle Trace File Analyzer daemon after a failure or system reboot.
  • tfactl get
    Use the tfactl get command to view the details of various Oracle Trace File Analyzer configuration settings.
  • tfactl floodcontrol
    Use the tfactl floodcontrol command to limit or stop Oracle Trace File Analyzer collecting the same events in a given frame of time.
  • tfactl getresourcelimit
    Use the tfactl getresourcelimit command to fetch details of Oracle Trace File Analyzer CPU and memory usage limitations.
  • tfactl getupload
    Use the tfactl getupload command to fetch the details of configured upload parameters.
  • tfactl host
    Use the tfactl host command to add hosts to, or remove hosts from the Oracle Trace File Analyzer configuration.
  • tfactl insight
    Use the tfactl insight command to generate AHF Insights report from across nodes in the AHF cluster.
  • tfactl index
    Use the tfactl index command to index events.
  • tfactl print
    Use the tfactl print command to print information from the Berkeley DB (BDB).
  • tfactl print inventory
    Use the tfactl print inventory command delete file metadata.
  • tfactl print syncstatus
    Use the tfactl print syncstatus command to get the sync status of TFA on all cluster nodes.
  • tfactl purgeindex
    Use the tfactl purgeindex command to index events.
  • tfactl purgeinventory
    Use the tfactl purgeinventory command delete file metadata.
  • tfactl queryindex
    Use the tfactl queryindex command to view stored events.
  • tfactl rediscover
    Use the tfactl rediscover command to discover new components and update inventory.
  • tfactl refreshconfig
    Use the tfactl refreshconfig command to refresh and list Oracle Trace File Analyzer cron jobs.
  • tfactl refreshconfig modifycron
    Use the tfactl refreshconfig modifycron command to modify the Oracle Trace File Analyzer cron entry.
  • tfactl restrictprotocol
    Use the tfactl restrictprotocol command to restrict certain protocols.
  • tfactl sendmail
    Use the tfactl sendmail command to send a test email to verify SMTP configuration.
  • tfactl set
    Use the tfactl set command to enable or disable, or modify various Oracle Trace File Analyzer functions.
  • tfactl setresourcelimit
    Use the tfactl setresourcelimit command to restrict the CPU and memory usage of Oracle Trace File Analyzer.
  • tfactl setupload
    Use the tfactl setupload command to set upload parameters.
  • tfactl showrepo
    Use the tfactl showrepo command to get the repository locations of Oracle Autonomous Health Framework components.
  • tfactl start
    Use the tfactl start command to start the Oracle Trace File Analyzer daemon on the local node, and also to start the desired support tool.
  • tfactl startahf
    Use the tfactl startahf command to start the scheduler for Oracle Autonomous Health Framework components.
  • tfactl status
    Use the tfactl status command to check the run status of Oracle Trace File Analyzer.
  • tfactl statusahf
    Use the tfactl statusahf command to check the shceduler status for Oracle Autonomous Health Framework components.
  • tfactl stop
    Use the tfactl stop command to stop the Oracle Trace File Analyzer daemon on the local node, and also to stop the desired support tool.
  • tfactl stopahf
    Use the tfactl stopahf command to stop the scheduler for Oracle Autonomous Health Framework components.
  • tfactl syncnodes
    Use the tfactl syncnodes command to generate and copy Oracle Trace File Analyzer certificates to other Oracle Trace File Analyzer nodes.
  • tfactl uninstall
    Use the tfactl uninstall command to uninstall Oracle Autonomous Health Framework.
  • tfactl upload
    Use the tfactl upload command to upload collections or files on demand.
  • tfactl unsetresourcelimit
    Use the tfactl unsetresourcelimit command to unset the limitations set on Oracle Trace File Analyzer CPU and memory usage.
  • tfactl unsetupload
    Use the tfactl unsetupload command to unset the configured upload parameters.
  • tfactl version
    Use the tfactl version command to check the version of Oracle Autonomous Health Framework components.

Parent topic: TFACTL Command Reference

9.3.1.1 tfactl insight

Use the tfactl insight command to generate AHF Insights report from across nodes in the AHF cluster.

AHF 23.8

Starting in AHF 23.8, you will be able to upload to pre-authenticated (PAR) URL. Uploading AHF Insights reports helps Oracle Cloud Operations to identify, investigate, track, and resolve system health issues and divergences in best practice configurations quickly and effectively.

Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D) and Oracle Base Database Service

To upload AHF Insights report to PAR location, run:
tfactl diagcollect -insight -last 1h -par <par_url>
tfactl insight -last 1h -par <par_url>

Syntax

tfactl insight 
[-h] 
[-node NODE] 
[-last LAST | -for FOR | -from [FROM]] 
[-to [TO]] 
[-refresh] 
[-keepinput] 
[-par PAR] 
[-request_from REQUEST_FROM] 
[-onlyinsightsupload] 
[-status]

Parameters

Prefix each option with a minus sign (-).

Option Description

-node all|local|n1,n2,...

Specify a comma-delimited list of nodes from which to collect diagnostic information. Default is all.

[-last <n><m|h|d>| | -from time -to time | -for time]
  • Specify the -last parameter to collect files that have relevant data for the past specific number of minutes (m), number of hours (h), or days (d). By default, using the command with this parameter also trims files that are large and shows files only from the specified interval.
  • Specify the -from and -to parameters (you must use these two parameters together) to collect files that have relevant data during a specific time interval, and trim data before this time where files are large.

    Supported time formats:

    "Mon/dd/yyyy hh:mm:ss"

    "yyyy-mm-dd hh:mm:ss"

    "yyyy-mm-ddThh:mm:ss"

    "yyyy-mm-dd"

  • Specify the -for parameter to collect files that have relevant data for the time given. The files tfactl collects will have timestamps in between which the time you specify after -for is included. No data trimming is done for this option.

    Supported time formats:

    "Mon/dd/yyyy"

    "yyyy-mm-dd"

    date

Note:

If you specify both date and time, then you must enclose both the values in double quotation marks (""). If you specify only the date or the time, then you do not have to enclose the single value in quotation marks.

-refresh

Provide fresh data from AHF Insight sources.

-keepinput

Specifies not to remove the input_collection directory.

-par PAR

Uploads collection to a pre-authenticated URL.

-request_from REQUEST_FROM

Specifies the requestor of the collection.

-onlyinsightsupload

Specifies only to upload insights zip to Object Store or a pre-authenticated URL.

-status

Checks the status of AHF Insights.

Parent topic: Running Oracle Trace File Analyzer Administration Commands