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

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

SSHExec

fun SSHExec()

Types

AuthMethod

sealed class AuthMethod : CompoundParam<SSHExec.AuthMethod>

Functions

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, 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

fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

password

fun password(init: SSHExec.AuthMethod.Password.() -> Unit = {}): SSHExec.AuthMethod.Password

Simple password authentication.

removeRawParam

fun removeRawParam(paramName: String)

sshAgent

fun sshAgent(init: SSHExec.AuthMethod.SshAgent.() -> Unit = {}): SSHExec.AuthMethod.SshAgent

Use ssh-agent for authentication, the SSH-Agent build feature must be enabled.

stringParameter

open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

toString

open override fun toString(): String

uploadedKey

fun uploadedKey(init: SSHExec.AuthMethod.UploadedKey.() -> Unit = {}): SSHExec.AuthMethod.UploadedKey

Uses the key(s) uploaded to the project.

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

authMethod

var authMethod: <ERROR CLASS>

An SSH authentication method.

commands

var commands: <ERROR CLASS>

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 = true

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

var id: String? = null

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