Integrate > Oracle Enterprise Manager > Configure > Configuration Options

Configuration Options

This topic describes configurable options for integrating Oracle Enterprise Manager (OEM) events, topology, and metrics with Ops Connector for OEM. All options are preconfigured with default values you can modify. While basic options have their default values specified in the corresponding integration 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.

You can find event integration configuration files in the <OvDataDir>/conf/HPBsmIntOEM/genint directory on the Operations Connector host. They are plain text files. In a configuration file, in the nodes section, each option has a value that is assigned by using the following syntax:

"<OptionName>" : "<Value>"

If the appropriate option and its value are present but commented out, remove the comment delimiter // and modify the value as needed.

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 Ops Connector for OEM integration, restart the integration as described in Restarting the Services topic.

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

Event Integration Options

The following tables list options in oem_events.conf—the event integration configuration file.

Basic Options

Option Name Description, (Default) Value
Subsection: source

port

Default SOAP Web Service listener port used for receiving events (alerts) from the Oracle Enterprise Manager host.

Default value: 30100
use-ssl

This option enables or disables secure communication—by using the SSL protocol—between Event Connector on the OEM host and the SOAP Web Service endpoint in Ops Connector for OEM on the Operations Connector host.

If the option is set to true, you must set the ssl-cert advanced option in the source subsection.

Default value: false
uri

String that specifies the web address to use in the SOAP Web Service communication between the Event Connector on the OEM host and Ops Connector for OEM. Specify a valid URL string without the scheme name (protocol), hostname, and port.

Default value: /bsmc/services/reportMonitorData
allow-remote-access

The option that, when set to true, makes Ops Connector for OEM accept SOAP Web Service requests originating from any host. If the option is set to false, the SOAP Web Service endpoint in Ops Connector for OEM accepts only requests sent from the local host.

Default value: true
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 topic. Afterward, adjust the options in the sink (eventxmlsink) subsection to fine-tune the output file generation.

Default value: 0
Subsection: sink (eventwssink)
use-ssl

This option enables or disables secure communication—by using the SSL protocol—between Ops Connector for OEM and the REST Web Service listener in Operations Connector.

If the option is set to true, you must set the ssl-cert advanced option in the sink (eventwssink) subsection.

Default value: true
uri

String that specifies the web address to use in the REST Web Service communication between Ops Connector for OEM and Operations Connector. Specify a valid URL string without the scheme name (protocol), hostname, and port. The string must match the last part of the value of the Effective URL option in the Source page of the Operations Connector policy for OEM events.

Default value: /bsmc/rest/events/HPBsmIntOEM
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
server-name

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

Default value: localhost
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. If a non-default directory is specified for this option, you must create it in advance with the read and write access enabled.

Default value (Windows): ${OvDataDir}\tmp\HPBsmIntOEM

Default value (Linux): /var/opt/OV/tmp/HPBsmIntOEM
persistency-prefix

You may not alter this option.

Default value: HPBsmIntOEM-events
root-element

You may not alter this option.

Value: oem_event_message

Advanced Options

Option Name Description, (Default) Value
Subsection: source
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 file must contain the certificate preceded by its corresponding private key. The private key may not use a password. Although you can use different ways to obtain such a certificate (for example, you can utilize Operations Connector's own certificate), service provider strongly recommends that you use a certificate issued by a certificate authority (CA).

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

Default value: (empty)
Subsection: sink (eventwssink)
connection-count

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

Default value: 5
bulk-size

Maximum number of messages that Ops Connector for OEM 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 file must contain the certificate preceded by its corresponding private key. The private key may not use a password. Although you can use different ways to obtain such a certificate (for example, you can utilize Operations Connector's own certificate), service provider strongly recommends that you use a certificate issued by a certificate authority (CA).

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

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 Ops Connector for OEM 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
use-auth

The option that, when set to true, causes Ops Connector for OEM 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 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 Ops Connector for OEM 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 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.

If the use-store option is set to true, this option rather represents the string ID of the user name inside the keystore.

Default value: (empty)
auth-password

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

If the use-store option is set to true, this option rather represents the string ID of the password inside the keystore.

Default value: (empty)

Topology Integration Options

The following table lists options in application-db.properties, the topology integration configuration file.

Option Name Description, (Default) Value
OEM_database_host_name

Fully qualified domain name of your OEM database host.

Default value: (empty)
port

Default Oracle database listener port on the OEM host. As long as you do not reconfigure the Oracle database listener, you may not alter this option.

Default value: 1521
servicename

Name of the OEM service on the OEM database host. The name should match with "SERVICE_NAME" value as mentioned in "tnsnames.ora" file in the OEM system.

Default value: servicename

The following table lists options in application-db.properties, the topology integration configuration file.

Option Name Description, (Default) Value
logging.file

Specifies log file name and location.

Default value: oem_topology.log

The following table lists options in application-logging.properties, the topology integration configuration file.

Option Name Description, (Default) Value
logging.level.com.hp

Determines the granularity of the message that is logged.

Default value: INFO

Metric Integration Options

Connection Tab

Option Name Description, (Default) Value
Classpath

The jar files that need to be loaded to use the JDBC driver class.

Default value: <$OvDataDir>/conf/HPBsmIntOEM/classpath/ojdbc6.jar
JDBC Driver Class

The driver used to connect to the database. Use the fully qualified class name (FQCN) of your JDBC driver

Default value: oracle.jdbc.driver.OracleDriver
Connect string

The URL to a database connection (referred to as an Connection string).

Default value: jdbc:oracle:thin:@//<OEM_database_host_name>:1521/<servicename>
Username

User name used to log on to the database.

Default value: (empty)
Password

Password used to log on to the database.

Default value: (empty)
Polling Interval

How often the policy queries the database (in days, hours, minutes, and seconds.

Default value: 5 minutes

Collection Tab

Option Name Description, (Default) Value
SQL statement

The SQL query used to query the database.

Default value: oemMetricsQuery.sql for 12c or 13c

oemMetricsQuery_11g.sql for 11g
Session variables

A list of keys and initial values for them. These values are used in the data map if the initial value statement fails to load the values to the data map.

Default value: collection_time
Initial value statement

An SQL statement that is executed in the init method during the policy activation. It can be used to initialize the data map with values. The values returned as last record from the execution of the statement are copied to the data map and returned.

Default value: (empty)

Internals Tab

Option Name Description, (Default) Value
Fetch size

The maximum number of entries the policy sends at once.

Default value: 100
Result set size

The maximum number of entries the policy retrieves from the database in each run.

Default value: 100
Data Source Tag

A user defined descriptive name for the collected data. This tag can be used to distinguish data sets generated by different policies. This may be useful in data forwarding scenario, for example for consumer applications that receive data from the agent.

Default value: (empty)

Accessing the Database Tables

For integration of topology or metrics, a user account with proper access to the OEM database must be configured in OEM. Depending on the data that is collected from OEM and on your OEM version, this account should be granted read access to the following database tables. To provide access to the list of tables, run the following SQL commands:

drop user tusr;
CREATE ROLE BSMC_OEM_ROLE NOT IDENTIFIED;
GRANT SELECT ON SYSMAN.MGMT_TARGETS TO BSMC_OEM_ROLE;
GRANT SELECT ON SYSMAN.MGMT_TARGETS_LOAD_TIMES TO BSMC_OEM_ROLE;
CREATE USER tusr
IDENTIFIED BY "myHP"
DEFAULT TABLESPACE USERS
TEMPORARY TABLESPACE TEMP
PROFILE DEFAULT
ACCOUNT UNLOCK;
GRANT BSMC_OEM_ROLE TO tusr;
GRANT CONNECT TO tusr;
GRANT SELECT ON SYSMAN.MGMT_TARGETS TO tusr;
grant select on sysman.em_manageable_entities to tusr;
grant select on sysman.mgmt_target_assoc_defs to tusr;
grant select on sysman.mgmt_assoc_instances to tusr;
grant select on sysman.mgmt_target_assocs to tusr;
grant select on sysman.mgmt_target_properties to tusr;
grant select on sysman.mgmt_targets to tusr;
grant select on sysman.em_metric_columns to tusr;
grant select on sysman.em_metric_groups to tusr;
grant select on sysman.em_metric_items to tusr;
grant select on sysman.em_metric_keys to tusr;
grant select on sysman.em_metric_values to tusr;
grant execute on sysman.EM_METRIC_VALUE_ACCESS to tusr;
-- One system privilege for APP_BSM
GRANT EXEMPT ACCESS POLICY TO tusr;
CREATE OR REPLACE SYNONYM tusr.MGMT_TARGETS FOR SYSMAN.MGMT_TARGETS;
CREATE OR REPLACE SYNONYM tusr.MGMT_TARGETS_LOAD_TIMES FOR SYSMAN.MGMT_TARGETS_LOAD_TIMES;
CREATE OR REPLACE SYNONYM tusr.em_manageable_entities FOR sysman.em_manageable_entities;
CREATE OR REPLACE SYNONYM tusr.em_metric_items FOR sysman.em_metric_items;
CREATE OR REPLACE SYNONYM tusr.em_metric_columns FOR sysman.em_metric_columns;
CREATE OR REPLACE SYNONYM tusr.em_metric_groups FOR sysman.em_metric_groups;
CREATE OR REPLACE SYNONYM tusr.em_metric_keys FOR sysman.em_metric_keys;
CREATE OR REPLACE SYNONYM tusr.em_metric_values FOR sysman.em_metric_values;
CREATE OR REPLACE SYNONYM tusr.em_metric_value_access FOR sysman.em_metric_value_access;
CREATE OR REPLACE SYNONYM tusr.mgmt_target_assocs FOR sysman.mgmt_target_assocs;
CREATE OR REPLACE SYNONYM tusr.mgmt_target_assoc_defs FOR sysman.mgmt_target_assoc_defs;
CREATE OR REPLACE SYNONYM tusr.mgmt_assoc_instances FOR sysman.mgmt_assoc_instances;

Note: tusr is defined as a sample user.

Related topics

Restarting the Integrations

Troubleshooting the Collection of Events

Send Help Center feedback