5.5.28 Get virtual server IP address
Function
Acquires the IP address of a specified virtual server in a VMware vSphere environment.
This plugin assumes the following servers:
• vCenter server
This is a server on which VMware vCenter Server is installed.
• vCenter control server (Execution target server)
This is a server on which VMware vSphere PowerCLI is installed.The plugin is sent to this server by JP1/AO and then is executed.
• Virtual server
This is a virtual server managed by the vCenter server and VMware vSphere ESXi.
The plugin sets the acquired IP address in the VMware.vmIPaddress output property. If multiple IP addresses are specified for the virtual server, the plugin outputs all the IP addresses delimited by the comma. Note that, if the total length of these IP addresses exceeds 1,024 characters, all characters after the 1024th character are discarded. The types of IP addresses below are obtained. The maximum length (1,024 characters) will be exceeded if, for example, 65 IPv4 addresses are obtained.
- IPv4 address (maximum length: 16 characters)
- IPv6 address (maximum length: 36 characters)
- IPv4 and IPv6 addresses set by the DHCP
Use situation
You use this plugin to determine the IP address of a virtual server so that you can issue an ICMP echo request to that virtual server.
The process of issuing an ICMP echo request involves using this plugin to acquire the virtual server's IP address and then using the obtained IP address as an input to the osSendIcmp plugin.
Prerequisites
For the latest support information about [Required products on the execution target system]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.
In addition, the following OS and products use abbreviations. For the abbreviations of OS and products, see the "Preface".
[Required products on the execution target system]
(1) Prerequisite product of vCenter Server
• VMware vCenter Server
(2) VMware vSphere ESXi that manages the virtual servers
(3) Prerequisite OS running in the virtual servers
The following OSs are supported, based on the required products for the vCenter server and the required products for the VMware vSphere ESXi/vCenter control server that manages the virtual server.
• Windows Server
• Red Hat Enterprise Linux Server
[Usage conditions for required products in the execution target system]
(1) VMware vSphere ESXi is managed by VMware vCenter Server.
(2) The virtual server is running.
(3) The virtual server name is unique among the vCenter servers.
(4) VMwareTools has been installed on the target virtual server.
[Required products on the execution target server]
• VMware PowerCLI
[Prerequisite product OS running in the execution target server]
• Windows Server
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
Role with read-only permission for the target virtual server or system administrator role
Version
02.11.00
Plug-in tags
Gather VM information,VMware vSphere
Plug-in name displayed in the task log
vsphereGetVMIPaddress
Return code
0: Normal
23: Error (invalid environment) Required environment is invalid
27: Error (check task logs for the nature of error)
30: Error (IP address acquisition error) IP address was not acquired
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 |
---|---|---|---|---|---|
VMware.vCenterServerName |
VMware vCenter server name |
Specify the host name or IP address of the VMware vCenter server. You cannot specify an IPv6 address. |
-- |
Input |
R |
VMware.userName |
User name for VMware vCenter Server connection |
Specify the user name to use when connecting to the VMware vCenter server. |
-- |
Input |
R |
VMware.password |
Password for VMware vCenter Server connection |
Specify the password to use when connecting to the VMware vCenter server. |
-- |
Input |
R |
VMware.portNumber |
Port number for VMware vCenter Server connection |
Specify the port number to use when connecting to the VMware vCenter server (specifically, the port number of the VMware vCenter server's Web service). If you omit this property, the default value of the VMware vCenter server applies. |
443 |
Input |
O |
VMware.protocol |
Protocol for VMware vCenter Server connection |
Specify the protocol to use when connecting to the VMware vCenter server. |
https |
Input |
R |
VMware.vmName |
Virtual server name |
Specify the name of the virtual server. This name is used to represent the virtual server in VMware vCenter server. It is not used as a host name by the OS. |
-- |
Input |
R |
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.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |
VMware.vmIPaddress |
Virtual server's IP address |
This property stores the IP address or IP addresses of the virtual server. If multiple IP addresses have been set for the virtual server, they are stored as a comma-separated list. |
-- |
Output |
O |