4.14.7　ICMPエコー要求メッセージの送信 (無応答確認)

機能

指定されたWindowsのサーバにおいて，指定されたIPアドレスに対してICMPエコー要求を送信し，応答があるかどうかを戻り値で返します。

・実行対象サーバ

　部品を実行し，ICMPエコー要求の送信を実施するサーバです。

・送信対象サーバ

　ICMPエコー要求を送信する対象のサーバです。

プロパティcommon.icmpSendAddressに送信対象サーバのIPアドレスまたはホスト名を指定して実行します。

複数のIPアドレス(ホスト名)が指定された場合，指定された全てのIPアドレス(ホスト名)に対してICMPエコー要求を送信します。

どのIPアドレス(ホスト名)からもICMPエコーに対する応答がなければ，戻り値「0」を返します。

1つ以上のIPアドレス(ホスト名)からICMPエコーに対する応答があれば，戻り値「0」以外を返します。

なお，この部品が出力する「CommandExitCode:」の値はWin32_PingStatus class(MSDN)のStatusCode(ICMPエコーの結果)です。

利用場面

仮想サーバのデプロイで使用するIPアドレスが使用されていないことを確認するため，ICMPエコー要求を送信する場合に利用できます。

前提条件

【システム内前提製品】/【実行対象サーバ内前提製品】/【実行対象サーバ内前提製品の稼働OS】の最新のサポート状況については，リリースノートを参照してください。

【システム内前提製品】

　JP1/Automatic Operation 10-12以降

【実行対象サーバ内前提製品】

なし。

【実行対象サーバ内前提製品の稼働OS】

　(1) Windows Server 2003, Standard Edition/Enterprise Edition (x86/x64) SP1以降，Windows Server 2003 R2，Standard Edition/Enterprise Edition (x86/x64)

　(2) Windows Server 2008 Standard/Enterprise (x86/x64)，Windows Server 2008 R2 Standard/Enterprise/Datacenter

　(3) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter

【実行対象サーバの使用条件】

なし。

注意事項

(1)ICMPエコーのタイムアウト時間(common.icmpEchoTimeoutプロパティ)は利用している環境に応じて調整してください。

(2)この部品には，リミテッド・ブロードキャスト・アドレス(255.255.255.255)を使用しないでください。

バージョン

01.12.00

カテゴリ

OperatingSystem/Windows/Basic

タスクログに表示される部品の名称

osSendIcmp2

戻り値

戻り値	説明
0	正常
12	異常(ユーザーミス) プロパティ不正
25	異常(環境不正) 通信エラー
27	異常(エラー内容はタスクログで確認)
41	異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知)

プロパティ一覧

プロパティ一覧を次の表に示します。

プロパティキー	プロパティ名	説明	デフォルト値	入出力種別	必須区分
plugin.destinationHost	実行対象サーバのホスト名	この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。	−	入力	○
common.icmpSendAddress	ICMPエコーの送信先	ICMPエコーを送信するIPアドレスまたはホスト名を指定します。複数のIPアドレス（ホスト名）に送信する場合には，コンマ区切りで指定します。	−	入力	○
common.icmpEchoTimeout	ICMPエコー要求のタイムアウト時間	ICMPエコー要求に対する応答を待つ時間をミリ秒単位で指定します。	4000	入力	○
common.returnValue	部品の戻り値	この部品の戻り値が格納されます。	−	出力	△
common.checkIPAddressResult	ICMP確認のチェック結果	指定されたIPアドレスが使用されていないかどうか確認した結果を格納します。	−	出力	△