SSHTask

interface SSHTask (source)

Common interface for tasks that connect to SSH.

Name	Summary
config	`abstract val config:` `Property<String>` The SSH config file. Contains per-host settings such as username, host address and identity file. Defaults to ~/.ssh/config.
connectionTimeout	`abstract val connectionTimeout:` `Property<Int>` The timeout in milliseconds after which to abort the connection. Defaults to 15000.
host	`abstract val host:` `Property<String>` The hostname or IP address of the SSH server.
identity	`abstract val identity:` `Property<String>` The private identity key file for logging in to the SSH server. May also be specified using `IdentityFile` in the SSH config file.
knownHosts	`abstract val knownHosts:` `Property<String>` The known hosts file. SFTP will refuse to connect unless the host is present in this file. Defaults to ~/.ssh/known_hosts.
password	`abstract val password:` `Property<String>` The password for logging in to the SSH server. Not recommended; prefer using an identity file instead.
port	`abstract val port:` `Property<Int>` The port of the SSH server. May also be specified using `Port` in the SSH config file.
username	`abstract val username:` `Property<String>` The username for logging in to the SSH server. May also be specified using `User` in the SSH config file.

Name	Summary
createSession	`abstract fun createSession(): Session`

Name	Summary
SFTP	`abstract class SFTP :` `AbstractTransferTask<ChannelSftp>,` `SSHTask` Task for uploading files via SFTP (SSH). A predefined task instance can be accessed through Subs.sftp.
SSHExec	`open class SSHExec :` `DefaultSubTask,` `SSHTask` Task for executing commands on a remote shell via SSH.

Provide feedback