TeamCity オンプレミス 2026.1 ヘルプ

SSH アップロード

SSH アップロードビルドランナーでは、SSH 経由でファイルまたはディレクトリをアップロードできます(SCP または SFTP プロトコルを使用)。

すべてのランナーに共通の設定は、ビルドステップの設定で説明されています。このページでは、SSH Deployer の設定について詳しく説明しています。

以下のフィールドはパラメーター参照をサポートしています。パーセント記号 (%) で囲まれたテキストは、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 サーバーの場所。次の形式で指定します。

{hostname|IP_address}[:targer_dir[/sub_path]]

ここで、target_dir は絶対的または相対的であり、sub_path は任意の深さを有することができます。

転送プロトコル

SSH を介してデータを転送するためのプロトコルを選択します。利用可能なオプションは以下のとおりです。SCP および SFTP

ポート

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

タイムアウト

オプションの接続のタイムアウト (秒単位)。デフォルトは 0 です。

デプロイクレデンシャル

認証方式

認証方法を選択します。

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

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

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

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

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

デプロイソース

ソースへのパス

デプロイソースを、ファイルまたはディレクトリへのパスの改行またはコンマ区切りリストとして指定します。

このフィールドは Ant スタイルのワイルドカードパターン (例: dir/**/*.zip) をサポートします。
file => directory パターンを使用して作成するターゲットディレクトリを指定することもできます (たとえば、*.zip => winFiles,unix/distro.tgz => linuxFileswinFiles ディレクトリと linuxFiles ディレクトリを作成し、宣言されたファイルをそれぞれその中に配置します)。

サンプル

例: Java パッケージを SSH サーバー (ssh.example.com ホスト上) にアップロードするために SSH アップロードビルドステップを追加する必要がある場合を考えてみましょう。ホームディレクトリ /jdoe を持つ SSH サーバー上で jdoe アカウントを使用し、SSH サーバーが認証に SSH キーを使用するように構成されているとします。

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

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

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

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

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

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

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

    • ターゲットssh.example.com:/jdoe を入力

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

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

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

    • ソースへのパス — 次のパスを入力します。

      ch-simple/simple/target/*.jar => packages
  7. 保存」をクリックしてビルドステップを作成します。

2025 年 10 月 27 日

関連ページ:

ビルドステップの設定

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

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

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

SSH 鍵管理

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