4.13.8 ICMPエコー要求メッセージの送信
機能
指定されたWindowsまたはUNIXのサーバで，指定されたIPアドレスに対してICMPエコー要求を送信し，応答があるかどうかを戻り値で返します。
この部品では，次のサーバを前提とします。
・実行対象サーバ
部品を実行し，ICMPエコー要求の送信を行うサーバです。
・送信対象サーバ
ICMPエコー要求の送信対象のサーバです。
プロパティcommon.icmpSendAddressに送信対象サーバのIPアドレスまたはホスト名を指定して実行します。
複数のIPアドレス(ホスト名)が指定された場合，指定されたすべてのIPアドレス(ホスト名)に対してICMPエコー要求を送信します。
1つ以上のIPアドレス(ホスト名)からICMPエコーに対する応答があれば，戻り値「0」を返します。
どのIPアドレス(ホスト名)からもICMPエコーに対する応答がなければ，戻り値「0」以外を返します。
この部品が出力する「CommandExitCode:」の値を次に示します。
Windowsの場合：Win32_PingStatus class(MSDN)のStatusCode(ICMPエコーの結果)です。
UNIXの場合：pingコマンドの戻り値です。
利用場面
仮想サーバを起動したあとなどに，送信対象サーバと通信可能な状態であることを確認するため，ICMPエコー要求を送信する場合に利用できます。
前提条件
【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバ内前提製品】
なし。
【実行対象サーバの稼働OS】
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
(5) Red Hat Enterprise Linux Server 6 (32-bit x86)，Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
(8) CentOS 6 (64-bit x86_64)
(9) CentOS 7 (64-bit x86_64)
(10) CentOS 8 (64-bit x86_64)
(11) Oracle Linux 8 (64-bit x86_64)
【実行対象サーバの使用条件】
なし。
注意事項
(1)ICMPエコーのタイムアウト時間(common.icmpEchoTimeoutプロパティ)は利用している環境に応じて調整してください。
(2)送信対象サーバがWindowsの場合，送信対象サーバのファイアーウォールがICMP(ECHO)応答を許可している必要があります。
(3)この部品には，リミテッド・ブロードキャスト・アドレス(255.255.255.255)を使用しないでください。
(4)実行対象サーバがWindowsで，エージェントレス接続先設定の認証情報に設定したユーザーがビルトインAdministratorではない場合，以下のいずれかの条件を満たす必要があります。
・WindowsのUAC機能が完全に無効化されている。
・エージェントレス接続先の機器にて，エージェントレス接続先設定の認証情報に設定されたユーザーに対するRDPセッションが確立されている。
実行権限
Administrators 権限
バージョン
02.00.00
部品のタグ
Control OS,Windows,Linux
タスクログに表示される部品の名称
osSendIcmp
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
12 |
異常(ユーザーミス) プロパティ不正 |
|
25 |
異常(環境不正) 通信エラー |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
common.icmpSendAddress |
ICMPエコーの送信先 |
ICMPエコーを送信するIPアドレスまたはホスト名を指定します。複数のIPアドレス(ホスト名)に送信する場合には，コンマ区切りで指定します。 |
− |
入力 |
○ |
|
common.icmpEchoTimeout |
ICMPエコー要求のタイムアウト時間 |
ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。 |
4000 |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |