Configuring the HTTP adapter

Adapter type: ro-adapter-http_vv.rr.nn

Default adapter name: HTTPAdapter

The Properties field in the adapter configuration of Grid Manager is a required field. If the default values are acceptable for all elements, you can enter a configuration node, <config/>, in the Properties field. When you set a configuration node, the adapter uses the default values for all the elements. If you use a proxy server for Internet connectivity, use the proxy settings shown in the <config> section in the XML sample of the HTTP adapter configuration. If your environment does not require a proxy server, you can set a configuration node.

BMC recommends that you do not include unused elements in the adapter configuration because they might cause the adapter to enter a fault state.

To configure the HTTP adapter, see Configuring base adapters.

The following table describes the adapter configuration elements for the HTTP adapter that you can specify by using the form view, XML view, or both. You cannot use the form view to configure elements and attributes that do not have an entry in the "UI label" column.


 Configuration node elements for the HTTP adapter

 

The following figure shows an XML template for the HTTP adapter configuration.

XML template of the HTTP adapter configuration

<config>
  <data-format></data-format>
  <request-timeout></request-timeout>
  <character-set></character-set>
  <proxy-settings>
           <host></host>
           <port></port>
           <user-name></user-name>
           <password></password>
           <proxy-ntlm-authentication></proxy-ntlm-authentication>
  </proxy-settings>
  <enable-json-conversion></enable-json-conversion>
  <enable-redirects></enable-redirects>
</config>

The following figure shows an XML sample for the HTTP adapter configuration. As seen in the figure, to resolve proxy settings errors, enter the proxy settings for the Internet connection. To resolve authentication errors, enter a valid username and password.

XML sample of the HTTP adapter configuration

<config>
     <data-format>HTML</data-format>
     <request-timeout>15</request-timeout>
     <character-set>utf-8</character-set>
     <proxy-settings>
           <host>10.10.75.120</host>
           <port>3128</port>
           <user-name>jones</user-name>
           <password>bmc1234</password>
           <ntlm-authentication>true</ntlm-authentication>
           <proxy-ntlm-authentication>true</proxy-ntlm-authentication>
     </proxy-settings>
     <enable-json-conversion>true</enable-json-conversion>
     <enable-redirects>true</enable-redirects>
</config>

The following figure shows an XML sample for the HTTP adapter configuration when the adapter supports mutual authentication and mode is keystore.

XML sample of the HTTP adapter configuration when the adapter supports mutual authentication and <mode> is keystore

<config>
   <signature-properties mode="keystore">
       <keystore-file>filePath\server.jks</keystore-file>
       <keystore-password>changeit</keystore-password>
       <alias>1</alias>
       <key-password>abcdef</key-password>
   </signature-properties>
</config>

The following figure shows an XML sample for the HTTP adapter configuration when the adapter supports mutual authentication and mode is key-files.

XML sample of the HTTP adapter configuration when the adapter supports mutual authentication and <mode> is key-files

<config>
   <signature-properties mode="key-files">
       <private-key-file>filePath\serverkey.pem</private-key-file>
       <certificate-file>filePath\server.pem</certificate-file>
   </signature-properties>
</config>

The following figure shows an XML sample for the HTTP adapter configuration when the adapter supports mutual authentication and mode is key-data.

XML sample of the HTTP adapter configuration when the adapter supports mutual authentication and <mode> is key-data

<config>
   <signature-properties mode="key-data">
   <private-key-data>-----BEGIN RSA PRIVATE KEY-----
      MIICXAIBAAKBgQDbDkji1X+Bxv7WLI5yaFTFsWgBtLPlm7x0O9iACBycLKelOZJl
       ....
      m57VRInEsLbXpJHoPISk8Gj+JL/CGK7rIcDtPebLIEs=
   -----END RSA PRIVATE KEY-----</private-key-data>
   <certificate-data>-----BEGIN CERTIFICATE-----
      MIICvzCCAigCAQEwDQYJKoZIhvcNAQEEBQAwga0xCzAJBgNVBAYTAlVTMREwDwYD
       ....
      nSYYODyuU/pfV9V+qS+p/kwk/UKgEiwnngPEFn7v3zAzXmE=
   -----END CERTIFICATE-----</certificate-data>
 </signature-properties>
</config>

The following figure shows an XML sample for the HTTP adapter configuration when the adapter supports downloading a file.

XML sample of the HTTP adapter configuration when the adapter supports downloading a file

<config>
   <download-directory>c:\tmp</download-directory>
   <download-attachment>true</download-attachment>
</config>

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 TrueSight Orchestration Platform version 8.1 or later to use this encryption attribute.

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 TrueSight Orchestration version 8.1 or later to use the custom logging feature. These parameters will be ignored in earlier versions of TrueSight Orchestration Platform.

These parameters are available with supported adapter versions. See TrueSight Orchestration Content 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

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*