Configuring the SCP adapter

In addition to targets defined in the adapter configuration, the SCP adapter can have a dynamic target defined in each adapter request. If a dynamic target is always defined in the SCP adapter request, a configuration node, <config/> can be used in the adapter configuration.

Note

The SCP adapter supports multi-byte and encoded data. The source and target computers must have the same locale and character sets to get the desired results.

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

Default adapter name: SCPAdapter

To configure the SCP adapter, see Configuring base adapters.

The following table describes the adapter configuration elements for the SCP 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 SCP adapter

 

The following figure shows the adapter configuration template for the SCP adapter.

XML template of the SCP adapter configuration

<configs>
<config name="">
  <target></target>
  <port></port>
  <user-name></user-name>
  <password encryption-type=""></password>
   <verify-os>false</verify-os>
  <timeout-secs></timeout-secs>
  <known-hosts-config></known-hosts-config>
  <allow-unknown-hosts></allow-unknown-hosts>
  <preferred-pk-algorithm></preferred-pk-algorithm>
  <establish-connection-timeout-secs></establish-connection-timeout-secs>
  <network-environment></network-environment>
</config>
  <config name="">
  <target></target>
  <port></port>
  <user-name></user-name>
  <verify-os>false</verify-os>
  <private-key-file></private-key-file>
  <pass-phrase encryption-type=""></pass-phrase>
  <timeout-secs></timeout-secs>
  <known-hosts-config></known-hosts-config>
  <allow-unknown-hosts></allow-unknown-hosts>
  <preferred-pk-algorithm></preferred-pk-algorithm>
  <establish-connection-timeout-secs></establish-connection-timeout-secs>
  <network-environment></network-environment>
</config>
</configs>

The following figure shows an XML sample for the SCP adapter configuration with an IPv6 target address.

XML sample of the SCP adapter configuration with an IPv6 target address

<config name="host1">
   <target>fe80::20c:29ff:fe5d:38f0%eth0</target>
   <port/>
   <user-name>asdf</user-name>
   <password encryption-type="Plain">pass</password>
   <verify-os>false</verify-os>
   <timeout-secs>60</timeout-secs>
   <known-hosts-config>/home/user2/.ssh/known_hosts</known-hosts-config>
   <allow-unknown-hosts>true</allow-unknown-hosts>
   <preferred-pk-algorithm>ssh-rsa</preferred-pk-algorithm>
   <establish-connection-timeout-secs />
</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.

 

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