CopyFilesOverSSH@0 - SSH v0 タスク経由でファイルをコピーする

SSH 経由でリモート コンピューターにファイルをコピーするか、成果物をビルドします。

構文

# Copy files over SSH v0
# Copy files or build artifacts to a remote machine over SSH.
- task: CopyFilesOverSSH@0
  inputs:
    sshEndpoint: # string. Required. SSH service connection. 
    #sourceFolder: # string. Source folder. 
    contents: '**' # string. Required. Contents. Default: **.
    #targetFolder: # string. Target folder. 
  # Advanced
    #isWindowsOnTarget: false # boolean. Target machine running Windows. Default: false.
    #cleanTargetFolder: false # boolean. Clean target folder. Default: false.
    #cleanHiddenFilesInTarget: false # boolean. Optional. Use when cleanTargetFolder = true. Remove hidden files in target folder. Default: false.
    readyTimeout: '20000' # string. Required. SSH handshake timeout. Default: 20000.
    #overwrite: true # boolean. Overwrite. Default: true.
    #failOnEmptySource: false # boolean. Fail if no files found to copy. Default: false.
    #flattenFolders: false # boolean. Flatten folders. Default: false.

入力

sshEndpoint - SSH サービス接続
string. 必須です。

リモート コンピューターの接続の詳細を含む SSH サービス 接続の名前。

• SSH サービス接続を作成するには、リモート コンピューターのホスト名または IP アドレス、ポート番号、およびユーザー名が必要です。
• 認証には秘密キーとパスフレーズを指定する必要があります。

sourceFolder - ソース フォルダー
string.

リモート コンピューターにコピーするファイルのソース フォルダー。 空の場合、リポジトリ (ビルド) または成果物ディレクトリ (リリース) のルートが使用されます。これは です $(System.DefaultWorkingDirectory)。 ファイルがリポジトリにない場合は 、変数 を使用します。 例: $(Agent.BuildDirectory).

contents - 内容
string. 必須です。 既定値: **。

コピーの一部として含めるファイル パス。 複数行の ミニマッチ パターンをサポートします。 既定値は です **。これには、ソース フォルダーのすべてのファイル (サブフォルダーを含む) が含まれます。

• 例: **/*.*(jar|war) ソース フォルダーの下にあるすべての.jarファイルと .war ファイル (サブフォルダーを含む) が含まれます。
• 例: "** \n !**/*.xml" ソース フォルダーの下にあるすべてのファイル (サブフォルダーを含む) が含まれますが、xml ファイルは除外されます。

targetFolder - ターゲット フォルダー
string.

ファイルがコピーされるリモート コンピューター上のターゲット フォルダー。 例: /home/user/MySite. ユーザーのホーム ディレクトリを指定するチルダ (~) を付けます。

isWindowsOnTarget - Windows を実行しているターゲット コンピューター
boolean. 既定値: false。

ターゲット コンピューターが Windows を実行しているかどうかを確認します。

cleanTargetFolder - ターゲット フォルダーをクリーンアップする
boolean. 既定値: false。

コピーする前に、ターゲット フォルダー内のすべての既存のファイルとサブフォルダーを削除します。

cleanHiddenFilesInTarget - ターゲット フォルダー内の隠しファイルを削除する
boolean. 省略可能。 の場合は cleanTargetFolder = trueを使用します。 既定値: false。

に設定すると、 trueターゲット フォルダー内の隠しファイルが削除されます。

readyTimeout - SSH ハンドシェイクのタイムアウト
string. 必須です。 既定値: 20000。

SSH ハンドシェイクが完了するまで待機する時間 (ミリ秒単位)。

overwrite - 上書き
boolean. 既定値: true。

ターゲット フォルダー内およびターゲット フォルダーの下にある既存のファイルを置き換えます。

failOnEmptySource - コピーするファイルが見つからない場合は失敗する
boolean. 既定値: false。

コピーする一致するファイルがソース フォルダーの下に見つからない場合、失敗します。

flattenFolders - フォルダーをフラット化する
boolean. 既定値: false。

フォルダー構造をフラット化し、すべてのファイルをリモート コンピューター上の指定されたターゲット フォルダーにコピーします。

タスク制御オプション

すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。

出力変数

[なし] :

必要条件

要件	説明
パイプラインの種類	YAML、クラシック ビルド、クラシック リリース
実行日	エージェント、DeploymentGroup
確認要求	なし
Capabilities	このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。
コマンドの制限	このタスクは、次の コマンド制限を使用して実行されます。
設定可能な変数	このタスクには、 次の変数を設定するアクセス許可があります。変数の設定は無効です
エージェントのバージョン	2.206.1 以降
タスクのカテゴリ	デプロイ