5.6.3 Obtain IP Address of Virtual Server
Function
This plug-in is used to obtain IP (IPv4) addresses from all NICs on a virtual server in a Hyper-V environment.
This plug-in requires the following servers:
- Hyper-V server (execution-target server)
A server on which Hyper-V is installed
- Virtual server
A virtual server managed by Hyper-V
The obtained IP addresses are stored in the property hyperv.vmIPaddress in comma-separated format.
Note that, if the total length of these IP addresses exceeds 1,024 characters, all characters after the 1024th character are discarded. If the number of IPv4 addresses set on all NICs exceeds 64 addresses, the total length of these addresses might exceed 1,024 characters.
Use situation
This plug-in can be used to check the IP address (IPv4) set for a virtual server or to issue an ICMP echo request to a virtual server.
When an ICMP echo request is issued, the virtual server IP address obtained by this plug-in is used as input for the plug-in osSendIcmp.
Prerequisites
For the most recent support statuses for the prerequisite products in the system, the prerequisite products on the execution-target server, and the OSs for the prerequisite products on the execution-target server, see the Release Notes.
Prerequisite products in the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products on the execution-target server:
(1) Prerequisite products on the Hyper-V server
- Windows Server 2016 Hyper-V
(2) Prerequisite OS for the virtual server
- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
- Windows Server 2016 Standard/Datacenter
Environments where Server Core/Nano Server is installed are excluded.
OSs for the prerequisite products on the execution-target server:
- Windows Server 2016 Standard/Datacenter
Environments where Server Core/Nano Server is installed are excluded.
Conditions for using the prerequisite products on the execution-target server:
(1) Each virtual server name must be unique within a single Hyper-V server.
(2) The following Hyper-V Integration Service must be enabled on the target virtual server:
- Data Exchange
(3) The virtual server must be running.
Version
02.12.00
Plug-in tags
Gather VM information,Hyper-V 2016
Plug-in name displayed in the task log
hyperv2016GetVMIPaddress
Return code
0: Normal
23: Error (Invalid environment) The environment requirements are not met.
27: Error (Check with the task log about the error detail) Unidentified error
41: Error (An error has been detected in the component) Property not entered (An error has been 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.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 |
-- |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
-- |