Configuring the DNS adapter

You configure an adapter in Grid Manager. The configuration provides information about how the adapter interacts with the DNS 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 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 on the form view 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.

To configure the actor adapter

  1.  Log on to the TrueSight Orchestration 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-dns-actor check box to configure the actor adapter.
  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 default name for the DNS adapter is DNSadapter. 

    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 to specify elements and attributes that are not in the form view.
    3. On the Warning message that appears, click Switch View.
    4. Copy the configuration elements and attributes 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 action 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 elements of an actor adapter configuration that you can specify 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. To configure such elements and attributes, you have to switch to XML view.

Configuration node elements for the DNS adapter

UI LabelElementDescriptionRequired
Command File Location<command-file-location>

Specifies a valid directory location on the BAO server

This location is used to create the files, which are used to run the commands.

No
DNS Zone<dns-zone>
Specifies the DNS zone in which an A record is to be createdConditional; required if not specified in the adapter request
DNS Server<dns-server>
Specifies the host name or IP address of the DNS server in which an A record is to be createdConditional; required if not specified in the adapter request
Reverse DNS Server<reverse-dns-server>
Specifies the host name or IP address of the DNS server in which a PTR record is to be createdConditional; required if not specified in the adapter request
Reverse DNS Zone<reverse-dns-zone>
Specifies the DNS zone in which a PTR record is to be createdConditional; required if not specified in the adapter request
Secret Key Name<secret-key-name>

Specifies the secret key configured with the DNS server

You can either provide the <secret-key-location> element or the <secret-key-name> and the <secret-key-data> elements.

Conditional; required for an A record
Secret Key Data<secret-key-data>

Specifies the secret key data that matches the <secret-key-name> element

You can either provide the <secret-key-location> element or the <secret-key-name> and the <secret-key-data> elements.

Conditional; required for an A record
Secret Key Location<secret-key-location>

Specifies the location where the secret key which is used to connect to the DNS server is located

If you provide <secret-key-location> the adapter considers the location and ignores the <secret-key-name> and <secret-key-data> values.

To execute the nsupdate commands on Windows DNS server (in secure mode), you must specify the keytab file location and the key principle name with a space in between.

If the keytab file is found with extension .keytab, then the adapter formats the command to execute the kinit command followed by nsupdate command with “-g” switch for dynamic DNS updates.

For example:

<secret-key-location><keytab_file_location><space> <principal_Name></secret-key-location>

<secret-key-location>/opt/keys/dnswindows.keytab host/vw-xxx-yyy-zzz@TESTING.COM </secret-key-location>

Conditional; required for an A record
Reverse DNS Secret Key Data<reverse-dns-secret-key-data>

Specifies the secret key data that matches the <reverse-dns-secret-key-name>

You can either provide the <reverse-dns-secret-key-location> element or the <reverse-dns-secret-key-name> and the <reverse-dns-secret-key-data> elements.

Conditional; required for a PTR record
Reverse DNS Secret Key Name<reverse-dns-secret-key-name>

Specifies the secret key name configured with the reverse DNS server

You can either provide the <reverse-dns-secret-key-location> element or the <reverse-dns-secret-key-name> and the <reverse-dns-secret-key-data> elements.

Conditional; required for a PTR record
Reverse DNS Secret Key Location<reverse-dns-secret-key-location>

Specifies the secret key location to be used to connect to Reverse DNS server

If you provide the <reverse-dns-secret-key-location>, the adapter considers the location and ignores the <reverse-dns-secret-key-name> and <reverse-dns-secret-key-data> values.

Conditional; required for a PTR record

The following figures show XML templates for the DNS adapter empty configuration:

XML template of the DNS adapter empty configuration

<config>

Note

The DNS adapter supports empty configuration, which indicates that you can specify the DNS details at the adapter request as dynamic targets. Note that if you specify even a single element from the following elements in the adapter configuration, you must specify the rest of the following elements.

  • DNS Zone
  • DNS Server
  • Reverse DNS Zone
  • Reverse DNS Server 

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

XML template of the DNS adapter configuration

<config>
  <command-file-location>/tmp</command-file-location>
  <dns-zone>dnsbind.com</dns-zone>
  <dns-server>10.129.69.38</dns-server>
  <reverse-dns-server>10.129.69.38</reverse-dns-server>
  <reverse-dns-zone>69.129.10.in-addr.arpa</reverse-dns-zone>
 <secret-key-name>DNSKEY</secret-key-name>
 <secret-key-data>hjsklnusjlkslkw 454143565 wewhjeiwjdmwi</secret-key-data>
  <reverse-dns-secret-key-name>ddns-update</reverse-dns-secret-key-name>
  <reverse-dns-secret-key-data>Kf6wMyO1Uo6F1mWnBlZuMAa8B+UAOHXd3DYE+lif16x2l
+2vBoESOz3fbWlvHDVN5Xvw3EOisCTTxyQdHf90Zg==</reverse-dns-secret-key-data>
</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 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

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.

Was this page helpful? Yes No Submitting... Thank you

Comments