Configuration Options

port

Network port on which the Ops Connector for IBM Tivoli listens for incoming IBM Tivoli events.

Default value: 5529

Number of worker threads used to receive incoming events. Each worker thread is able to handle one incoming request at a time.

Default value: 10

Timeout in milliseconds for I/O operations on the server socket of the EIF (Event Integration Facility) receiver.

Default value: 500

This option enables or disables secure communication using the SSL protocol.

Default value: true

String that specifies the web address to use in the REST Web Service communication between Ops Connector for IBM Tivoli and Operations Connector. Specify a valid URL string without the scheme name (protocol), hostname, and port.

Default value: /bsmc/rest/events/HPBsmIntTivoli

Default port of Operations Connector policies of the REST Web Service Listener type. As long as you do not reconfigure Operations Connector, you may not alter this option.

Default value: 30005

Fully qualified domain name (FQDN) or IP address of your Operations Connector host.

Default value: localhost

This option enables or disables a local file-based message buffering mechanism. When the mechanism is enabled, messages are delivered in any circumstance.

Default value: true

Path of the directory for persistency data files: an internal buffer for the not-yet-dispatched messages. You must create the directory in advance with the read and write access enabled.

Windows default value: ${OvDataDir}\tmp\HPBsmIntTivoli\

Linux default value: /var/opt/OV/tmp/HPBsmIntTivoli/

Size (in kilobytes) that a persistency data file must exceed to initiate the creation of a new data file.

Default value: 10240

Maximum number of persistency data files the message buffering mechanism maintains.

Default value: 10

You may not alter this option.

Default value: HPBsmIntTivoli-events

Time period (in seconds) that Ops Connector for IBM Tivoli waits before retrying to send the REST Web Service request. This option is ignored if the use-persistency basic option is set to false.

Default value: 30

You may not alter this option.

Value: tivoli_event_message

Attribute name of a received IBM Tivoli event that contains a hostname, from which topology data is constructed. This option is used events are received from an IBM Tivoli Monitoring system.

Default value: hostname

Attribute name of a received IBM Tivoli event that contains a hostname, from which topology data is constructed. This option is used events are received from an IBM Tivoli Netcool/OMNIbus system.

Default value: origin

Attribute name of a received IBM Tivoli event that contains an IP addresses, from which topology data is constructed.

Default value: origin

Attribute name of a received OpsCx for IBM Tivoli event that contains an IP addresses, from which topology data is constructed.

Default value: node_alias

Location of discovery store file which stores information about events to construct topology.

Windows default value:
${OvDataDir}\datafiles\HPBsmIntTivoli\discovery-event.json

Linux default value: /var/opt/OV/datafiles/HPBsmIntTivoli/discovery-event.json

Path of the file with a valid Lua script that processes IBM Tivoli event data.

Windows default value:
${OvInstallDir}bin\win64\HPBsmIntTivoli\lua \
\discovery_processor.lua

Linux default value:
/opt/OV/lib64/HPBsmIntTivoli/lua/discovery_processor.lua

Additional search paths where Ops Connector for IBM Tivoli searches for Lua modules. Separate the paths with semicolons and use wildcard characters if needed. This option is used to set the global Lua variable package.path.

Windows default value:
${OvInstallDir}bin\win64\HPBsmIntTivoli\lua\?.lua

Linux default file:
/opt/OV/lib64/HPBsmIntTivoli/lua/?.lua

The directory of the BAROC (Basic Recorder of Objects in C) event definition files, which are used in IBM Tivoli environments and can be reused to determine default values of the event attributes.

Windows default value:
${OvDataDir}conf\HPBsmIntTivoli\baroc

Linux default value:
/var/opt/OV/conf/HPBsmIntTivoli/baroc

Event class name used to detect IBM Tivoli bulk deletion events.

Default value: OMNIbus_Delete

Attribute name of the identifier list used in IBM Tivoli bulk deletion events.

Default value: identifier_list

Attribute name for the single identifier in the generated event when IBM Tivoli bulk deletion event splitting is enabled.

Default value: identifier

Path of the event output file to which Ops Connector for IBM Tivoli writes data. You do not have to create this file in advance.

Windows default value:
${OvDataDir}\datafiles\HPBsmIntTivoli\tivoli_events.xml

Linux default value:
/var/opt/OV/datafiles/HPBsmIntTivoli/tivoli_events.xml

Name of the root element in the event output XML file

Default value: tivoli_event_message

You may alter this option only to locally generate an event output file in the XML format for troubleshooting purposes. Follow the instructions in Troubleshooting the Collection of Events and Topology. Afterward, adjust the options in the sink (xmltrace) section to fine-tune the output file generation.

Default value: 1

Number of concurrent connections Ops Connector for IBM Tivoli should use for transferring event data to Operations Connector.

Default value: 5

Maximum number of messages that Ops Connector for IBM Tivoli should put into a single REST Web Service request.

Default value: 10

Path of the file that stores a valid CA certificate in the PEM format and which is used to verify the identity of the remote server. The certificate must contain the private key and the public key. The private key may not use a password. Although you can use different ways to obtain such certificate, it is strongly recommended that you use a certificate issued by a certificate authority (CA).

This option must be set when the use-ssl option in the sink (eventsinknode) subsection is set to true.

Default value: (empty)

The option that, when set to true, causes Ops Connector for IBM Tivoli to use the credentials specified for the auth-username and auth-password options to authenticate against the remote REST Web Service endpoint.

Enable secure communication by using the SSL protocol to prevent the authentication credentials from being sent unencrypted to the Operations Connector host.

Default value: false

The option that, when set to true, causes Ops Connector for IBM Tivoli to obtain the authentication credentials from the GenInt keystore rather than from the integration configuration file. In this case, the values of the auth‑username and auth‑password options are used as the credential string IDs inside the keystore.

Enable secure communication by using the SSL protocol to prevent the authentication credentials from being sent unencrypted to the Operations Connector host.

Default value: false

User name used for authenticating against the REST Web Service endpoint on the Operations Connector host.

Default value: (empty)

Password used for authenticating against the REST Web Service endpoint on the Operations Connector host.

Default value: (empty)

Time period (in seconds) that defines the intervals at which event data is processed by using the Lua script. This option is ignored if the single-run advanced option is set to true.

Default value: 10

Time period (in seconds) that Ops Connector for IBM Tivoli waits before invoking the Lua script again in case an error occurred during the previous script run.

Default value: 10

The option that, when set to true, causes the Lua script to be executed only once or until the first successful completion.

Default value: true

Additional search paths where Ops Connector for IBM Tivoli searches for C libraries. Separate the paths with semicolons and use wildcard characters if needed.

Default value: (empty)

Size (in kilobytes) that an output XML file must exceed to initiate an output file rollover (that is, creating a new file and redirecting output into it).

Default value: 1024

Maximum number of output XML files the rollover mechanism may maintain.

Default value: 5

Time period (in seconds) that Ops Connector for IBM Tivoli waits before retrying the rollover.

Default value: 30

Fully qualified domain name or IP address of the Tivoli server.

This option is required.

Network port on which Tivoli Web Service listens.

Default: 15210

Location of Tivoli metric filter files.

Windows default value: ${OvDataDir}\conf\HPBsmIntTivoli\metrics

Linux default value: /var/opt/OV/conf/HPBsmIntTivoli/metrics

Location of the Tivoli resolved hostnames cache file

Windows default value: ${OvDataDir}\tmp\HPBsmIntTivoli\tivoli-hostname-cache

Linux default value: /var/opt/OV/tmp/HPBsmIntTivoli/tivoli-hostname-cache

Timestamp persistency filename.

Windows default value: ${OvDataDir}\tmp\HPBsmIntTivoli\tivoli-metrics.timestamp

Linux default value: /var/opt/OV/tmp/HPBsmIntTivoli/tivoli-metrics.timestamp

If your Operations Connector and IBM Tivoli server are not in the same timezone, use this option to set the timezone offset. This time (in hours) will be added or substracted to the timestamp received. Examples of possible values: +1,-3,+2.5,0,-2.75,...

Default: 0

The metric collection interval in seconds.

Default: 300

Maximum concurrent connections to the ITM server during the metric collection.

Default: 10

Maximum "age" of metrics when the collector starts. When restarting the collector (timestamp file already exists), the integration will fetch metrics which are not older than the given age (in seconds). In case the timestamp file does not exist, maximum age of collected metrics is limited with the tivoli-interval

Default: 3600

Topology filtering. If set to true, only those CIs will be collected which have metric collection enabled. If set to false, all CIs found will be sent to the OMi server.

Default: true

The topology discovery store file.

Windows default value: ${OvDataDir}\datafiles\HPBsmIntTivoli\discovery-metric.json

Linux default value: /var/opt/OV/datafiles/HPBsmIntTivoli/discovery-metric.json

The maximum amount of time (in seconds) to wait for writing of the topology file, before timeout happens

Default: 60

The option that, when set to true, causes the Lua script to be executed only once or until the first successful completion.

Default value: true

Path of the file with a valid Lua script that processes IBM Tivoli metric data.

Windows default value:
${OvInstallDir}\bin\win64\HPBsmIntTivoli\lua\metrics.lua

Linux default value:
/opt/OV/lib64/HPBsmIntTivoli/lua/metrics.lua

Additional search paths where OpsCx for IBM Tivoli searches for Lua modules. Separate the paths with semicolons and use wildcard characters if needed. This option is used to set the global Lua variable package.path.

Windows default value:
${OvInstallDir}bin\win64\HPBsmIntTivoli\lua\?.lua

Linux default file:
/opt/OV/lib64/HPBsmIntTivoli/lua/?.lua

This option enables or disables secure communication using the SSL protocol.

Default: true

String that specifies the web address to use in the REST Web Service communication between Ops Connector for IBM Tivoli and Operations Connector. Specify a valid URL string without the scheme name (protocol), hostname, and port.

Default: /bsmc/rest/metrics/HPBsmIntTivoli

The service name or port to use for establishing the connection.

Default: 30005

Fully qualified domain name (FQDN) or IP address of your remote host. As the integration daemon runs on the same host as Operations Connector, this can be set to localhost.

Default: localhost

If set to true, all incoming messages will first be persisted into a file-based data store, before sending them to the remote host. It also enables the retry mechanism.

Default: true

Directory path, used for the persistence layer. Directory must exist.

Windows default value: ${OvDataDir}\tmp\HPBsmIntTivoli\

Linux default value: /var/opt/OV/tmp/HPBsmIntTivoli/

Size (in kilobytes) that a persistency data file must exceed to initiate the creation of a new data file.

Default: 10240

Maximum number of persistency data files the message buffering mechanism maintains.

Default: 10

You may not alter this option.

Default: HPBsmIntTivoli-metrics

Time period (in seconds) that OpsCx for IBM Tivoli waits before retrying to send the REST Web Service request. This option is ignored if the use-persistency basic option is set to false.

Default: 30

You may not alter this option.

Default: tivoli_metric_message

Path of the event output file to which Ops Connector for IBM Tivoli writes data. You do not have to create this file in advance.

Windows default value:
${OvDataDir}\datafiles\HPBsmIntTivoli\tivoli_metrics.xml

Linux default value:
/var/opt/OV/datafiles/HPBsmIntTivoli/tivoli_metrics.xml

Name of the root element in the event output XML file

Default value: tivoli_metric_message

You may alter this option only to locally generate an event output file in the XML format for troubleshooting purposes. Follow the instructions in Troubleshooting the Collection of Events and Topology. Afterward, adjust the options in the sink (xmltrace) section to fine-tune the output file generation.

Default value: 1

File, which stores information about events from which the topology data is generated.

Windows default value:
${OvDataDir}\datafiles\HPBsmIntTivoli\discovery-event.json

Linux default value:
/var/opt/OV/datafiles/HPBsmIntTivoli/discovery-event.json

File, which stores information about metric data from which the topology data is generated.

Windows default value:
${OvDataDir}\datafiles\HPBsmIntTivoli\discovery-metric.json

Linux default value:
/var/opt/OV/datafiles/HPBsmIntTivoli/discovery-metric.json

Interval in minutes, in which the topology information is fetched from the specified discovery store.

Default value: 60

Path of the file with a valid Lua script that processes IBM Tivoli topology data.

Windows default value:
${OvInstallDir}\bin\win64\HPBsmIntTivoli\lua \
\discovery_source.lua

Linux default value:
/opt/OV/lib64/HPBsmIntTivoli/lua/discovery_source.lua

Set this parameter to true if you want to collect all agents installed on monitored nodes.

Default: false

Path of the topology output file to which Ops Connector for IBM Tivoli writes data. You do not have to create this file in advance.

Windows default value:
${OvDataDir}\datafiles\HPBsmIntTivoli \
\tivoli_topology.xml

Linux default value:
/var/opt/OV/datafiles/HPBsmIntTivoli/tivoli_topology.xml

Fully qualified domain name of the IBM Tivoli Netcool/OMNIbus system.

Default value: (empty)

Fully qualified domain name of the IBM Tivoli Monitoring system.

Default value: (empty)

Seconds to wait after rerunning the Lua scripts.

Default value: 43200

Path of the file with a valid Lua script that processes IBM Tivoli self-discovery topology data.

Default Windows value:
${OvInstallDir}\bin\win64\HPBsmIntTivoli\lua \
\self_discovery.lua

Default Linux value:
/opt/OV/lib64/HPBsmIntTivoli/lua/self_discovery.lua

Additional search paths where Ops Connector for IBM Tivoli searches for Lua modules. Separate the paths with semicolons and use wildcard characters if needed. This option is used to set the global Lua variable package.path.

Default Windows value:
${OvInstallDir}\bin\win64\HPBsmIntTivoli\lua\?.lua

Default Linux value:
/opt/OV/lib64/HPBsmIntTivoli/lua/?.lua

Path of the output file to which Ops Connector for IBM Tivoli writes self-discovery topology data.

Default Windows value:
${OvDataDir}\datafiles\HPBsmIntTivoli\self_discovery.xml

Default Linux value:
/var/opt/OV/datafiles/HPBsmIntTivoli/self_discovery.xml

Name of the temporary file used as a buffer while waiting for the next topology data block. If the time period configured with the message-timeout option expires before the next data block arrives, the buffered data overwrites the topology output file, and the buffer is flushed.

The <filename> variable is automatically replaced with the value of the filename option.

Default value: <filename>.tmp

Time period (in seconds) that Ops Connector for IBM Tivoli. Operations Connector waits for the next topology data block before overwriting the topology output file with the received data that is already in the buffer.

Default value: 10