Skip to Content
Information

This site will undergo a brief period of maintenance on Thursday, 23 April at 2:30 AM Central/1:00 PM IST. During a 30 minute window, site availability may be intermittent.

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>
Information
Recommendation

BMC recommends that you use the password or the private-key-file approach; not both the approaches together.

The following figure shows the XML template for SSH adapter configuration with private-key-data approach.

XML template of the SSH adapter configuration with private-key-data approach



<config name="testPKA">
   <target>10.128.248.118</target>
   <user-name>name</user-name>
   <private-key-data>--BEGIN RSA PRIVATE KEY----
       Proc-Type: 4,ENCRYPTED
       DEK-Info: DES-EDE3-CBC,0FFD900EA089BBDD
       S5lpB02OesPZ9bEXJfYaziok9kSs46VfgHRF1WPgRQGFOnVvs0m+KU1iL5EiFzRC
       m3q9h2Dat+uLzdrnGWyAjaiTqAnlMcBtlgdu6UQfwPipXMMnOJpU2M0+8NqtZGiL
       3yFK6Zoox9EQ+enU2KlV05UUpo6I0erHvHcigDDK6tI4x50H7dHVtNixOlH3a/q5
       3A0t6ccPaOcBui+dsTO65nK7AcywRzhdhSBrDaFBoJBuBqiZ5p3AAi2xre+QAIpx
       wCoDBp76FRFePv2NYl7KEH4ajU4kR6DQoJiwgoD9TE6S/OwY79gr1cAoYQt+ldDi
       xiMzm5gV4BooYQDX8j63Qt6qABhOAAzATbOBedHdtRsn01B6saRtjrdI2QrHzx0t
       Cw/d3RoUS16uoXi66eA9L6dnwa5dyfO1KhkA3NV5LkX7NXfu5wu8Oua3JOnbRCIH
       shTrprCuwRFfUEqKz+KytckMbuVFPmD79pw4vsIWemN2xAPMdQEUFzprxWaI+6SY
       H0GSfiekfPBlE+8/jR2+a3giTAuRnUlchcCG7G95T/rREYzlx4vLTjVA3gzw/CPE
       9fcEBvgJVTY7VkpKQspsV9WM5tDKUJbsLG1UIKTa+ZLyIC1Nd9QroDGWbT72QxnA
       jzNDLS/CB4i/DK71dri19AZLre5pXL4G1Jgw192l+xx2oXv0xdHPHArBSpdnKQdo
       81ytjZomCPH41Ez5HxIBRHYWJz/rKsFPcnfAHCgRAxDJU8WXEB6GhwAvFqc6VFdK
       7HkD1Ec3uVw5BDize8DWY/fLJQL4T4zwvirWAlMQrbrdRwRc+9WxikBy1oVvxN4U
       dSUSsePwQ9QQq0PhKx+a3A/Ue9y/H51SEXsA46Uhtk9QV39D5tWEs/DoGqn8glGE
       I77saju3aQCjlpXq9QQXVAhvScG4MMhlri87DiCKa4PJ7kvq5d4IizlxMq0wjflX
       nrTqZDvMUAudZgi86679Km2WG5ZwSgXNOjA+B/Jo5c/T4Z1gWlnvpW5R0PUnsrMx
       V7U3fWcq2R8XUQzOdc4dJx55e8kP3tilO3HbNmfDRAgPoBUE1nIfRpv738nYbbOl
       msSrcv2lULIsF1qvA69ZOM5ziKvu0ElpgHMhZTGB4mcO8bDuBIdVeYhmmBgNL5r1
       GPOjdA/rqchWovR2SdCPTN0QiAhdFSzOKXSCJnv29dXsWSEUiYiXnTkLuyNOIgTS
       5ypd6MzPDbY8gWL/OYrdC8H98jt9YiZVroU7ra9zFoRC8cXbKgZevqoNnUUBTcfa
       pj5VzhKsHOwcObdL/oGxum97CDpjNoUYjqEF2W8N6rnScaCqoInOjGkm0WLxreLD
       BwsOJ2J7c40sr0gWzDGBC70HmA2rQba9TWZDuoE98H8XAv8Pdnv9K8+u/Q6IoXpo
       LJJmvjvA4LiPGn688+nKrcvrx8D5iz64ynQ2TaQlwz538AKFsaIBrn2F1oSnZ09M
       m45n5Rgkih0pti9SiOHbm84X7696mQLdh2y07U1IXj+uQoC30gJHKQa37kEEKYeV
       +ERwLmMr+JH2DWADnBMqizd2+ROo0V2vL4Vj17B+9rGg0LmnyCkyQQ==
       --END RSA PRIVATE KEY----
   </private-key-data>
   <prompt>$</prompt>
   <pass-phrase encryption-type="plain">changeit</pass-phrase>
</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>

 

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

(archive) BMC Atrium Orchestrator Base Adapters 20.12.04