sshapi-call-node/provider/ReadMe.md

   1 SSHApi-Call-Node Plugin:
   2
   3 Parameters List that managed in from Directed Graphs:
   4
   5 Input:
   6 Url    ->    Mandatory    ->    url to make the SSH connection request to.
   7 Port    ->    Mandatory    ->    port to make the SSH connection request to.
   8 AuthType    ->    Optional    ->    Type of authentiation to be used BASIC or sshKey based    ->    true or false
   9 User    ->    Optional    ->    user name to use for ssh basic authentication    ->    sdnc_ws
  10 Password    ->    Optional    ->    unencrypted password to use for ssh basic authentication    ->    plain_password
  11 SshKey    ->    Optional    ->    Consumer SSH key to use for ssh authentication    ->    plain_key
  12 ExecTimeout    ->    Optional    ->    SSH command execution timeout    ->    plain_key
  13 Retry    ->    Optional    ->    Make ssh connection with default retry policy    ->    plain_key
  14 Cmd    ->    Mandatory    ->    ssh command to be executed on the server.    ->    get post put delete patch
  15 EnvParameters    ->    Optional    ->    A JSON dictionary which should list key value pairs to be passed to the command execution. These values would correspond to instance specific parameters that a command may need to execute an action.
  16 FileParameters    ->    Optional    ->    A JSON dictionary where keys are filenames and values are contents of files. The SSH Server will utilize this feature to generate files with keys as filenames and values as content. This attribute can be used to generate files that a command may require as part of execution.
  17 ConvertResponse     ->    Optional    ->    whether the response should be converted to properties   ->    true or false
  18 ResponseType    ->    Optional    ->    If we know the response is to be in a specific format (supported are JSON, XML and NONE)
  19 ResponsePrefix    ->    Optional    ->    location the response will be written to in context memory
  20 listName[i]    ->    Optional    ->    Used for processing XML responses with repeating elements.</td>vpn-information.vrf-details
  21
  22 Output:
  23 "sshApi.call.node.status"   ->    SSH Exit status code is set in here.
  24 "sshApi.call.node.stdout"   ->    SSH command execution result is put in here.
  25 "sshApi.call.node.stderr"   ->    SSH execution failure message is put in here.
  26
  27
  28
  29 API methods that are exposed:
  30 1) execCommand
  31 2) execWithStatusCheck: Throws exception if the exit status is not successful.
  32 3) execCommandWithPty