PowerShellOnTargetMachines@1 - ターゲット マシン v1 タスクの PowerShell
このタスクを使用して、リモート コンピューターで PowerShell スクリプトを実行します。
構文
# PowerShell on Target Machines v1
# Execute PowerShell scripts on remote machine(s).
- task: PowerShellOnTargetMachines@1
inputs:
EnvironmentName: # string. Required. Machines.
#AdminUserName: # string. Admin Login.
#AdminPassword: # string. Password.
#Protocol: # 'Http' | 'Https'. Protocol.
#TestCertificate: true # boolean. Optional. Use when Protocol = Https. Test Certificate. Default: true.
# Deployment
ScriptPath: # string. Required. PowerShell Script.
#ScriptArguments: # string. Script Arguments.
#InitializationScriptPath: # string. Initialization Script.
#SessionVariables: # string. Session Variables.
# Advanced Options
#RunPowershellInParallel: true # boolean. Run PowerShell in Parallel. Default: true.
#ResourceFilteringMethod: 'machineNames' # 'machineNames' | 'tags'. Select Machines By. Default: machineNames.
#MachineNames: # string. Filter Criteria.
入力
EnvironmentName
- マシン
string
. 必須です。
コンピューターの IP アドレスまたは FQDN のコンマ区切りの一覧とポートを指定します。 既定のポートは、選択したプロトコルに基づいています。
例: dbserver.fabrikam.com,dbserver_int.fabrikam.com:5986,192.168.12.34:5986
他のタスクの出力変数 (例: $(variableName)
) を指定することもできます。 HTTPS を使用している場合は、コンピューターの名前または IP が証明書の CN と一致している必要があります。
AdminUserName
- 管理者ログイン
string
.
ターゲット マシンの管理者ログインを指定します。
AdminPassword
- パスワード
string
.
ターゲット マシンの管理者パスワードを指定します。 としてビルド/リリース定義で定義 $(passwordVariable)
された変数が受け入れられます。 変数の型を として secret
マークして、セキュリティで保護することができます。
Protocol
- プロトコル
string
. 使用できる値: Http
、Https
。
コンピューターとの WinRM 接続に使用するプロトコルを指定します。 既定値は HTTPS
です。
TestCertificate
- テスト証明書
boolean
. 省略可能。 の場合は Protocol = Https
を使用します。 既定値: true
。
信頼された証明機関によるマシンの証明書の信頼性の検証をスキップします。 パラメーターは、WinRM HTTPS プロトコルに必要です。
ScriptPath
- PowerShell スクリプト
string
. 必須です。
ターゲット マシンまたは UNC パス上の PowerShell スクリプトの場所を指定します (例: C:\BudgetIT\Web\Deploy\Website.ps1
)。
ScriptArguments
- スクリプト引数
string
.
PowerShell スクリプトの引数を指定します。 序数パラメーターまたは名前付きパラメーター (test など -testParam
) を指定できます。
InitializationScriptPath
- 初期化スクリプト
string
.
ターゲット マシンまたは UNC パス上の DSC のデータ スクリプトの場所を指定します (例: C:\BudgetIT\Web\Deploy\WebsiteConfiguration.ps1
)。
SessionVariables
- セッション変数
string
.
両方のスクリプトの共通セッション変数を指定します。 たとえば、$variable = value
または $var1 = "value, 123"
です。
RunPowershellInParallel
- PowerShell を並列で実行する
boolean
. 既定値: true
。
に設定すると true
、ターゲット マシンで PowerShell スクリプトが並列に実行されます。
ResourceFilteringMethod
- 以下の条件でコンピューターを選択
string
. 使用できる値: machineNames
(マシン名)、 tags
。 既定値: machineNames
。
省略可能。 コンピューター名またはタグを指定して、マシンのサブセットを指定します。
MachineNames
- フィルター条件
string
.
この入力は、マシン グループまたは出力変数に対してのみ有効です。 これは、マシンのフラット な一覧ではまだサポートされていません。
や タグなどの dbserver.fabrikam.com, webserver.fabrikam.com, 192.168.12.34
マシンの一覧を指定します ( など Role:DB; OS:Win8.1
)。 複数のタグが指定されている場合、タスクは指定されたタグを持つすべてのマシンで実行されます。 既定では、すべてのマシンでタスクが実行されます。
タスク制御オプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。
出力変数
[なし] :
必要条件
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
実行日 | エージェント、DeploymentGroup |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | 1.104.0 以上 |
タスクのカテゴリ | 配置 |