例l - PowerShell アクションスクリプト

PowerShell アクションスクリプトには、実行に成功するために利用できる 2 つのインスタンス化オブジェクトがあります。

• コンテキスト。IScriptContext インターフェイスの実装。このオブジェクトを使用するとランタイム変数にアクセスでき、結果をクライアントに返すメカニズムも提供します。便利なメソッドの一部を以下に示します。
  • object GetProperty(string propertyName) - コンテキスト変数値を名前で取得できます。
  • void SetResult(int resultCode, string resultText) - 成功を示す値をスクリプトで設定できます。通常、0 は成功、1 は失敗です。2 番目の引数を使用すると、出力としてテキスト文字列をスクリプトで指定できます。
• ロガー。ILog インターフェイスの実装。このオブジェクトは、C# アプリケーションで利用可能なメソッドと同じメソッドを提供します。便利なメソッドの一部を以下に示します。
  • void Error(string message) - メッセージを含んでいるエラー固有のログエントリを作成します。
  • void Information(string message) - メッセージを含んでいる情報固有のログエントリを作成します。
  • void WriteLine(string message) - メッセージを含んでいる汎用ログエントリを作成します。

コンテキスト変数

PowerShell アクションスクリプトに使用できるコンテキスト変数は次のとおりです。

• DeviceID
• DisplayName
• Address
• NetworkName
• Timeout
• TriggerCondition
• ActionName
• ActionTypeID

パーセント変数

PowerShell アクションスクリプトに使用できるパーセント変数のリストについては、「パーセント変数」を参照してください。

重要 PowerShell スクリプトの文字列リテラルの一部にパーセント変数を使用する場合は、単一引用符 (' ') ではなく二重引用符 (" ") を使用して文字列リテラルを囲んでください。たとえば、$Message = "%Device.DisplayName changed state" のようになります。

[スクリプトタイムアウト]

スクリプトタイムアウト値を秒単位で設定できます。タイムアウト値が終了する前にスクリプトの実行が終了しなかった場合、スクリプトは中止されます。

最小:1

最大:60

デフォルト:10

スクリプトの例

例 1:

#

# This example plays a sound file

#

# Point to an existing wav file

$wavFile = "C:\temp\Sound1.wav"

# Create a .NET SoundPlayer object

$sound = new-Object System.Media.SoundPlayer;

$sound.SoundLocation=$wavFile;

# Play the file

$sound.Play();

# Report the action results.The text will also be logged

$Context.SetResult($result, "Sound action completed")

例 2:

#

# This example sends an email

#

# Change this value to the recipient

$to = "target_email"

# Change this value to the sender

$from = "source_email"

# This line creates a .NET object for the message

$message = New-Object system.Net.Mail.MailMessage $from, $to

$message.Subject = "Notification from " + $Context.GetProperty("DisplayName")

$message.Body = "Address is down:" + $Context.GetProperty("Address")

# Name the mail server

$server = "alpha.ipswitch.com"

# Create a .NET object to represent the mail client

$client = New-Object System.Net.Mail.SmtpClient $server

$client.UseDefaultCredentials = $true

$result = 1

# Send the message.If no exception is thrown, consider it a success

try {

$client.Send($message);

$result = 0

}

catch {

$result = 1

}

# Report the action results.The text will also be logged

$Context.SetResult($result, "Email Action Completed")

参照 PowerShell アクションの追加および編集