5.5.1 Send ICMP echo request message
Function
Sends an ICMP echo request to a specified IP address on a specified Windows server and returns a value indicating whether there was a response.
• Execution target server
This server executes the plugin and sends an ICMP echo request
• Transmission destination server
This is the server to which the ICMP echo request is sent.
Execute this plugin with the IP address or host name of the transmission target server specified in the common.icmpSendAddress property.
If multiple IP addresses (host names) are specified, the plugin sends the ICMP echo request to all the specified IP addresses (host names).
If there is a response from at least one of the IP addresses (host names), the plugin returns 0.
If there is no response from any of the IP addresses (host names), the plugin returns a nonzero value.
Note that the value of CommandExitCode: output by this plugin is the value of StatusCode (ICMP echo results) of Win32_PingStatus class(MSDN).
Use situation
After you have started a virtual server, you use this plugin to send an ICMP echo request to verify that communication with that transmission destination server is available.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.
[Required product in the System]
Job Management Partner 1/Automatic Operation 10-00 or later
[Required products on the execution target server]
(1) Windows Server 2003, Standard Edition/Enterprise Edition (x86/x64) SP1 or later,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
[Usage conditions for required products on the execution target server]
(1) The Windows Firewall/Internet Connection Sharing (ICS) service has started.
Cautions
(1) Adjust the ICMP echo timeout value (common.icmpEchoTimeout property) according to the environment in use.
(2) If the OS of the transmission destination server is Windows, the transmission destination server's firewall must permit ICMP(ECHO) responses.
(3) Do not use a limited broadcast address (255.255.255.255) for this plugin.
Version
01.00.04
Category
OperatingSystem/Windows/Basic
Plug-in name displayed in the task log
osSendIcmp
Return code
0: Normal
12: Error (user error) Invalid property
25: Error (invalid environment) Communication error
27: Error (check task logs for the nature of error)
41: Error (error detected in plugin) Missing property (error detected in plugin script)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
|
common.icmpSendAddress |
ICMP echo destination |
Specify a comma-separated list of IP addresses or host names to which an ICMP echo request will be sent. |
-- |
Input |
R |
|
common.icmpEchoTimeout |
Timeout value for response to an ICMP echo request (ms) |
Specify (in ms) the timeout value for a response to an ICMP echo request. |
4000 |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |