Name

adams.flow.standalone.SSHConnection

Synopsis

Provides access to a remote host via SSH.

For more information see:

 (2011). JSch - JSch is a pure Java implementation of SSH2..

Additional information

Flow input/output:
-standalone-

Interactive actor information:
- supports interaction in headless mode: true

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	SSHConnection

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• host
  

  The host (name/IP address) to connect to.

  command-line	-host <java.lang.String>
  default

  
  
• port
  

  The port to connect to.

  command-line	-port <int>
  default	22
  minimum	1
  maximum	65535

  
  
• authenticationType
  

  The type of authentication to use.

  command-line	-authentication-type <CREDENTIALS|PUBLIC_KEY>
  default	CREDENTIALS

  
  
• user
  

  The SSH user to use for connecting.

  command-line

  -user <java.lang.String>

  
  
• password
  

  The password of the SSH user to use for connecting.

  command-line

  -password <adams.core.base.BasePassword>

  
  
• privateKeyFile
  

  The location of the private key.

  command-line	-private-key-file <adams.core.io.PlaceholderFile>
  default	${HOME}/.ssh/id_rsa

  
  
• privateKeyPassphrase
  

  The passphrase for the private key file, ignored if empty.

  command-line

  -private-key-passphrase <adams.core.base.BasePassword>

  
  
• knownHosts
  

  The file storing the known hosts.

  command-line	-known-hosts <adams.core.io.PlaceholderFile>
  default	${HOME}/.ssh/known_hosts

  
  
• strictHostKeyChecking
  

  Enables/disables strict host key checking - strict checking is the recommended setting, as disabling it is very insecure!

  command-line	-strict-host-key-checking <boolean>
  default	true

  
  
• forwardX
  

  If set to true, then X is forwarded.

  command-line	-forward-x <boolean>
  default	false

  
  
• XHost
  

  The xhost (name/IP address) to connect to.

  command-line	-x-host <java.lang.String>
  default

  
  
• XPort
  

  The xport to connect to.

  command-line	-x-port <int>
  default	6000
  minimum	1
  maximum	65535

  
  
• promptForPassword
  

  If enabled, the user gets prompted for enter a password if none has been provided in the setup.

  command-line	-prompt-for-password <boolean>
  default	false

  
  
• timeout
  

  The timeout in milliseconds.

  command-line	-timeout <int>
  default	0
  minimum	0

  
  
• stopFlowIfCanceled
  

  If enabled, the flow gets stopped in case the user cancels the dialog.

  command-line	-stop-if-canceled <boolean>
  default	false

  
  
• customStopMessage
  

  The custom stop message to use in case a user cancelation stops the flow (default is the full name of the actor)

  command-line	-custom-stop-message <java.lang.String>
  default

  
  
• stopMode
  

  The stop mode to use.

  command-line	-stop-mode <GLOBAL|STOP_RESTRICTOR>
  default	GLOBAL