5.5.2 Send ICMP echo request message (confirm no response)
Function
This plugin sends an ICMP echo request to a specified IP address in a specified Windows server, and returns a value depending on whether there is a response.
• Execution target server
These servers execute a plugin, and then transmit an ICMP echo request.
• Transmission destination server
These servers receive transmission of the ICMP echo request.
The IP address or host name of the transmission destination server is specified for execution in the property common.icmpSendAddress.
When multiple IP address (or host names) are specified, an ICMP echo request is sent to all specified IP addresses (or host names).
If there is no response to the ICMP echo from any IP address (or host name), a value of 0 is returned.
If there is a response to the ICMP echo from one or more IP addresses (or host names), a value other than 0 is returned.
The value of the CommandExitCode: that This plugin outputs is the StatusCode (ICMP echo result) of Win32_PingStatus class(MSDN).
Use situation
Transmission of an ICMP echo request can be used to confirm that an IP address you wish to use to deploy a virtual server is not already in use.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target system]/[Prerequisite product OS running on the execution target server], see the release notes.
[Required product in the System]
Job Management Partner 1/Automatic Operation 10-50 or later
[Required products on the execution target system]
None.
[Prerequisite product OS running 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]
None.
Cautions
(1) Adjust the ICMP echo timeout time (the common.icmpEchoTimeout property) according to the environment being used.
(2) Do not use the limited broadcast address (255.255.255.255) with this plugin.
Execution privilege
Version
01.12.00
Category
OperatingSystem/Windows/Basic
Plug-in name displayed in the task log
osSendIcmp2
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 |
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 |
|
common.checkIPAddressResult |
ICMP check result |
Stores the result of determining whether the specified IP address is not in use. |
-- |
Output |
O |