Microsoft Windows PowerShell Connector リファレンス

Microsoft Windows PowerShell Connector v2.1

互換性と解決された問題に関する情報は、​「Microsoft Powershell コネクタリリースノート」​を参照してください。

設定

パラメーター

名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

  • Linux 設定

  • Windows Configuration (Windows 設定)

この設定に指定できる接続種別。

x

Expiration Policy (有効期限ポリシー)

ExpirationPolicy

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。ランタイムによって適切と判断されたときに、インスタンスがパージされます。

接続種別

Linux 設定

パラメーター

名前 型 説明 デフォルト値 必須

IPAddress

String (文字列)

セッションの初期化に使用するホスト。

x

UserName

String (文字列)

セッションの初期化に使用するユーザー名。この項目の値には ​username​ または ​username@domain​ などを指定できます。

x

Password (パスワード)

String (文字列)

ユーザーの認証に使用するパスワード。

x

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Windows Configuration (Windows 設定)

パラメーター

名前 型 説明 デフォルト値 必須

IPAddress

String (文字列)

セッションの初期化に使用するホスト。

x

UserName

String (文字列)

セッションの初期化に使用するユーザー名。この項目の値には ​username​ または ​username@domain​ などを指定できます。

x

Password (パスワード)

String (文字列)

ユーザーの認証に使用するパスワード。

x

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Execute Command

<powershell:execute-command>

この操作は、マシン上でコマンドを実行します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Command (コマンド)

String (文字列)

クライアントマシン上で実行するコマンド。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型 String (文字列)

次の設定の場合

  • config

スロー

  • POWERSHELL:RETRY_EXHAUSTED

  • POWERSHELL:CONNECTIVITY

Execute Script File

<powershell:execute-script-file>

この操作は、スクリプトファイルを実行します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

File Content (ファイルのコンテンツ)

Binary (バイナリ)

スクリプトを含むファイル。

#[payload]

パラメーター

Object (オブジェクト)

スクリプトのパラメーター。

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の出力は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型 String (文字列)

次の設定の場合

  • config

スロー

  • POWERSHELL:RETRY_EXHAUSTED

  • POWERSHELL:CONNECTIVITY

Execute Command (exception handling enabled)

<powershell:execute-command-exception-handling-enabled>

この操作では、マシン上でコマンドを実行し、実行に関連した例外をスローします (存在する場合)。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Command (コマンド)

String (文字列)

クライアントマシン上で実行するコマンド。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型 String (文字列)

次の設定の場合

  • config

スロー

  • POWERSHELL:RETRY_EXHAUSTED

  • POWERSHELL:CONNECTIVITY

  • POWERSHELL:EXECUTION_EXCEPTION

Execute Script File (exception handling enabled)

<powershell:execute-script-file-exception-handling-enabled>

この操作では、対象マシン上でスクリプトを実行し、実行に関連した例外をスローします (存在する場合)。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

File Content (ファイルのコンテンツ)

Binary (バイナリ)

スクリプトを含むファイル。

#[payload]

パラメーター

Object (オブジェクト)

スクリプトのパラメーター。

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の出力は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

接続エラーが発生した場合の再試行戦略。

出力

型 String (文字列)

次の設定の場合

  • config

スロー

  • POWERSHELL:RETRY_EXHAUSTED

  • POWERSHELL:CONNECTIVITY

  • POWERSHELL:EXECUTION_EXCEPTION

型

Reconnection (再接続)

項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

  • reconnect (再接続)

  • reconnect-forever (繰り返し再接続)

使用する再接続戦略。

Reconnect (再接続)

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Reconnect Forever (繰り返し再接続)

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Expiration Policy (有効期限ポリシー)

項目 型 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位。