TeamCity オンプレミス 2026.1 ヘルプ

SSH Exec

SSH Exec により、TeamCity は SSH を使用して任意のリモートコマンドを実行できます。

ここでは、すべてのランナーに共通の設定について説明します。この記事では、SSHExec ランナーの設定について詳しく説明します。

以下のフィールドはパラメーター参照をサポートしています。パーセント記号 (%) で囲まれたテキストは、TeamCity によってプロパティへの参照とみなされます。TeamCity がパーセント記号内のテキストをプロパティへの参照として扱わないようにするには、パーセント記号を 2 つ使用してエスケープします。たとえば、ビルドに %Y%m%d%H%M%S を渡す場合は、%%Y%%m%%d%%H%%M%%S に変更します。

オプション

説明

ステップ名

オプション TeamCity UI に表示されるビルドステップの名前。

ステップ ID

このビルドステップの ID。この構成のすべてのステップにわたって一意である必要があります。URL、REST API、DSL、サーバーへの HTTP リクエスト、TeamCity データディレクトリの構成設定で使用されます。

ステップ実行

デフォルトのビルド条件を変更したり、オプションでビルド条件を追加したりできます。

デプロイ対象

ターゲット

SSH サーバーのホスト名または IP アドレス。

ポート

オプションのポート。デフォルトはポート 22 です。

pty を使用

任意疑似ターミナル (pty) の種類を指定します。例: vt100

空の場合、pty は割り当てられません (デフォルト)。

デプロイクレデンシャル

認証方式

認証方法を選択します。

  • アップロードされたキー — プロジェクトにアップロードされたキーを使用します。詳細については、SSH 鍵管理を参照してください。

  • デフォルトの秘密鍵 — ~/.ssh/config 設定を使用して秘密鍵認証を実行します。設定ファイルが存在しない場合は、~/.ssh/id_rsa 秘密鍵ファイルを使用して秘密鍵認証を実行します。

  • カスタム秘密鍵 — 指定された秘密鍵ファイルとパスフレーズを使用して秘密鍵認証を実行します。

  • パスワード - 単純なパスワード認証を使用します。

  • SSH エージェント — 認証に SSH エージェントを使用します。SSH-Agent ビルド機能を有効にする必要があります。

SSH コマンド

コマンド

リモートシェルで実行する一連のコマンドを改行で区切って指定します。リモートシェルは、認証されたユーザーのホームディレクトリで起動されます。シェルの出力は、TeamCity ビルドログで利用できます。

サンプル

例: Web サイトの静的コンテンツを構築するビルドステップを作成する方法を検討してください。静的コンテンツを Web サーバーにアップロードした後、deploy.sh スクリプトを実行してサイトをリフレッシュする必要があります。ホームディレクトリ /jdoe を持つ SSH サーバー上で jdoe アカウントを使用し、SSH サーバーが認証に SSH キーを使用するように構成されているとします。

  1. 生成された SSH キーの手順に従って、プロジェクト内に新しい SSH キーペアを生成します。キーペアを WebServerKey と呼びます。

  2. WebServerKey キーペアから公開鍵をコピーします。

  3. SSH サーバー上の jdoe アカウントにログインし、SSH サーバープロバイダーの指示に従って、WebServerKey 公開鍵をこのアカウントに追加します。

  4. プロジェクトのビルド構成で、ビルドステップページに移動し、ビルドステップを追加をクリックします。

  5. 新しいビルドステップページで、SSH Exec ランナーを選択します。

  6. 新しいビルドステップ: SSH Exec ページで、次のようにフィールドに入力します。

    • ステップ名 — RunDeployScript を入力してください

    • ターゲット — ssh.example.com を入力

    • 認証方式 — アップロードされたキーを選択してください

    • ユーザー名 — jdoe と入力 (SSH サーバー上のアカウントのユーザー名)

    • キーの選択 — ドロップダウンリストから WebServerKey を選択します

    • コマンド — 次のシェルコマンドを入力します。

      echo 'running deploy.sh ...' /home/jdoe/scripts/deploy.sh

  7. 「保存」をクリックしてビルドステップを作成します。

2025 年 10 月 27 日
コンテナーデプロイヤ Docker

関連ページ：

ビルドステップの設定

ビルドステップは、CI/CD ワークフローの最小単位です。ビルドステップは、全体として実行される一連のアクションを定義します。ビルドステップは、ビルド構成とパイプラインジョブに属します。構成とパイプラインのビルドステップ：TeamCity は、.NET、Maven、NAnt、Xcode などの特定のビルドツール用に設計された幅広いビルドステップを提供します。現在、ビルド構成ではすべてのステップが利用可能です。バージョン 2025.07 で導入された

事前定義されたビルドパラメーターのリスト

TeamCity には、ビルド構成の設定やビルドスクリプトですぐに使用できる定義済みのビルドパラメーターが数十個用意されています。これらのパラメーターはすべて（事前定義された構成パラメーターを除く）ビルドプロセスに渡されます。これらのパラメーターにアクセスするために必要な手法は、ビルド型によって異なる場合があることに注意してください（たとえば、Gradle ビルドで TeamCity システムプロパティにアクセスする方法については、ビルドプロパティセクションを参照してください）。事前定義されたサ...

SSH 鍵管理

秘密 SSH キーを TeamCity プロジェクトにアップロードできます。アップロードされたキーは、VCS ルートの設定時および SSH エージェントビルド機能で使用できます。サポートされているキー形式：TeamCity は、PEM および OpenSSH 形式のキーをサポートします。異なる形式を使用するキーは変換する必要があります。例:PuTTY キージェネレーターを使用して、サポートされていない Putty 秘密鍵 () を PEM 形式に変換できます。これを行うには、変換 | OpenS...