Configuring the Microsoft Exchange adapter

You configure an adapter in Grid Manager. The configuration provides information about how the adapter interacts with the Microsoft Exchange server. While 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 human errors that might occur as a result of copying the configuration XML from the adapter user guide into the UI when configuring an adapter. 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 using XML only. However, after you switch to the XML view, and save the configuration in the XML from that view, you cannot thereafter use the form view for modifying that configuration.

Note

The Microsoft Exchange adapter contains an actor adapter only; it does not include a monitor adapter. The default name for the actor adapter is MicrosoftExchangeActorAdapter.

To monitor emails from an Exchange Server, use the base IMAP monitor adapter. Ensure that the Exchange Servers IMAP4 service is running and that any firewall is open for the IMAP TCP-IP ports, 143 and 993. For more information about the IMAP monitor adapter, see IMAP adapter.

To configure the actor adapter

  1. Log on to the BMC Atrium Orchestrator Grid Manager.
  2. Access the adapters page, by clicking the Manage tab; then click the Adapters tab.
  3. In the Adapters in Repository list, select the bmc-adapter-microsoft-exchange-actor check box.
  4. Click Add to Grid to include the adapter in the Adapters on Grid list.
  5. Click Configure corresponding to the newly added adapter.
  6. On the Add an Adapter Configuration page, perform the following substeps to configure the adapter using the form view or jump to step 7 to configure the adapter 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.
      The configuration elements for each adapter are described in that adapter's section. Include all required elements indicated with an asterisk (*).
  7. (Optional) Configure the adapter in the XML view using the following substeps:
    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. Copy the configuration elements from the adapter user guide into the Properties text box, 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.

      This saves the adapter configuration with settings in the XML view permanently. The newly configured adapter is now listed in the Adapters on Grid list.

      Sample XML for configuring the actor adapter

      <config>
          <target>10.10.75.250</target>
          <user-name>administrator</user-name>
          <password>passw0rd#</password>
          <microsoft-exchange-version>v2007</microsoft-exchangeversion>
          <microsoft-exchange-consolefile>C:\Program
        Files\Microsoft\Exchange Server\bin\exshell.psc1
        </microsoftexchange-consolefile>
          <timeout-secs>120</timeout-secs>
          <target-os-bit-version>64</target-os-bit-version>
      </config>


The following table describes the node elements required to configure the actor adapter.

Node elements required to configure the actor adapter

UI label

Element

Definition

Required

Target

<target>

Specifies the target computer's IP or name (where either the Microsoft Exchange server is installed or the 32-bit Exchange Management Tools are installed)

Yes

User Name

<user-name>

Specifies the user name to connect to the remote computer

Yes

Password

<password>

Specifies the password for the specified user

Yes

Microsoft Exchange Version

<microsoft-exchange-version>

Specifies the Microsoft Exchange server application version

Valid values:

  • v2007
  • v2010
  • v2013
  • v2016

Yes

Microsoft Exchange Consolefile

<microsoft-exchange-consolefile>

Specifies the Microsoft Exchange shell console file to load the Exchange specific PowerShell cmdlets

Yes

Target Os Bit Version

<target-os-bit-version>

Specifies that the target OS's bit version Microsoft Exchange server is a native 64-bit application.

If commands need to be executed directly on the same computer, this value should be 64. If commands need to be executed using the 32-bit Exchange Management Tools, this element's value should be 32.

The default value is 64.

No

Timeout Secs

<timeout-secs>

Specifies the maximum time in seconds to wait for command execution.

Default value: 60 seconds

No

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