TeamCity
 
2018.1
You are viewing the documentation for an earlier version of TeamCity.
  1. TeamCity Documentation
  2. Administrator's Guide
  3. Managing Projects and Build Configurations
  4. Creating and Editing Build Configurations
  5. Configuring Build Steps
  6. Deployers
  7. SSH Exec

SSH Exec

Last modified: 20 April 2023

SSH Exec enables TeamCity to execute arbitrary remote commands using SSH.

The settings common for all runners are described on a separate page; this page details the SSH Exec runner settings. The fields below support parameter references: any text between percentage signs (%) is considered a reference to a property by TeamCity. To prevent TeamCity from treating the text in the percentage signs as reference to a property, use two percentage signs to escape them: e.g. if you want to pass "%\Y%m%\d%H%\M%S" into the build, change it to "%\%Y%\%m%\%d%\%H%\%M%\%S"

warning

W hen strong cryptography is required by the server that receives the deployment, build agents need to have Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy installed on the jre.

Option

Description

Deployment Target

Target

Target should point to an SSH server location. Enter hostname or IP address.

Port

Optional. By default, port 22 is used.

Use pty

Optional. By default, a pty will not be allocated

Deployment Credentials

The settings in this section will vary depending on the selected authentication method.

Authentication method

Select an SSH authentication method.

  • Select an authentication method.

    • Uploaded key uses the key(s) uploaded to the project. See SSH Keys Management for details.

    • Default private key 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. No passphrases should be set.

    • Custom private key will try to perform private key authentication using the given public key file with given passphrase

    • Password - simple password authentication.

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

note

The current secure connection implementation accepts any certificate provided by the remote host. No trust checks are performed!

SSH Commands

Commands:

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.