Configuring the SFTP adapter
In addition to targets defined in the adapter configuration, the SFTP adapter can have a dynamic target defined in each adapter request. If a dynamic target is defined in the SFTP adapter request, a configuration node, <config/> can be used in the adapter configuration.
BMC recommends that you do not include unused elements in the adapter configuration because they might cause errors.
Adapter type: ro-adapter-sftp[baob201301:version]
Default adapter name: SFTPActorAdapter
To configure the SFTP adapter, see Configuring base adapters.
The following table describes the adapter configuration elements for the SFTP 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 SFTP adapter
The following figure shows an XML template of the adapter configuration for the SFTP adapter.
XML template of the SFTP adapter configuration
<configs>
<config name="host1">
<target></target>
<port></port>
<user-name></user-name>
<password encryption-type=""></password>
<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="host2">
<target></target>
<port></port>
<user-name></user-name>
<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 of the SFTP adapter configuration.
XML sample of the SFTP adapter configuration
<config name="dev3">
<target>dev3</target>
<userName>abc</userName>
<password encryption-type="Plain">pass</password>
<allow-unknown-hosts>true</allow-unknown-hosts>
</config>
<config name="dev4">
<target>dev4</target>
<userName>asd</userName>
<password>pass</password>
<allow-unknown-hosts>true</allow-unknown-hosts>
</config>
The following figure shows an XML sample of the adapter configuration for the SFTP adapter with the CharSet element.
XML template of the SFTP adapter configuration
<config>
<target>Server</target>
<user-name>user</user-name>
<password encryption-type="Plain">pass</password>
<timeout-secs>120</timeout-secs>
<allow-unknown-hosts>true</allow-unknown-hosts>
<character-set>Shift_JIS</character-set>
</config>