5.5.48 Get list of virtual server information
Function
This plugin outputs to a file, in CSV format, a list of information of virtual servers under the management of a vCenter server.
To focus the list exclusively on virtual servers under the management of a specified ESX server, specify the ESX server name.
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 transferred from JP1/AO to this server and then is executed.
• Virtual server
This is a virtual server managed by the vCenter server and VMware vSphere ESXi.
Use situation
A list of virtual servers under the management of the vCenter server, specified when new virtual servers are added or when operations are performed on existing virtual servers, can be output to a CSV format file.
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 on 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 of 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 being managed by VMware vCenter Server.
(2) Condition for configuration on VMware vSphere ESXi
• Port group has been set.
(3) Conditions for virtual servers
• VMware Tools is installed.
• NIC has been configured.
• There is no duplication of the virtual servers under management of a single VMware vCenter Server.
[Required products on the execution target server]
• VMware PowerCLI
[Prerequisite product OS running on the execution target server]
• Windows Server
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
System administrator role
Version
02.11.00
Plug-in tags
Gather VM information,VMware vSphere
Plug-in name displayed in the task log
vsphereOutVmSpec
Return code
0: Normal
12: Error (user error) Invalid property
23: Error (invalid environment) Required environment is invalid
27: Error (check task logs for the nature of error)
28: Error (network start error) Network startup after power-on could not be verified
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 |
Host name of the vCenter server |
Specify the host name or IP address of the destination vCenter server. IPv6 addresses are not supported. |
-- |
Input |
R |
VMware.userName |
User name for connecting to the VMware vCenter Server |
Specify the user name for connecting to the VMware vCenter Server. |
-- |
Input |
R |
VMware.password |
Password for connecting to the VMware vCenter Server |
Specify the password for connecting to the VMware vCenter Server. |
-- |
Input |
R |
VMware.portNumber |
Port number for connecting to the VMware vCenter server |
Specify the number of the port for connecting to VMware vCenter Server (for the VMware vCenter Server Web service). |
443 |
Input |
O |
VMware.protocol |
Protocol for connecting to the VMware vCenter server |
Specify either HTTP or HTTPS as the protocol for connecting to VMware vCenter Server. |
https |
Input |
R |
VMware.vmHostName |
Host name of the ESX server |
Specify the ESX server name to be displayed in the Hosts and Clusters inventory view managed by VMware vCenter server. |
-- |
Input |
O |
common.fileName |
File name |
Specify the file name. |
-- |
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 |