Unsupported content

 

This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

Configuring the Operations Manager monitor adapter

You configure an adapter in BMC Atrium Orchestrator Grid Manager. The configuration provides information about how the adapter interacts with Microsoft System Center Operations Manager. Although each adapter must have a unique name, you can create multiple adapters with the same adapter type to allow for different configuration properties.

The form view provides an easy-to-use interface for configuring adapters. The form view prevents errors that might occur when you copy the configuration XML from the adapter documentation to the UI during configuration. You can switch to the XML view to configure those elements and attributes that are not available as fields or to configure all the elements and attributes by using XML only. However, after you switch to the XML view and save the configuration in XML from that view, you cannot thereafter use the form view to modify that configuration

To configure the monitor adapter

  1. Log on to BMC Atrium Orchestrator Grid Manager.
  2. To access the adapters page, click the Manage tab, and then click the Adapters tab.
  3. In the Adapters in Repository list, select the adapter-scom-monitor check box.
  4. To include the adapter in the Adapters on Grid list, click Add to Grid.
  5. Click Configure corresponding to the newly added adapter.
  6. On the Add an Adapter Configuration page, perform the following steps to configure the adapter by using the form view, or skip to step 7 to configure the adapter by using the XML view:
    1. Enter a name for the adapter.
    2. Enter a description for the adapter.
    3. Under Properties, enter or select values for the configuration elements.

      Include all required elements, which are indicated with an asterisk (*).
    4. Click OK.

      The newly configured adapter is now listed in the Adapters on Grid list
  7. (Optional) Configure the adapter in the XML view by performing the following steps:

    Note

    If you switch to the XML view, you cannot thereafter use the form view to modify the configuration.

    1. Enter a name and a description for the adapter.
    2. Click Switch to XML View.
    3. On the warning message that appears, click Switch View.
    4. In the Properties text box, use XML format to enter the configuration elements and attributes, and then click OK.

      Note

      If the default value for an optional element is acceptable, omit the element. Do not include empty elements.

    5. On the warning message that appears, click Save.
      The adapter configuration with settings is saved in the XML view permanently. The newly configured adapter is now listed in the Adapters on Grid list.

The following table describes the configuration elements for the polling monitor adapter. You cannot use the form view to configure elements and attributes that do not have an entry in the UI label column.

Node elements required for configuring the monitor adapter

UI label

Element

Description

Required

None

<config>

Contains all other elements

Yes

Target

<target>

Specifies the host name or the IP address of the POP3 server

Yes

Port

<port>

Specifies the port on which the POP3 server listens to events

No

User Name

<user-name>

Specifies the user name for the email account that you want to monitor

For example, if the email account being monitored is user.name@company.com, the user name is user.name.

Yes

Password

<password>

Specifies the password that corresponds to the specified <user-name>

The password element can contain an <encryption-type> attribute.

Yes

Encryption Type

encryption-type

Indicates whether the password specified is encrypted

The <encryption-type> element is an attribute of the <password> element.

Valid values: Base64, Plain (default)

No

Javamail Debug

<javamail-debug>

Indicates whether debug message logging for JavaMail must be turned on

Valid values: true, false (default)

No

Email Address

<email-address>

Specifies the email address of the account that you want to monitor

BMC recommends that you do not configure multiple POP3 mail monitor adapters to monitor the same email address.

Yes

Protocol

<protocol>

Specifies the email protocol to be used

Valid value: POP3

Yes

Refresh

<refresh>

Specifies the duration, in seconds, to check for new messages

Valid format: Any positive integer

Default value: 300 (5 minutes)

No

Mail Timeout

<mail-timeout>

Specifies the duration, in seconds, to maintain an established connection

Valid format: Any positive integer

Default value: 60 (1 minute)

No

Connection Timeout

<connection-timeout>

Specifies the duration, in seconds, to wait when establishing a connection

Valid format: Any positive integer

Default value: 30

No

Disable Auth Login

<disable-auth-login>

Prevents the use of non-standard AUTHENTICATE LOGIN commands with POP3 servers

Valid values: true, false (default)

No

Disable Auth Plain

<disable-auth-plain>

Prevents the use of AUTHENTICATE PLAIN commands with POP3 servers

Valid values: true, false (default)

No

Delete After Read

<delete-after-read>

Determines whether a message is deleted from the server after it is read by the adapter

Valid values: true, false (default)

Conditional; required if the <max-messages-per-connection> element is specified

Max Messages Per Connection

<max-messages-per-connection>

Specifies the maximum number of messages to be polled per connection attempt

If more messages exist on the server than the number specified, the messages are retrieved during the next polling period.

This element is used only when the value of the <delete-after-read> element is true.

Default value: 20

No

Ignore Attachments

<ignore-attachments>

Indicates whether attachments are ignored and excluded from the adapter event

Valid values: true, false (default)

No

Create Subdirectory

<create-subdirectory>

Indicates whether each attachment is downloaded into a separate directory

Valid values: true, false (default) (download all the attachments into a single directory)

Subdirectory name format: <attachmentDownloadDirectory>/<emailAddress>/
<messageID>/<downloadTimestampInEpochTime>

Sample subdirectory value: /mail/downloads/user@company.com/Message1/1196967357

No

Attachment Download Directory

<attachment-download-directory>

Specifies the path and the directory into which attachments on the monitored email messages are downloaded

This directory must exist on each peer on which the adapter is enabled. If this directory is absent, the configuration is considered invalid and the adapter is not enabled.

Default value: Java temp directory

No

Attachment Overwrite Existing

<attachment-overwrite-existing>

Indicates whether an attachment with the same file name has already been downloaded and overwrites that file with the current attachment

If the value of the <create-subdirectory> element is true, attachments are downloaded, ignoring the <attachment-overwrite-existing> element.

Valid values: true, false (default) (preserves the original file)

No

Attachment Ttl

<attachment-ttl>

Specifies the time an attachment is permitted to reside in the download directory before being deleted

This value is specified as a numeric value followed by a time designator.

Valid values for time designators: m - minutes, h - hours, d - days

Default value: 10d (allows attachments to reside for 10 days)

No

Max Attachment Size

<max-attachment-size>

Specifies the maximum file size, in MB, that can be attached to a mail message

The maximum file size is defined per attachment; the total value of all the files can be greater, provided each file is less than or equal to the default value.

Default value: 10 MB

No

Max Pool Threads

<max-pool-threads>

Specifies the maximum number of threads to be used to download attachments in parallel

Default value: 1

No

Delete Attachments On Exit

<delete-attachments-on-exit>

Deletes all downloaded attachments when the adapter is stopped or disabled

Valid values: true, false (default) (preserves downloaded files)

No

Disk Cleanup Interval

<disk-cleanup-interval>

Specifies the interval at which the deletion of attachments that have exceeded the <attachment-ttl> period must occur

This value is specified as a numeric value followed by a time designator.

Valid values for time designators: m - minutes, h - hours, d - days

Default value: 10m (initiates cleanup every 10 minutes)

No

None

<file-name-filter>

Contains one or more <file-name> elements

Only file names that satisfy the criterion specified by using the <file-name> element can be downloaded.

Conditional; required if the <file-name> element is specified

File Name Filter

<file-name>

Specifies the criterion for an attached file to be downloaded, based on the file name

You can define one or more file names. An attachment that matches at least one file name filter is downloaded. If you do not provide a criterion, a file with any file name is downloaded.

You can use wildcard characters, * and ?, to define the file name filter. With a *, the wildcard portion of the file name can contain an unlimited number of characters. With a ?, a one-to-one relationship exists between the ? and the file name character.

No

None

<file-type-filter>

Contains one or more <file-type> elements

Only file types specified by using the <file-type> element can be downloaded.

Conditional; required if the <file-type> element is specified

File Type Filter

<file-type>

Specifies the criterion for an attached file to be downloaded based on the file type

You can define one or more file types. A file that matches at least one file type filter is downloaded. If you do not provide a criterion, a file with any file type is downloaded.

Valid values:

  • DOC
  • XLS
  • XML
  • PDF
  • HTML
  • EXE

No

Use Ssl Certificate

<use-ssl-certificate>

Specifies whether to use an SSL certificate to establish a secure connection

Valid values: true, false (default)

No

Allow Unsigned Certificates

<allow-unsigned-certificates>

Specifies whether to allow unsigned certificates from trusted zones

If you are using self-signed SSL certificates (a common practice), set the value of this element to true.

On ecommerce sites or military installations, if you need to use signed certificates such as Verisign or Thawte (a rare practice), set the value of this element to false.

Valid values: true, false (default)

No

Install Certificate

<install-certificate>

Specifies whether to install security certificates automatically

If you prefer to have security certificates installed automatically (a common practice), set the value of this element to true.

If you prefer to manually export the security certificate from the BMC Network Automation server and manually import it into the BMC Atrium Orchestrator local peer's cacerts file (a rare practice), set the value of this element to false.

Valid values: true, false (default)

No

Passphrase

<passphrase>

Specifies the password to the keystore file (cacerts ) local to the BMC Atrium Orchestrator peer

Default value: changeit

Warning

  • The value of the <passphrase> element is the passphrase for the cacerts certificate stored on the BMC Atrium Orchestrator local peer (CDP or AP) and not the BMC Network Automation target host.
  • Changing the passphrase can be difficult and might destroy the integrity of the cacerts security file.

Verify the cacerts passphrase by using the following command in UNIX or Linux:
$ /opt/bmc/ao/cdp/jvm/bin/keytool -list -keystore/opt/bmc/ao/cdp/jvm/lib/security/cacerts

No

 

The following figure illustrates a sample XML configuration for the monitor adapter:

XML sample for Base64 configuration

<config>
  <target>pop3mailserver.com</target>
  <user-name>user.name</user-name>
  <password encryption-type="base64">cGFzc3dvcmQ=</password>
  <javamail-debug>false</javamail-debug>
  <email-address>user.name@xyz.com</email-address>
  <protocol>pop3</protocol>
  <refresh>5</refresh>
  <mail-timeout />
  <connection-timeout>60</connection-timeout>
  <disable-auth-login>false</disable-auth-login>
  <disable-auth-plain>false</disable-auth-plain>
  <delete-after-read>false</delete-after-read>
  <max-messages-per-connection>20000</max-messages-per-connection>
</config>

Enabling custom logging

To enable custom logging for the adapter, you must specify a log file name. You can also provide additional parameters for logging.

Note

You must be using BMC Atrium Orchestrator Platform version 7.8 or later to use the custom logging feature. These parameters will be ignored in earlier versions of BMC Atrium Orchestrator Platform.

These parameters are available with supported adapter versions. See your adapter documentation for details.

  • Log File Name: Provide a name for the log file.
    This file will be stored in the AO_HOME/tomcat/logs directory. If Log File Max Backup Index value is greater than 0, the log file name is suffixed with the backup index. For example, if the parameter value is a.log, backup log files will have names, such as a.log.1, a.log.2.
  • Log File Size: Specify a size limit for the log file. 
    If the value specified for Log File Max Backup Index is greater than 0, when the specified size is reached, the current file is renamed with the suffix .1. Otherwise, the log file will be reset and over-written. The default value is 10MB. The available units are KiloBytes (KB), MegaBytes (MB) or GigaBytes (GB).
  • Log File Max Backup Index: Enter the maximum number of backup files allowed. The default value is 10.
  • Log File Append: Select this option to append new log information to the existing information in the file. If unselected, the file will be overwritten with new log information.
  • Log Level: Enter the logging level using one of the following choices:

    Logging level

    Description

    DEBUG

    The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    INFO

    (default)

    Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    WARN

    Logs recoverable erroneous conditions and unrecoverable erroneous conditions

    ERROR

    The least detailed logging level; logs only error conditions that are not usually recoverable

Was this page helpful? Yes No Submitting... Thank you

Comments