Skip to content

rundeck-plugins/sshj-plugin

Repository files navigation

sshj-plugin Rundeck Plugin

This is a node executor / File Copier plugin based on SSHJ library

Build and Install

./gradlew clean && ./gradlew build 

cp build/libs/sshj-plugin-x.x.x.jar $RDECK_BASE/libext

How to use

This plugin has the same configuration names than the default JSCH plugin, so most of this documentation works for this plugin.

Set it at project level

Go to Project Settings > Edit Configuration to set the SSHJ plugin at project level

  • Node Executor

Node Executor

  • File Copier

Node Executor

  • Settings

Node Executor

Set at node level

Use node-executor and file-copier node attributes to use SSHJ plugin at node level.

Demo-Ubuntu:
  nodename: Demo-Ubuntu
  hostname: 192.168.100.18
  description: Ubuntu 20
  username: samuel
  osFamily: unix
  node-executor: sshj-ssh
  file-copier: sshj-scp
  tags: ubuntu
  ssh-authentication: password
  ssh-password-storage-path: keys/node/samuel.password
  sudo-password-storage-path: keys/node/sudo.password
  ssh-password-option: option.password
  sudo-command-enabled: 'true'
  

Status

  • Key Storage Password Authentication
  • File Key Authentication
  • Key Storage Key Authentication (it works with a creating a temp file from key storage, TODO: hierynomus/sshj#350 (comment))
  • Passphrase
  • Env Variables
  • Sudo Commands (Experimental, works with Java ExpectIt lib)
  • Username from input option
  • Password from input option
  • Sudo Password from input option
  • Passphrase from input option
  • Keep alive
  • File Transfer Single File
  • File Transfer Multiples File