Integrate > Microsoft SCOM > Configure > Configuration Options

Configuration Options

This topic describes configurable options that affect the behavior of the Microsoft SCOM event, topology, and metric integrations in Operations Connector for Microsoft SCOM. All options are preconfigured with default values that you can modify. While basic options have their default values specified in the configuration files, the default values of advanced options are implicitly defined. To modify the value of an advanced option, manually add the option and its chosen value to a configuration file.

Integration Configuration Files

You can find integration configuration files in the <OvDataDir>\conf\HPBsmIntSCOM\genint directory on the Operations Connector host. They are plain text files. Their file names contain the version of the Microsoft SCOM instance from which data is collected and the data type indicator. For the second and each additional integrated Microsoft SCOM instance, the consecutive number of the instance is added to the file names. Examples:

  • The configuration file of the topology integration with the first (only) Microsoft SCOM instance, whose product version is 2012 or later, is named scom_2012_topology_integration.conf.

  • The configuration file of the metric integration with the second Microsoft SCOM instance of the same product version 2007 is named scom_2007_metric_2_integration.conf.

In a configuration file, in the nodes section, each option has a value that is assigned by using the following syntax:

"<OptionName>" : "<Value>"

When adding an advanced option to the configuration file, make sure to add it to the appropriate subsection of the nodes section. Use the following syntax:

,"<AdvancedOptionName>" : "<Value>"

After reconfiguring an Operations Connector for Microsoft SCOM integration, restart the integration service as described in Restarting the Services topic.

Some option descriptions inside the configuration files might be incomplete or incorrect.

Default values of several basic options documented in this section contain one of the following placeholders: <InstanceID> or <BacksyncPort>. In the actual configuration files, these placeholders are resolved into literal strings. When reconfiguring such a basic option, you may not change the strings that result from the placeholder substitution.

Event Integration Options

The following tables list options in an event integration configuration file of Operations Connector for Microsoft SCOM.

Basic Options

Option Name Description, (Default) Value
Subsection for collecting: source (eventsource)
interval

Time period (in seconds) that defines the intervals at which the accumulated events (alerts) are acquired from the integrated Microsoft SCOM instance.

Default value: 40

collect-actual-health-state

The option that, when set to true, causes Operations Connector for Microsoft SCOM to obtain the health state of a monitored Microsoft SCOM object by querying the object directly, rather than deriving it from the alert data.

Default value: false

Subsection: processor
copy-count

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 Metrics topic. Afterward, adjust the options in the sink (eventxmlsink) section to fine‑tune the output file generation.

Default value: 0

copy splitter

To store the alerts in an XML format for debugging or troubleshooting purposes, you can use the copy splitter functionality available in the connector configuration file.

Default value: 0

Subsection for collecting: sink (eventwssink)
uri

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

Default value: /bsmc/rest/events/HPBsmInt<InstanceID>

server-name

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

Default value: localhost

port

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

use-ssl

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

Default value: true

root-element

You may not alter this option.

Value: scom_event_message

use-persistency

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

persistency-dir

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.

Default value: ${OvDataDir}/tmp/HPBsmIntSCOM

persistency-prefix

You may not alter this option.

Value: <InstanceID>_events

Subsection for debugging: sink (eventxmlsink)
root-element

Name of the root element in the event output XML file.

Default value: scom_event_message

filename

Path of the event output file to which Operations Connector for Microsoft SCOM writes data. You do not have to create this file in advance.

Default value: ${OvDataDir} \
\datafiles\HPBsmIntSCOM\<InstanceID>\output\scom_events.xml

rollover-size

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

rollover-count

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

Default value: 5

rollover-wait

Time period (in seconds) that Operations Connector for Microsoft SCOM waits before retrying the rollover.

Default value: 30

Subsection for backward synchronization: source (backsyncsource)
port

You may not alter this option.

Value: <BacksyncPort>

Subsection for backward synchronization: sink (backsyncsink)
enable-backsync

The option that, when set to false, disables resolution state backward synchronization for all Microsoft SCOM events (alerts).

Default value: true

close-monitor-alerts

The option that, when set to true, causes resolution state backward synchronization to include also the events (alerts) that originate from Microsoft SCOM monitors. This option is ignored if the enable-backsync basic option is set to false.

Default value: false

Advanced Options

Option Name Description, Default Value
Subsection for collecting: sink (eventwssink)
connection-count

This option defines how many concurrent connections Operations Connector for Microsoft SCOM should use for transferring event data to Operations Connector.

Default value: 5

bulk-size

Maximum number of messages that Operations Connector for Microsoft SCOM should put into a single REST Web Service request.

Default value: 10

ssl-cert

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.

This option must be set when the use-ssl option is set to true.

Default value: (empty)

use-auth

The option that, when set to true, causes Operations Connector for Microsoft SCOM 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

use-store

The option that, when set to true, causes Operations Connector for Microsoft SCOM 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

auth-username

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

Default value: (empty)

auth-password

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

Default value: (empty)

persistency-max-size

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

Default value: 10240

persistency-max-files

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

Default value: 10

retry-wait

Time period (in seconds) that Operations Connector for Microsoft SCOM 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

Topology Integration Options

The following tables list options in a topology integration configuration file of Operations Connector for Microsoft SCOM.

Basic Options

Option Name Description, Default Value
Subsection: source (toposource)
interval

Time period (in seconds) that defines the intervals at which the topology data is acquired from the integrated Microsoft SCOM instance.

Default value: 3600

configuration-groups

You may not alter this option directly. To define the set of Microsoft SCOM groups from which the monitoring objects are collected to create topology data in OMi, use the Configuration Utility of Operations Connector for Microsoft SCOM.

Default value: HP Topology Infrastructure Group

execute-transformations

The option that, when set to false, disables general enrichment of the topology data acquired from Microsoft SCOM. The enrichment (topology transformation) takes place before the data is relayed to Operations Connector.

Default value: true

transformations-file

Path of the file with the custom definition of topology transformation that Operations Connector for Microsoft SCOM uses to enrich topology data. When the value is left empty, the default topology transformation is used.

You can find a template of the custom transformation definition at the location <OvDataDir>\installation\HPBsmIntSCOM\templates\ in the recommended_transformations.xml file.

Default value: (empty)

create-hostkeys

This option enables or disables creation of Operations Manager i-conforming host keys based on the systems' MAC or IP addresses. If set to true, Operations Connector for Microsoft SCOM scans all network interface adapters of each discovered system to acquire their MAC addresses and IP addresses.

Default value: true

allow-nslookup-for-hostkey

The option that, when set to false, disables reverse DNS lookup of the IP addresses of hostnames collected from the integrated Microsoft SCOM instance.

Default value: true

ip-collection-mode

This option specifies the IP format that Operations Connector for Microsoft SCOM uses when artificially creating IP addresses. The allowed values are ipv4, ipv6, and both.

Default value: both

ip-create-mode

This option defines how discovery of network interface controllers (NICs) is conducted. If the option is set to nic, Operations Connector for Microsoft SCOM discovers all NICs of a discovered system (Microsoft SCOM object) and adds them to it. If the option is set to computer, NICs are not discovered.

Default value: nic

enrich-ips

This option enables or disables enrichment of IP addresses with the data from the network interface controllers (NICs). The option is ignored if the ip-create-mode basic option is set to computer.

Default value: true

discovery-domain

Domain in which Microsoft SCOM object discovery is run.

Default value: DefaultDomain

allow-nslookup-for-app-ip

The option that, when set to false, disables reverse DNS lookup of the IP addresses of hostnames collected from the integrated Microsoft SCOM instance. Reverse DNS lookup requires the Operations Connector host and the Microsoft SCOM host to be members of the same domain.

Default value: true

Subsection: sink (toposink)
filename

Path of the topology output file to which Operations Connector for Microsoft SCOM writes data. You do not have to create this file in advance. This value must match the value of the Topology XML File option of the Operations Connector policy for Microsoft SCOM topology. In the Operations Connector web interface, you can find it in the Source page of the policy.

Default value: ${OvDataDir}\datafiles\HPBsmIntSCOM \
\<InstanceID>\output\scom_topology.xml

Subsection: sink (discoverysink)
filename

Path of the self-discovery topology output file to which Operations Connector for Microsoft SCOM writes data. You do not have to create this file in advance. This value must match the value of the Topology XML File option of the Operations Connector policy for Microsoft SCOM self-discovery topology. In the Operations Connector web interface, you can find it in the Source page of the policy.

Default value: ${OvDataDir}\datafiles\HPBsmIntSCOM \
\<InstanceID>\output\scom_topology_discovery.xml

Advanced Options

Option Name Description, Default Value
Subsection: sink (toposink)
tmp-filename

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

message-timeout

Time period (in seconds) that Operations Connector for Microsoft SCOM 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

Subsection: sink (discoverysink)
tmp-filename

Name of the temporary file used as a buffer while waiting for the next self-discovery 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 self-discovery 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

message-timeout

Time period (in seconds) that Operations Connector for Microsoft SCOM waits for the next self-discovery topology data block before overwriting the self-discovery topology output file with the received data that is already in the buffer.

Default value: 10

Metric Integration Options

The following tables list options in a metric integration configuration file of Operations Connector for Microsoft SCOM.

Basic Options

Option Name Description, (Default) Value
Subsection: source
interval

Time period (in seconds) that defines the intervals at which the metrics are acquired from the integrated Microsoft SCOM instance.

Default value: 300

filter-file

Path of the file that contains settings for filtering the Microsoft SCOM metric data.

Default value: ${OvDataDir}\datafiles\HPBsmIntSCOM \
\<InstanceID>\MetricFilterConfig.xml

Subsection: processor
copy-count

You may alter this option only to locally generate a metric output file in the XML format for troubleshooting purposes. Follow the instructions in Troubleshooting the Collection of Events and Metrics topic. Afterward, adjust the options in the sink (metricxmlsink) section to fine‑tune the output file generation.

Default value: 0

Subsection for collecting: sink (metricwssink)
uri

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

Default value: /bsmc/rest/metrics/HPBsmInt<InstanceID>

server-name

See Event Integration Options.

port

See Event Integration Options.

use-ssl

See Event Integration Options.

root-element

You may not alter this option.

Value: scom_metric_message

use-persistency

See Event Integration Options.

persistency-dir

See Event Integration Options.

persistency-prefix

You may not alter this option.

Value: <InstanceID>_metrics

Subsection for debugging: sink (metricxmlsink)
root-element

Name of the root element in the metric output XML file.

Default value: scom_metric_message

filename

Path of the metric output file to which Operations Connector for Microsoft SCOM writes data. You do not have to create this file in advance.

Default value: ${OvDataDir}\datafiles\HPBsmIntSCOM \
\<InstanceID>\output\scom_metrics.xml

rollover-size See Event Integration Options.
rollover-count See Event Integration Options.
rollover-wait See Event Integration Options.

Advanced Options

Option Name Description, Default Value
Subsection for collecting: sink (metricwssink)
connection-count

See Event Integration Options.

bulk-size See Event Integration Options.
ssl-cert See Event Integration Options.
use-auth See Event Integration Options.
use-store See Event Integration Options.
auth-username See Event Integration Options.
auth-password See Event Integration Options.
persistency-max-size See Event Integration Options.
persistency-max-files See Event Integration Options.
retry-wait See Event Integration Options.

Related topics

Restarting the Services

Event Integration Options

Troubleshooting the Collection of Events and Metrics