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.
#concurrentUploads: '10' # string. Number of concurrent uploads when copying files. Default: 10.
#delayBetweenUploads: '50' # string. Delay between queueing uploads (in milliseconds). Default: 50.
# 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.
# 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.
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.
入力
SSH サービス接続を sshEndpoint
- する
string
. 必須。
リモート コンピューターの接続の詳細を含む SSH サービス接続 の名前。
- SSH サービス接続を作成するには、リモート コンピューターのホスト名または IP アドレス、ポート番号、およびユーザー名が必要です。
- 認証には秘密キーとパスフレーズを指定する必要があります。
ソース フォルダーの sourceFolder
-
string
.
リモート コンピューターにコピーするファイルのソース フォルダー。 空の場合、リポジトリ (ビルド) または成果物ディレクトリ (リリース) のルートが使用されます。これは $(System.DefaultWorkingDirectory)
です。 ファイル リポジトリにない場合は、 変数を使用します。 例: $(Agent.BuildDirectory)
。
contents
-
コンテンツ
string
. 必須。 既定値: **
.
コピーの一部として含めるファイル パス。
ミニマッチ パターンの複数行をサポートします。 既定値は **
で、ソース フォルダーの下にあるすべてのファイル (サブフォルダーを含む) が含まれます。
- 例:
**/*.*(jar|war)
には、ソース フォルダーの下にあるすべての.jarファイルと .war ファイル (サブフォルダーを含む) が含まれます。 - 例:
"** \n !**/*.xml"
ソース フォルダーの下にあるすべてのファイル (サブフォルダーを含む) が含まれますが、xml ファイルは除外されます。
ターゲット フォルダーの targetFolder
-
string
.
ファイルがコピーされるリモート コンピューター上のターゲット フォルダー。 例: /home/user/MySite
。 ユーザーのホーム ディレクトリを指定するチルダ (~)
を先頭に付けます。
Windowsを実行しているターゲット コンピューターの isWindowsOnTarget
-
boolean
. 既定値: false
.
ターゲット コンピューターが Windows を実行しているかどうかを確認します。
ターゲット フォルダーのクリーンアップを cleanTargetFolder
- する
boolean
. 既定値: false
.
コピーする前に、ターゲット フォルダー内のすべての既存のファイルとサブフォルダーを削除します。
cleanHiddenFilesInTarget
-
ターゲット フォルダー の隠しファイルを削除する
boolean
. 任意
cleanTargetFolder = true
するときに使用します。 既定値: false
.
true
に設定すると、ターゲット フォルダー内の非表示のファイルが削除されます。
SSH ハンドシェイク タイムアウトの readyTimeout
-
string
. 必須。 既定値: 20000
.
SSH ハンドシェイクが完了するまでの待機時間 (ミリ秒)。
overwrite
-
上書き
boolean
. 既定値: true
.
ターゲット フォルダー内およびターゲット フォルダーの下にある既存のファイルを置き換えます。
failOnEmptySource
-
コピーするファイルが見つからない場合は失敗
boolean
. 既定値: false
.
コピーする一致するファイルがソース フォルダーの下に見つからない場合、失敗します。
flattenFolders
-
フォルダー をフラット化する
boolean
. 既定値: false
.
フォルダー構造をフラット化し、すべてのファイルをリモート コンピューター上の指定されたターゲット フォルダーにコピーします。
concurrentUploads
-
ファイルをコピーするときの同時アップロードの数
string
. 既定値: 10
.
ファイルをコピーするときの同時アップロードの数。 既定値は 10 です。
delayBetweenUploads
-
アップロードをキューに登録するまでの遅延 (ミリ秒単位)
string
. 既定値: 50
.
アップロードをキューに登録するまでの遅延 (ミリ秒単位)。 既定値は 50 です。
タスク コントロールのオプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「コントロール オプションと一般的なタスク プロパティを参照してください。
出力変数
なし。
必要条件
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
実行日 | エージェント、DeploymentGroup |
の需要 | なし |
機能の | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | このタスクは、次の コマンド制限: restricted を使用して実行されます。 |
設定可能な変数 | このタスクには、次の変数 設定アクセス許可があります。変数の設定は無効です |
エージェントのバージョン | 2.206.1 以上 |
タスク カテゴリ | 展開 |
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
実行日 | エージェント、DeploymentGroup |
の需要 | なし |
機能の | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | このタスクは、次の コマンド制限: restricted を使用して実行されます。 |
設定可能な変数 | このタスクには、次の変数 設定アクセス許可があります。変数の設定は無効です |
エージェントのバージョン | 2.182.1 以上 |
タスク カテゴリ | 展開 |