Configuring the SSH adapter
For the SSH adapter, in addition to target computers defined in the adapter configuration, you can define dynamic target computers in each adapter request. If a dynamic target is defined in the SSH adapter request, use a configuration node, <config/>, 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-ssh[version]
Default adapter name: SSHAdapter
To configure the SSH adapter, see Configuring base adapters.
The following table describes the adapter configuration elements for the SSH 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 of the SSH adapter
The following figure shows the XML template for SSH adapter configuration with password approach.
XML template of the SSH adapter configuration with password approach
<config>
<config name = "">
<target></target>
<port></port>
<user-name></user-name>
<password encryption-type=""> </password>
<prompt></prompt>
<verify-os></verify-os>
<read-buffer-size></read-buffer-size>
<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>
<line-termination></line-termination>
</config>
The following figure shows the XML template for SSH adapter configuration with private-key-file approach.
XML template of the SSH adapter configuration with private-key-file approach
<config>
<config name = "">
<target></target>
<port></port>
<user-name></user-name>
<private-key-file></private-key-file>
<pass-phrase encryption-type=""></pass-phrase>
<prompt></prompt>
<verify-os></verify-os>
<timeout-secs></timeout-secs>
<read-buffer-size></read-buffer-size>
<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>
<line-termination></line-termination>
</config>
The following figure shows an XML sample for SSH adapter configuration with CharSet.
XML sample of the SSH adapter configuration with CharSet
<config name="KbiConfig">
<target>server1</target>
<user-name>testuser</user-name>
<port>22</port>
<password>abc</password>
<verify-os>true</verify-os>
<read-buffer-size>1024</read-buffer-size>
<timeout-secs></timeout-secs>}}
<allow-unknown-hosts>true</allow-unknown-hosts>
<character-set>Shift_JIS</character-set>
</config>