Configuring the Active Directory adapter

You configure an adapter in Grid Manager. The configuration provides information about how the adapter interacts with the BMC Performance Manager Portal application. 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 XML sample 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 default name for the actor adapter is ActiveDirectory.

The following video (5:20) describes how to configure the Microsoft Active Directory adapter on BMC Atrium Orchestrator Platform version 7.9.

https://www.youtube.com/embed/xuimNRBDLac

The following video (7:05) describes how to use the Active Directory module.

https://www.youtube.com/watch?v=Sua_fRzaDtY

To configure the 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-active-directory-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.

      Note

      The Name field does not support single-quote (') and ampersand (&) characters.

    2. Enter a description for the adapter.
    3. Under Properties, enter or select values for the configuration elements.

      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 and attributes from the XML sample 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.

The following table describes the node elements required for configuring the actor adapter.

Node elements required for configuring the actor adapter

UI label

Element

Definition

Required

Target

<target>

Specifies the host name or IP address of the remote or local computer

Default value: localhost

No

User Name

<user-name>

Specifies the user name for remote host authentication

You must have an administrative role or privilege on the remote host.

Conditional; required depending on your environment

Password

<password>

Specifies the password corresponding to the specified user name

Conditional; required depending on your environment

Adapter Files Location

<adapter-files-location>

Specifies the location on the server hosting Active Directory and Active Directory Application Mode (ADAM) services where *.ldf and other files created by the adapter are to be stored

If AD is not running in ADAM, specify any valid folder on the target host, for example, C:\temp. Do not specify a trailing backslash. For example, C:\temp\ is incorrect. 

If the required *.ldf files are already present in <adapter-files-location>, the adapter uses them; otherwise, the adapter creates them and executes them for the requested ADAM operations.

Yes

Character Set

<character-set>

Specifies the supporting CharSet (also called character set)

It includes identifiers describing a series of universal characters.

Notes

  • The locale and character set of the target computer or peer where the adapter is enabled must be compatible with the locale and the character set configured in the <character-set> element to get the expected results.
  • You can get the active code page supported by cmd.exe by running the chcp command on the target Command Line client.

Valid values:

  • ISO-8859-1
  • ISO-8859-2 (default)
  • UTF-8
  • SHIFT_JIS
  • BIG5

No

Logon With User Credentials

<logon-with-user-credentials>

Starts a service on the remote computer

  • Set <logon-with-user-credentials> to true to start the remote service using the credentials specified in the adapter configuration.
  • Set <logon-with-user-credentials> to false to start the remote service using the SYSTEM credentials on the remote server.

    Valid values: true, false (default)

    Note: To start a service on the remote computer, you must set the rights for the user name specified in <user-name> to Log on as a service. Use the Microsoft Windows Local Security Policy tool to set the user name rights.

The following figure shows an XML sample for configuring the actor adapter.

XML sample for configuring the actor adapter

<config>
  <target>10.128.18.29</target>
  <user-name>administrator</user-name>
  <password>bmcAdm1n</password>
  <adapter-files-location>C:\AD Files</adapter-files-location>
  <logon-with-user-credentials>true</logon-with-user-credentials>
</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