パーセント変数を使用して、アクションのメッセージや特定の設定内容をカスタマイズできます。

注: WhatsUp Gold アラートセンター固有の変数の表については、「 アラートセンターパーセント変数 」のトピックを参照してください。

パーセント変数を使用する際の重要なガイドライン

  • WhatsUp Gold のすべてのパーセント変数は大文字と小文字が区別されます。
  • パーセント変数でのスペースの使用はサポートされておらず、推奨されません。
  • スクリプトテキスト ( アクティブスクリプトアクション など) でパーセント変数を使用すると、特殊文字を含むテキストまで解釈に含まれてしまう場合があります。特殊文字には、'、"、%、[改行] などがあります。エスケープしないと、これらのリテラルが原因で予期しない構文エラーや解析エラーが発生し、スクリプトが中断される可能性があります。
  • アクティブモニタ変数は、アクションがデバイス全体ではなくアクティブモニタに直接関連付けられている場合にのみ使用されます。
  • PowerShell スクリプトの文字列リテラルの一部にパーセント変数を使用する場合は、単一引用符 (' ') ではなく二重引用符 (" ") を使用して文字列リテラルを囲んでください。例: $Message = "%Device.DisplayName changed state"

一部のアクションには設定ダイアログ内に個別のデータ入力フィールドがあり、使用するパーセント変数のリストをサポートするだけでなく、提供しています。

アクティブモニタ変数

説明

%ActiveMonitor.Argument

SNMP インスタンス番号。アクションがアクティブモニタに直接関連付けられていて、デバイス全体に関連付けられていない場合のみに使用します。

%ActiveMonitor.Comment

モニタに関連したコメントに対応する文字列値。アクションがアクティブモニタに直接関連付けられていて、デバイス全体に関連付けられていない場合のみに使用します。インターフェイスアクティブモニタの場合、検出ではこのパーセント変数を使用してインターフェイスの説明を自動入力します。

%ActiveMonitor.Name

アクションを発行するアクティブモニタの名前。アクションがアクティブモニタに直接関連付けられていて、デバイス全体に関連付けられていない場合のみに使用します。

%ActiveMonitor.NetworkInterfaceAddress

ネットワークインターフェイスの IP アドレス。アクションがアクティブモニタに直接関連付けられていて、デバイス全体に関連付けられていない場合のみに使用します。

%ActiveMonitor.Payload

WMI、Exchange、SQL、SNMP、またはアクティブスクリプトのアクティブモニタによって返されるペイロード。アクションがアクティブモニタに直接関連付けられていて、デバイス全体に関連付けられていない場合のみに使用します。

アクティブスクリプトのアクティブモニタの場合、ペイロードはスクリプト内の SetResult() メソッドに渡されるテキストです。

%ActiveMonitor.State

「Down at least 5 min (少なくとも 5 分間停止)」などのモニタの現在のステータス。アクションがアクティブモニタに直接関連付けられていて、デバイス全体に関連付けられていない場合のみに使用します。

デバイス変数

説明

%Device.ActiveMonitorDownNames

停止中のサービスのリスト。略名がある場合はそれを使用します。

%Device.ActiveMonitorDownNamesCSV

停止中のアクティブモニタ名をコンマで区切ったリスト。

%Device.ActiveMonitorUpNames

デバイス上の稼働中で監視対象のすべてのサービスの完全サービス名。

%Device.Address

IP アドレス ([デバイスのプロパティ] から)。

%Device.Attribute.[属性名]

連絡先名など、デバイスで使用できる SNMP 情報から属性を返します。属性を指定するには、変数の末尾にカテゴリ名 (以下にリストするもの) を追加します。たとえば、 %Device.Attribute.Contact は連絡先名を返します。

デフォルトのカテゴリは次のとおりです。

  • * 。すべての属性を返します。
  • Info1 。v8 からのアップグレードパス
  • Info2 。v8 からのアップグレードパス
  • [連絡先] 。SNMP からの連絡先情報
  • [場所] 。SNMP からの場所の情報
  • [説明] 。SNMP からの説明の情報
  • [カスタム] 。カスタム属性を作成した場合、パーセント変数でそのカスタム属性の名前を使用できます。

例:

%Device.Attribute.Phone %Device.Attribute.RackPosition

ヒント: 解析エラーを回避するために、組み込みのパーセント変数の末尾 (つまり、属性名の後) に必ずスペースまたは改行を入れてください。

%Device.DatabaseID

デバイスのデータベース ID を返します。

%Device.DisplayName

表示名 ([デバイスのプロパティ] の [一般] から)

%Device.HostName

ホスト名 ([デバイスのプロパティ] の [一般] から)

%Device.Notes

メモ。([デバイスのプロパティ] の [メモ] から)

%Device.Role

デバイスのプロパティインターフェイスに表示されるプライマリデバイスのロール。

%Device.RoleGUID

デバイスに割り当てられたプライマリロールのグローバルで一意の識別子。

%Device.SNMPOid

SNMP オブジェクト識別子。

%Device.State

デバイスステータスの説明 (「Down at least 2 min (少なくとも 2 分間停止)」や「Up at least 5 min (少なくとも 5 分間稼働)」など)

%Device.BestState

デバイスの「最良」な状態を含むデバイスステータスの説明。たとえば、モニタの不具合のため、デバイスが [稼働] 状態に一切ならなかった場合、最良な状態として [停止] が考えられます。

%Device.WorstState

デバイスの「最低」な状態を含むデバイスステータスの説明。たとえば、モニタの不具合のため、デバイスが [停止] 状態に一切ならなかった場合、最低の状態として [稼働] が考えられます。

%Device.Status

デバイスの状態 ID の後にアクティブモニタの名前を示します。

例:

10 | DNS。

デバイスの状態 ID の値:

0 = Not Started, 1 = Paused, 2 = Canceled, 3 = Running, 4 = Complete, 5 = Resolving Hostname, 6 = Looking for Type, 7 = Scanning for SNMP Credentials, 8 = Scanning for Windows Credentials, 9 = Device Detail Scan, 10 = Scanning Custom Monitors, 12 = Scanning Custom Monitors, 13 = Device VMWare Host Scan, 14 = Scanning SSH Credentials, 15 = Layer 2 Scan, 16 = Computing Layer 2 Topology, 17 = Wireless Scan, 18 = Scanning Network Interfaces, 19 = Checking for Duplicate Devices, 21 = Scanning for Known Addresses

%Device.ManualMaintenanceReason

[保守] ステータスにデバイスを指定する理由として入力するカスタム文字列。

%Device.Type

デバイスの種類 ([デバイスのプロパティ] の [一般] から)

パッシブモニタ変数

説明

%PassiveMonitor.DisplayName

パッシブモニタライブラリに表示されるモニタ名。

%PassiveMonitor.LoggedText

詳細なイベント説明(SNMP トラップ - SNMP トラップテキスト全体を返します。) (Windows ログエントリ - Windows イベントログエントリに含まれる情報を返します。) (Syslog エントリ - Syslog メッセージに含まれるテキストを返します。)

%PassiveMonitor.Payload.*

パッシブモニタによって生成される ペイロード 。

%PassiveMonitor.Payload.EventType

パッシブモニタの種類 (Syslog、Windows イベント、または SNMP トラップ)

%PassiveMonitor.Payload.LogicalSource

デバイスの論理 IP アドレスを示します。

%PassiveMonitor.Payload.PhysicalSource

デバイスの物理 IP アドレスを示します。

システム変数

説明

%System.Date

システムの日付を表示します (WhatsUp Gold サーバーが実行されているオペレーティングシステムと同じ形式を使用します)。

%System.DisplayNamesDownDevices

停止中のモニタを持つデバイスの表示名。

%System.DisplayNamesDownMonitors

デバイスおよびそのデバイスで停止している各モニタの名前を示します。応答の形式は、'デバイス名':'モニタ 1','モニタ 2','...' です。

例: ARNOR:FTP, HTTPS, Ping

%System.DisplayNamesUpDevices

稼働中のデバイスの表示名

%System.DisplayNamesUpMonitors

デバイスおよびそのデバイスで稼働している各モニタの名前を示します。応答の形式は、'デバイス名':'モニタ 1','モニタ 2','...' です。

例: ARNOR:FTP, HTTPS, Ping

%System.InstallDir

WhatsUp Gold がインストールされているディレクトリを表示します。

%System.NumberofDownDevices

ネットワーク上の停止中のデバイスの数

%System.NumberOfDownMonitors

ネットワーク上の停止中のモニタの数を示します。

%System.NumberofUpDevices

ネットワーク上の稼働中のデバイスの数

%System.NumberOfUpMonitors

ネットワーク上の稼働中のモニタの数を示します。

%System.Time

現在のシステムの時刻。形式は hh:mm:ss です。