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

SSHUpload

fun BuildSteps.sshUpload(init: SSHUpload.() -> Unit): SSHUpload

An SSH Upload build step.

Example. Adds an SSH Upload build step with SCP transport protocol and custom timeout. Uploaded key authentication method is used.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        sshUpload {
            name = "My SSH Upload build step"
            transportProtocol = SSHUpload.TransportProtocol.SCP
            sourcePath = """
                dir/**/*.zip
                 *.zip => winFiles
                 unix/distro.tgz => linuxFiles
             """.trimIndent()
             targetUrl = "hostname:path/to/target/folder"
             timeout = 30
             authMethod = uploadedKey {
                 username = "username"
                 passphrase = "credentialsJSON:******"
                 key = "id_rsa"
             }
         }
Content copied to clipboard
    }
}

Example. Adds an SSH Upload build step with SFTP transport protocol, custom port and disabled timeout. Default private key authentication method is used.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        sshUpload {
            name = "My SSH Upload build step"
            transportProtocol = SSHUpload.TransportProtocol.SFTP
            sourcePath = """
                dir/**/*.zip
                 *.zip => winFiles
                 unix/distro.tgz => linuxFiles
             """.trimIndent()
             targetUrl = "hostname:path/to/target/folder"
             port = 2222
             timeout = 0
             authMethod = defaultPrivateKey {
                 username = "username"
                 passphrase = "credentialsJSON:******"
             }
         }
Content copied to clipboard
    }
}

Example. Adds an SSH Upload build step with SFTP transport protocol. Custom private key authentication method is used.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        sshUpload {
            name = "My SSH Upload build step"
            transportProtocol = SSHUpload.TransportProtocol.SFTP
            sourcePath = """
                dir/**/*.zip
                 *.zip => winFiles
                 unix/distro.tgz => linuxFiles
             """.trimIndent()
             targetUrl = "hostname:path/to/target/folder"
             authMethod = customPrivateKey {
                 keyFile = "path/to/key/file"
                 username = "username"
                 passphrase = "credentialsJSON:******"
             }
         }
Content copied to clipboard
    }
}

Example. Adds an SSH Upload build step with SCP transport protocol. Password authentication method is used.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        sshUpload {
            name = "My SSH Upload build step"
            transportProtocol = SSHUpload.TransportProtocol.SCP
            sourcePath = """
                dir/**/*.zip
                 *.zip => winFiles
                 unix/distro.tgz => linuxFiles
             """.trimIndent()
             targetUrl = "hostname:path/to/target/folder"
             authMethod = password {
                 username = "username"
                 password = "credentialsJSON:******"
             }
         }
Content copied to clipboard
    }
}

Example. Adds an SSH Upload build step with SCP transport protocol. SSH-Agent authentication method is used. This build step will run even if some previous build steps are failed and additional condition is met.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        sshUpload {
            name = "My SSH Upload build step"

            executionMode = BuildStep.ExecutionMode.RUN_ON_FAILURE
            conditions {
                equals("teamcity.build.branch", "release")
            }

            transportProtocol = SSHUpload.TransportProtocol.SCP
            sourcePath = """
                dir/**/*.zip
                 *.zip => winFiles
                 unix/distro.tgz => linuxFiles
             """.trimIndent()
             targetUrl = "hostname:path/to/target/folder"
             authMethod = sshAgent {
                 username = "username"
             }
         }
Content copied to clipboard
    }
}

Constructors

SSHUpload

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

SSHUpload

fun SSHUpload()

Types

AuthMethod

sealed class AuthMethod : CompoundParam<SSHUpload.AuthMethod>

TransportProtocol

enum TransportProtocol : Enum<SSHUpload.TransportProtocol>

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: SSHUpload.AuthMethod.CustomPrivateKey.() -> Unit = {}): SSHUpload.AuthMethod.CustomPrivateKey

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

defaultPrivateKey

fun defaultPrivateKey(init: SSHUpload.AuthMethod.DefaultPrivateKey.() -> Unit = {}): SSHUpload.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: SSHUpload.AuthMethod.Password.() -> Unit = {}): SSHUpload.AuthMethod.Password

Simple password authentication.

removeRawParam

fun removeRawParam(paramName: String)

sshAgent

fun sshAgent(init: SSHUpload.AuthMethod.SshAgent.() -> Unit = {}): SSHUpload.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: SSHUpload.AuthMethod.UploadedKey.() -> Unit = {}): SSHUpload.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.

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

val params: List<Parameter>

port

var port: <ERROR CLASS>

Optional. Default value: 22.

sourcePath

var sourcePath: <ERROR CLASS>

Newline- or comma-separated paths to files/directories to be deployed. Ant-style wildcards like dir/*/.zip and target directories like *.zip => winFiles,unix/distro.tgz => linuxFiles, where winFiles and linuxFiles are target directories, are supported.

targetUrl

var targetUrl: <ERROR CLASS>

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

timeout

var timeout: <ERROR CLASS>

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

transportProtocol

var transportProtocol: <ERROR CLASS>

An SSH transfer protocol to use.

type

var type: String

Build step type