5.4.2 Obtain the IP address of a virtual server
Function
This component obtains the IP address (IPv4) set in all the NICs in the virtual server in the Hyper-V environment.
The following servers are required for this component:
- Hyper-V server (Execution target server)
This is the server where Hyper-V is installed.
- Virtual server
This is a virtual server managed by Hyper-V.
The obtained IP addresses are stored in the hyperv.vmIPaddress property. When multiple IP addresses are set for the virtual server, they are separated by commas in the output file.
Note that if the total length of the IP addresses exceeds 1,024 characters, the IP addresses containing the 1,025th or subsequent characters are discarded. If 65 or more IPv4 IP addresses are set for all the NICs, the total length might exceed 1,024 characters.
Use situation
This can be used to check the IP address (IPv4) set in the virtual server or to issue an ICMP echo request to the virtual server.
The process for issuing an ICMP echo request is as follows: the IP address of the virtual server is obtained with this component, and then the obtained IP address is used as the input for the osSendIcmp component.
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]
JP1/Automatic Operation 11-00 or later
[Required products on the execution target server]
(1)Prerequisite product of Hyper-V Server
- Windows Server 2008 R2 Hyper-V
(2)Prerequisite OS running in the virtual servers
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
[Prerequisite product OS running in the execution target server]
- Windows Server 2008 R2 Standard/Enterprise/Datacenter
This does not apply to Server Core installation environments.
[Usage conditions for required products on the execution target server]
(1) The virtual server name must be unique within the Hyper-V server.
(2) The following Hyper-V Integration Service must be enabled in the target virtual server:
- Data Exchange
(3) The virtual server has been started.
Version
02.00.00
Plug-in tags
Gather VM information,Hyper-V 2008
Plug-in name displayed in the task log
hypervGetVMIPaddress
Return code
0: Normal
12: Error (Mistake by user) A property is invalid.
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check the task log for error details.)
30: Error (The virtual server became unavailable.) The virtual server became unavailable during processing.
31: Error (Failed to obtain information on the virtual server by data exchange (KVP)) The system failed to obtain information on the virtual server by data exchange (KVP).
41: Error (An error was detected in the component.) A property was not entered. (An error was detected in the component 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 |
|
hyperv.vmName |
Virtual server name |
Specifies the name of the virtual server. (This is the name of the virtual server as it is displayed in Hyper-V. This is not the host name in the OS.) |
-- |
Input |
R |
|
hyperv.waitTime |
Wait processing time before starting to obtain IP address |
Specifies the wait processing time, in seconds, before starting to obtain the IP address. |
0 |
Input |
R |
|
hyperv.vmIPaddress |
Virtual server IP address |
Stores the virtual server IP address. When multiple IP addresses are set for the virtual server, they are separated by commas in the output file. |
-- |
Output |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |