A.20 IBM Tivoli Enterprise Console (T/EC)

When entering T/EC adapter property values, include two single quotes instead of a single quote within a single-quoted string. For example, a correct entry for adding a single quote before and after the word single:

msg='double ''single'' quotes'

Table A-24 IBM Tivoli T/EC Adapter Properties

Property

Specify…

AckAffectsCondition

If True, an acknowledged alarm contributes to element condition and alarm counts. The default is True.

For example, assume there is an element with one critical event:

counts= 1‑CRITICAL element=RED

Acknowledge the alarm and set AckAffectsCondition to True. This results in reducing the alarm count by one and changing the element condition to green:

counts= 0‑CRITICAL element=GREEN

Acknowledge the alarm and set AckAffectsCondition to False. The result is the alarm still exists and the condition remains unchanged after acknowledging it:

counts= 1‑CRITICAL element=RED

AcknowledgeAvailable

If True, the Acknowledge option is available across the entire instance of the T/EC adapter. If False, the Acknowledge option is not available on the alarm right-click menu, regardless of the user access privileges. The default is True.

AlarmColumns

A comma-separated list that determines which alarm columns display and the order in which the alarm items display in the Alarms view. The defaults are: Status,Class,Description.

Aliases for Alarm Columns: Assign new names to alarm columns using the format: display_name=current_name. For example, Condition=Status displays status data in a column named Condition.

CloseAvailable

If True, the Close option is available across the entire instance of the T/EC adapter. If False, the Close option is not available on the alarm right-click menu, regardless of the user access privileges. The default is True.

ClosedAlarmsTimeout

The length of time, in seconds, to display an alarm after closing it in the Operations Center console. Enter ‑1 to display the alarm indefinitely. Enter 0 to remove it immediately. The default is 1800.

ElementsTimeout

If there are no open alarms, and the element’s condition hasn’t changed in the last n seconds, and the element has no children, then the element disappears from the display. If another alarm is generated for this element, then it reappears. The default is 300 seconds.

ElementsTimeout < 0: Never time out.

ElementsTimeout = 0: Time out immediately.

ElementsTimeout > 0: Time out after specified time expires.

EventConsoleName

The ID used by the Operations Center server to identify itself to T/EC. This value must be a valid T/EC Enterprise client name of the T/EC system being integrated.

For T/EC 3.6, to look up console names, use the wlookup –ar Enterprise Client command from the T/EC server or IBM Tivoli TMR. The default is @Formula.

EventListenPort

The TCP/IP socket port number for which T/EC is configured to forward its events. Use any port number (above 1000 in UNIX). The default is 12345.

ForceDateUpdate

If True, overrides the alarm date with the T/EC date_reception or date slot if available. If set to True and UseAlarmTimesForConditionChanges is True, historical alarms can be imported for use with BSLM. Condition data generates from historical alarms and key performance metrics can be stored using the historical alarm properties. The default is False.

HierarchyFile

A file in the /OperationsCenter_install_path/database directory that contains an XML description of the element hierarchy to build below the adapter element. The default is examples/TecHierarchy.xml.

HostsToMine

Use one of the following values:

  • Blank: This property only affects the mining of open/acknowledged events when the adapter starts. The adapter functions properly without any entry. The difference is if it discovers all previously opened/acknowledged events or only new events as they occur.

  • List of hostnames: A T/EC adapter can connect and multiplex many ORBs on many hosts. This entry can consist of a list of hostnames separated by commas.

    Each ORB can listen on a different port. This entry can contain a more complex entry such as:

    hostname:ORBPort

    A T/EC server can listen on different ports. This entry can contain a more complex entry such as:

    hostname:ORBPort:TECPort

Assume the following configuration:

1) host x, ORB listening on port 9990, T/EC Server listening on port 9991

2) host y, ORB listening on port 9995, T/EC Server listening on port 9996

Set the adapter property HostsToMine to:

x:9990:9991,y:9995:9996

IdDateMethod

If True, Operations Center generates the alarm date based on the T/EC originating_event_id alarm column. If False, Operations Center generates the alarm date based on the T/EC date_reception alarm column. The default is False.

MaxActiveReaders

The maximum number of threads reading at one time. The default is 1.

MaxAlarms

The maximum number of alarms that the adapter queries and retains. Exceeding this number removes the oldest alarm. Enter 0 to allow an unlimited number of alarms. The default is 500.

MiningLimit

The maximum number of T/EC events that the ORB retrieves from each T/EC host. The default is 2000.

Script.onError

A script that executes if the adapter fails for any reason. For example, the script can print the reason for the failure as msg using log.info(msg).

Script.onInitialized

A script that executes when the adapter initializes. All of the Script.* properties are optional.

Script.onStarted

A script that executes when the adapter starts, either manually or automatically when the Operations Center server starts.

Script.onStopped

A script that executes after stopping the adapter.

SeedFile

A file in the T/EC reception log format that contains information about its managed elements. This file enables the Operations Center server to generate the elements hierarchy displayed in the Operations Center console.

SeverityMapping

Maps the T/EC severity codes to Operations Center severity codes. List the T/EC severity code first. The default is:

Fatal=Critical;Critical=Critical;Minor=Minor;Warning=Major;Harmless=Informational;Unknown=Unknown

StylesheetFile

The stylesheet file in the /OperationsCenter_install_path/database directory that applies to the HierarchyFile as a style markup to produce the final output.

SuppressAvailable

If True, the Suppress Alarm operation is available across the entire instance of the T/EC adapter. If False, the Suppress Alarm right-click option is not available regardless of ACLs. The default is True.

Suppression Time

The time in seconds that an alarm can remain in the suppressed state. Enter 0 to disable the feature. The default is 1800.

The T/EC adapter Suppress Alarm alarm operation suppresses any alarm with an OPEN status for a fixed amount of time. The severity level for a suppressed alarm changes to SUPPRESSED and the alarms severity does not populate up the element hierarchy. The alarm remains in this state until one of the following occurs:

  • The operator closes the alarm

  • The alarm changes severity to OK

  • The timer expires

  • The operator uses the Unsuppress Alarm operation

SyncClass

The default is TEC_sync, which allows multiple instances of T/EC to synchronize their alarms.

TecORBPort

The TCP/IP port number on which the Operations Center ORB listens. The TecORB default is 1576.

UseAlarmTimesFor CondChanges

The date/time stamp to use for all alarm data stored by the Operations Center Data Warehouse. If true, the alarm’s date/time stamp is used. If false, the date/time stamp of when the Operations Center server received the alarm is used. The default is true.

WTDumperCommand

If using ORB Integration, the ORB issues this command upon startup for initial data mining, to pipe events back. The default is:

wtdumper ‑o DESC ‑dw "status<='20' AND severity>='20'"

Edit the command based on the database syntax requirements.