@@@@Platform-“OnPrem”

@@@@Product-“Database”

@@@@ReleaseVersion-“26.11”

@@@@info-map-label-“tfactl blackout”

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.

Syntax

tfactl blackout add|remove|print
-targettype host|crs|asm|asmdg|database|dbbackup|db_dataguard|db_tablespace|pdb_tablespace|pdb|listener|service|os
-target all|name
[-container name]
[-pdb pdb_name]
-event all|"event_str1,event_str2"|availability
[-timeout nm|nh|nd|none]
[-c|-local|-nodes "node1,node2"]
[-reason "reason for blackout"]
[-docollection]

Parameters

tfactl blackout Command Parameters

Parameter Description
add|remove|print| Adds, removes, or prints blackout conditions.

-targettype type

Target type: host|crs|asm|asmdg|database|dbbackup|db_dataguard|db_tablespace|pdb_tablespace|pdb|listener|service|os

Limits blackout only to the specified target type.

host: The whole node is under blackout. If there is host blackout, then every blackout element that's shown true in the Telemetry JSON will have the reason for the blackout.

crs: Blackout the availability of the Oracle Clusterware resource or events in the Oracle Clusterware logs.

asm: Blackout the availability of Oracle Automatic Storage Management (Oracle ASM) on this machine or events in the Oracle ASM alert logs.

asmdg: Blackout an Oracle ASM disk group.

database: Blackout the availability of an Oracle Database, Oracle Database backup, tablespace, and so on, or events in the Oracle Database alert logs.

dbbackup: Blackout Oracle Database backup events (such as CDB or archive backups).

db_dataguard: Blackout Oracle Data Guard events.

db_tablespace: Blackout Oracle Database tablespace events (container database).

pdb_tablespace: Blackout Oracle Pluggable Database tablespace events (Pluggable database).

pdb: Blackout Oracle Pluggable Database events.

listener: Blackout the availability of a listener.

service: Blackout the availability of a service.

os: Blackout one or more operating system records.

-target all|name

Specify the target for blackout. You can specify a comma-delimited list of targets.

By default, the target is set to all.

-container name Specify the database container name (db_unique_name) where the blackout will take effect (for PDB, DB_TABLESPACE, and PDB_TABLESPACE).
-pdb pdb_name Specify the PDB where the blackout will take effect (for PDB_TABLESPACE only).
-events all|"str1,str2"

Limits blackout only to the availability events, or event strings, which should not trigger auto collections, or be marked as blacked out in telemetry JSON.

all: Blackout everything for the target specified.

string: Blackout for incidents where any part of the line contains the strings specified.

Specify a comma-delimited list of strings.

-timeout nh|nd|none Specify the duration for blackout in number of hours or days before timing out. By default, the timeout is set to 24 hours (24h).
-c|-local

Specify if blackout should be set to cluster-wide or local.

By default, blackout is set to local.

-reason comment Specify a descriptive reason for the blackout.
-docollection Use this option to do an automatic diagnostic collection even if a blackout is set for this target.

Example tfactl blackout