Configuring adapters

You configure an adapter in Grid Manager. The configuration provides information about how the adapter interacts with the BMC or third-party 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 adapter user documentation 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. 

The following video (8:23) demonstrates how to add an adapter to a BMC Atrium Orchestrator grid and how to use Grid Manager to configure the adapter and enable the adapter on a peer in the grid.

 https://youtu.be/XYZ6ROVcqh8

To configure an adapter

1. In the Grid Manager application, select the Manage tab, and then select the Adapters tab.
2. In the Adapters on Grid table perform the appropriate action:
   • If you want to configure the adapter for the first time, click Configure for that adapter.
   • If you want to change the configuration of an adapter that has already been configured, click the name of the adapter.
     
     The Adapter Configuration page is displayed.
3. Enter the adapter name and description in the appropriate fields.
4. Complete the Properties section of the Adapter Configuration page, according to the adapter that you are configuring. See Adapter configuration properties for additional property details.
   • If the Adapter Configuration page contains a Properties field, enter the adapter configuration properties in XML in that field.
   • If the Adapter Configuration page contains a form with text fields, where required fields are marked with an asterisk (*), and other controls, perform the appropriate action:
     • If you want to use the form, enter the adapter configuration properties in the form, and then click OK. 
       
       In the confirmation dialog box, click Save to save the configuration. If you configure the adapter in the future, you can use the form view or XML view.

     • If you want to enter the property values using XML, click Switch to XML view. 
       
       On the Warning dialog box, if you click Switch View and then Save in XML view in the future you can only configure the adapter using XML view (the form view will not be available). Click Cancel if you want the form view available for this adapter in the future. 
       
       The Adapter Configuration page is redisplayed with one Properties field. If any of the form fields contained configuration values, those values are included in the XML code in the Properties field. 
       
       Enter the adapter configuration properties in XML in the Properties field, and then click OK. 
       
       For specific configuration requirements, see BMC Atrium Orchestrator Base Adapters or BMC Atrium Orchestrator Application Adapters. 

   • If the adapter does not require a specific configuration, enter the following XML text in the Properties field: <config/>.

5. Click OK when you are done adding the properties.

Adapter configuration properties

This section describes some common configuration properties that you can add to the Properties section of the Adapter Configuration page. For specific adapter configuration requirements, see BMC Atrium Orchestrator Base Adapters or BMC Atrium Orchestrator Application Adapters.

For example, to encrypt the port number used by an adapter, the XML would look similar to the following:

<port secure="true">22</port>

After saving your adapter configuration changes, the port display in XML will look similar to the following example:

<port secure="true">
<EncryptedData xmlns="http://www.w3.org/2001/04/xmlenc#" Type="http://www.w3.org/2001/04/xmlenc#Content">
<CipherData>
<CipherValue>MgdrTbjJ0FoAPGoAXVlFVg==</CipherValue>
</CipherData>
</EncryptedData>
</port>

Related topics

Adding adapters to a grid
Enabling and disabling adapters