TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildSteps/SSHExec

SSHExec

fun BuildSteps.sshExec(init: SSHExec.() -> Unit): SSHExec

An SSH Exec build step.

Example. Adds an SSH Exec build step with custom port and Uploaded key authentication method.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        sshExec {
            name = "My SSH Exec build step"
            commands = """
                command1
                command2
            """.trimIndent()
            targetUrl = "8.8.8.8"
            port = 2222
            authMethod = uploadedKey {
                username = "username"
                passphrase = "credentialsJSON:******"
                key = "id_rsa"
            }
        }
Content copied to clipboard
    }
}

Example. Adds an SSH Exec build step with Default private key authentication method.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        sshExec {
            name = "My SSH Exec build step"
            commands = """
                command1
                command2
            """.trimIndent()
            targetUrl = "8.8.8.8"
            authMethod = defaultPrivateKey {
                username = "username"
                passphrase = "credentialsJSON:******"
            }
        }
Content copied to clipboard
    }
}

Example. Adds an SSH Exec build step with pty enabled and Custom private key authentication method.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        sshExec {
            name = "My SSH Exec build step"
            pty = "vt100"
            commands = """
                command1
                command2
            """.trimIndent()
            targetUrl = "8.8.8.8"
            authMethod = customPrivateKey {
                keyFile = "path/to/key/file"
                username = "username"
                passphrase = "credentialsJSON:******"
            }
        }
Content copied to clipboard
    }
}

Example. Adds an SSH Exec build step with Password authentication method.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        sshExec {
            name = "My SSH Exec build step"
            commands = """
                command1
                command2
            """.trimIndent()
            targetUrl = "8.8.8.8"
            authMethod = password {
                username = "username"
                password = "credentialsJSON:******"
            }
        }
Content copied to clipboard
    }
}

Example. Adds an SSH Exec build step with SSH-Agent authentication method. This build step will run even if some previous build steps are failed.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        sshExec {
            name = "My SSH Exec build step"
            executionMode = BuildStep.ExecutionMode.RUN_ON_FAILURE
            commands = """
                command1
                command2
            """.trimIndent()
            targetUrl = "8.8.8.8"
            authMethod = sshAgent {
                username = "username"
            }
        }
Content copied to clipboard
    }
}

Constructors

SSHExec

constructor(init: SSHExec.() -> Unit)

constructor()

Types

AuthMethod

sealed class AuthMethod : CompoundParam<SSHExec.AuthMethod>

Properties

authMethod

var authMethod: SSHExec.AuthMethod?

An SSH authentication method.

commands

var commands: String?

Specify a new-line delimited set of commands that will be executed in the remote shell. The remote shell will be started in the home directory of an authenticated user. The shell output will be available in the TeamCity build log.

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

enabled

var enabled: Boolean

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

var id: String?

Optional id of the step. Usually the id is not required, however if a build configuration inherits from a template and wants to override a build step defined there, then both steps should have the same id.

name

var name: String

Build step name

params

val params: List<Parameter>

port

var port: Int?

Optional. Default value: 22.

pty

var pty: String?

Optional. Specify the type of the pty terminal. For example, "vt100". If empty, pty will not be allocated (default).

targetUrl

var targetUrl: String?

Target url in form {hostname|ip_address}:path/to/target/folder.

timeout

var timeout: Int?

Optional. Default value (seconds): 60 (0 - disable timeout).

type

var type: String

Build step type

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

conditions

fun conditions(init: BuildStepConditions.() -> Unit = {})

Configures build step conditions

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): BuildStep

Creates an instance of this build step via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

customPrivateKey

fun customPrivateKey(init: SSHExec.AuthMethod.CustomPrivateKey.() -> Unit = {}): SSHExec.AuthMethod.CustomPrivateKey

Will try to perform private key authentication using the given public key file with given passphrase.

defaultPrivateKey

fun defaultPrivateKey(init: SSHExec.AuthMethod.DefaultPrivateKey.() -> Unit = {}): SSHExec.AuthMethod.DefaultPrivateKey

Will try to perform private key authentication using the ~/.ssh/config settings. If no settings file exists, will try to use the ~/.ssh/rsa_pub public key file.

doubleParameter