Back to Top

Ssh Concurrent Command Execution Task

Class Name com.midvision.rapiddeploy.plugins.transport.jsch.task.SshConcurrentCommandExecutionTask
Category Ssh

Run a comand on group of downstream servers (concurrently) via Ssh


Description

Executes a command from the deployment server via Ssh onto another set of downstream servers. The command is run on each server simultaneously (concurrently).

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
outputParameter java.lang.String ${sshCommandOutput} true The name of the output parameter, which can pass the return value from the task. The task output will be the script output value. Define a unique parameter name starting with '${', ending with '}' for the whole orchestration (latter tasks can override the parameter value if the same parameter name is specified). You can refer to this parameter in any task below in the tasklist, as an input parameter ${output}. As this task is able to generate an output from many targets the format of the output is : [targetServerName] command output: [output] \n [targetServerName2] command output: [output2]. You can then use SubStringTask or ReplaceStringTask to parse the output from this task.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
targetServerCommand java.lang.String   false A command to execute e.g. echo $PATH.
targetServerNames java.lang.String server1,server2 false Comma separated list of target servers.
targetServerSshPassphrase java.lang.String   true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target server.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

Ssh Concurrent Copy (Scp) Task

Class Name com.midvision.rapiddeploy.plugins.transport.jsch.task.SshConcurrentCopyTask
Category Ssh

Copy files onto a group of downstream servers (concurrently) via Scp


Description

This task will concurrently copy files onto a group of downstream servers via Scp. Copies files from the deployment server to other downstream servers using Scp.
The copy is performed to each server simultaneously (concurrently).

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
copySource java.lang.String   false The full or relative (to archive root) path to the file or directory as copy source. (From local file or directory)
copyTarget java.lang.String   false Path of the file or directory on the target server. (To remote file or directory)
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sourceRelativeToArchiveRoot java.lang.Boolean false false Sets if the source path is relative to archive root, Default is false.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
targetServerNames java.lang.String server1,server2 false Comma separated list of target servers.
targetServerSshPassphrase java.lang.String   true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target server.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

Ssh Concurrent Get (Scp) Task

Class Name com.midvision.rapiddeploy.plugins.transport.jsch.task.SshConcurrentGetTask
Category Ssh

Get files from a group of servers (concurrently) via Scp


Description

This task will concurrently get files from a group of servers via Scp. Copies files from remote servers back to the deployment server using Scp.
The copy is performed to each server simultaneously (concurrently).

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
copySource java.lang.String   false The full path of the file or directory on the source server to get (copy from).
copyTarget java.lang.String   false The full or relative (to archive root) path of the file or directory as get target (the local file or directory to copy to, on the server where the deployment job is running).
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sourceServerNames java.lang.String server1,server2 false Comma separated list of source servers.
sourceServerSshPassphrase java.lang.String   true Source SSH passphrase (if required).
sourceServerSshPassword java.lang.String   true Source SSH Password (if required).
sourceServerSshPort java.lang.String 22 false SSH Port on the source server.
sourceServerSshTimeout java.lang.String 1200000 false Timeout on the source server(s) in milliseconds.
sourceServerSshUser java.lang.String sshUser false Source SSH user.
sourceType java.util.List directory false The source type to copy, by default the target path is Directory.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
targetRelativeToArchiveRoot java.lang.Boolean false false Sets if the target path is relative to archive root, Default is false.


Back to Top

Ssh Serial Command Execution Task

Class Name com.midvision.rapiddeploy.plugins.transport.jsch.task.SecureExecutionEnvironmentSpecificTask
Category Ssh

Run a comand on group of downstream servers (serially) via Ssh


Description

Executes a command from the deployment server via Ssh onto another set of downstream servers. The command is run on each server in turn.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
executableToRunPathAndArgs java.lang.String /bin/ls /tmp; /bin/cat /tmp/install.dat false The command to run and all of its argumets. Commands may be chained together.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
targetServerNames java.lang.String server1,server2 false Comma separated list of target servers to copy the file(s) to.
targetServerSshPassphrase java.lang.String ****** true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target serves.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

Ssh Serial Copy (Scp) Task

Class Name com.midvision.rapiddeploy.plugins.transport.jsch.task.SecureCopyEnvironmentSpecificTask
Category Ssh

Copy files onto a group of downstream servers (serially) via Scp


Description

Copies files from remote servers back to the deployment server using Scp. The copy is performed to each server in turn (serially).

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
copySource java.lang.String /tmp/path/to/copy/from false The full or relative (to archive root) path to the file or directory as copy source. (From local file or directory)
copyTarget java.lang.String /tmp/path/to/copy/to false The full path to copy the target file or directory. (To remote file or directory)
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sourceRelativeToArchiveRoot java.lang.Boolean false false Sets if the source path is relative to archive root, Default is false.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
targetServerNames java.lang.String server1,server2 false Comma separated list of target servers to copy the file(s) to.
targetServerSshPassphrase java.lang.String ****** true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String   true Target SSH Password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target serves.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.


Back to Top

Ssh Serial Get (Scp) Task

Class Name com.midvision.rapiddeploy.plugins.transport.jsch.task.SecureGetEnvironmentSpecificTask
Category Ssh

Gets files from a group of servers (serially) via Scp


Description

Gets files from remote servers to the deployment server using Scp.
The copy is performed to each server in turn (serially).

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
copySource java.lang.String /tmp/path/to/copy/from false The full path of the file or directory on the source server to get (copy from).
copyTarget java.lang.String /tmp/path/to/copy/to false The full or relative (to archive root) path of the file or directory as get target (the local file or directory to copy to, on the server where the deployment job is running).
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sourceServerNames java.lang.String server1,server2 false Comma separated list of source servers to copy the file(s) to.
sourceServerSshPassphrase java.lang.String ****** true Source SSH passphrase (if required).
sourceServerSshPassword java.lang.String   true Source SSH Password (if required).
sourceServerSshPort java.lang.String 22 false SSH Port on the source serves.
sourceServerSshTimeout java.lang.String 1200000 false Timeout on the source server(s) in milliseconds.
sourceServerSshUser java.lang.String sshUser false Source SSH user.
sourceType java.util.List directory false The source type to copy, by default the target path is Directory.
sshIdentityFile java.lang.String /path/to/identity/file true Local Identity file.
targetRelativeToArchiveRoot java.lang.Boolean false false Sets if the target path is relative to archive root, Default is false.