Configuring the Hyper-V Server 2012 adapter

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

This topic describes the properties to configure the Hyper-V Server 2012 adapter:



The Hyper-V Server actor adapter supports empty, single, and multiple configurations.

Recommendation

BMC recommends that you do not use empty elements in an adapter configuration because they might cause errors.

To configure the actor adapter

  1. Log on to Grid Manager.
  2. Access the adapters page by clicking the Manage tab and then clicking the Adapters tab.
  3. In the Adapters in Repository list, select the bmc-adapter-ms-hyperv-server-v2012-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 by using the form view, or jump 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.
      The configuration elements for each adapter are described in that adapter's section. Include all required elements 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 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 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.
      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 adapter configuration elements for the Hyper-V Server adapter that you can specify by using the form view, XML view, or both.

Error rendering macro 'hide-if'

Failed to render Visibility macro due to: Invalid group name(s): bmc-contibutors

The following figures show XML templates for the Hyper-V Server 2012 adapter empty and single target configuration:

XML template of the Hyper-V Server adapter empty configuration

<config/>

XML template of the Hyper-V Server adapter single-target configuration 

<config>
  <host></host>
  <user-name></user-name>
  <password></password>
</config>

The following figure shows an XML sample for the Hyper-V Server adapter configuration with a single target:

XML sample of the Hyper-V Server adapter configuration with a single target

<config>
  <host>172.16.49.177</host>
  <user-name>test1</user-name>
  <password encryption-type="plain">random@123</password>
</config>

The following figure shows an XML sample for the Hyper-V Server adapter configuration with multiple targets:

XML sample of the Hyper-V Server adapter configuration with multiple targets

<configs>
  <config>
   <host>172.16.49.177</host>
   <user-name>synapse\abc.def</user-name>
   <password encryption-type="plain">random@123</password>
  </config>
  <config name="config1">
   <host>172.16.49.177</host>
   <user-name>synapse\abc.xyz</user-name>
   <password encryption-type="plain">random@123</password>
  </config>
</configs>

Note

If there are multiple targets in the configuration, but no target is named in the adapter request, then the first target (<config>) in the configuration list (<configs>) is the default target.

Adapter configuration properties

This section describes some common configuration properties than you can add Properties section of the Adapter Configuration page.

Encrypting an element's contents

You can add the attribute secure="true" to an XML adapter element XML view to ensure that the element's contents is encrypted when displayed.

Note

You must be using BMC Atrium Orchestrator Platform version 7.8 or later to use this encryption attribute.

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

<host secure="true">172.16.49.177</host>

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