3.16.10 Get List of Virtual Machines from VMware vSphere
Function
Obtains a listing of virtual server information.
• If no ESX server name is specified, the service template obtains information about all virtual servers in existence on all ESX servers in the specified vCenter server.
• If an ESX server name is specified, the service template obtains information about the virtual servers in existence on the specified ESX server only.
This service template assumes the following servers:
• vCenter server
This is a server on which VMware vCenter Server is installed.
• vCenter control server
This is a server on which VMware vSphere PowerCLI is installed.
• Virtual server
This is a virtual server managed by the vCenter server and VMware vSphere ESX.
The following provides an overview of the processing.
(1) Outputs a listing of virtual server information in CSV format to a temporary file in the remote system.
(2) Forwards the temporary file from the remote system to a specified output file on the local system.
(3) Deletes the temporary file from the remote system. The service template outputs the following items to a CSV file (the items are separated by the comma):
Below are the items in the CSV file that is output.
The items are separated by commas when they are output.
(a) ESX server name (header name: HostName)
(b) Virtual server name (header name: VMName)
(c) Virtual server's power status (header name: PowerState)
(d) Number of CPUs in the virtual server#1 (header name: NumCpu)
(e) Virtual server's memory capacity (MB) (header name: MemoryMB)
#1: The number of CPUs depends on the VMware vCenter Server version:
• If the VMware vCenter Server version is 4.1 or earlier, this is the number of virtual processors.
• If the VMware vCenter Server version is 5.0 or later, this is the total number of cores (number of virtual sockets x number of cores per socket).
Prerequisites
For the latest support information about [Required product for the system]/[Required products for the service template execution system]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product for the system]
Job Management Partner 1/Automatic Operation 12-00 or later
[Required products for the service template execution system]
(1) Required product for the vCenter server
• VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0, 4.1, or 4.0
(2) VMware vSphere ESXi (or VMware ESX Server) that manages virtual servers
• VMware vSphere ESXi 7.0, 6.7, 6.5, 6.0, 5.5, 5.1 or 5.0 or VMware ESX Server 4.1 or 4.0
(3) Required product for the vCenter control server
• VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1, 5.8 Release1, 5.5 Release2, 5.5 Release1, 5.1 Release2, 5.0
• VMware PowerCLI 6.5 Release1
• VMware PowerCLI 6.5.1, 6.5.4
• VMware PowerCLI 10.1.0, 10.1.1, 11.3.0, 12.0.0, 12.1.0
[Prerequisite product OS running in the system executing the service template]
(1)Prerequisite OS of the virtual server
The following OSs are supported, based on the required products for the vCenter server and the required products for the VMware vSphere ESXi (or VMware ESX Server)/vCenter control server that manages the virtual server.
• Windows Server 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
• Windows Server 2016 Standard/Datacenter
• Windows Server 2019 Standard/Datacenter
• Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)(for vCenter4.1 or later; not supported by vCenter4.0)
• Red Hat Enterprise Linux Server 7 (64-bit x86_64)
• Red Hat Enterprise Linux Server 8 (64-bit x86_64)
• CentOS 6 (64-bit x86_64)
• CentOS 7 (64-bit x86_64)
• CentOS 8 (64-bit x86_64)
(2) Required OS for the vCenter control server
• Windows Server 2008 R2 Standard/Enterprise/Datacenter
• Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
• Windows Server 2016 Standard/Datacenter
• Windows Server 2019 Standard/Datacenter
[Usage conditions of prerequisite products in the system executing the service template]
(1) VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.
(2) Each virtual server name is unique among the vCenter servers.
(3) VMwareTools is installed on the target virtual server.
Cautions
(1) If the file name specified for the remote or the local system already exists, that file will be overwritten. In addition, the file in the remote system will be deleted. For this reason, you should make sure that the specified file names are correct.
(2) If there is no folder on the specified path in the remote system, such a folder will be created. A folder that is created will remain and will not be deleted; for this reason, you should delete unneeded folders periodically.
Execution privilege
(1)The user who will be connecting to VMware vCenter Server must have the following permissions:
Read-only role
Version
02.11.00
Tags
Gather VM information,VMware vSphere
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Virtual system environment information |
Specify the VMware vCenter Server information. |
Y |
|
Virtual environment information |
Specify the information for the virtual environment for which the list is to be acquired. |
Y |
The following shows the list of the properties to be displayed in the "Service Definition" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
vmware.targetHost |
Host name of VMware vCenter control server |
Specify the host name or IP address of the server (a server with vSphere PowerCLI installed) that will be used to control VMware vCenter. You cannot specify an IPv6 address. |
Input |
Disabled |
R |
Virtual system environment information |
|
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 |
Disabled |
R |
Virtual system environment information |
|
vmware.userName |
User name for VMware vCenter Server connection |
Specify the user name to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment information |
|
vmware.password |
Password for VMware vCenter Server connection |
Specify the password to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment information |
|
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. |
Input |
Disabled |
O |
Virtual system environment information |
|
vmware.protocol |
Protocol for VMware vCenter Server connection |
Specify the protocol to use when connecting to the VMware vCenter server. |
Input |
Disabled |
R |
Virtual system environment information |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
vmware.vmHostName |
ESX server name |
Specify the ESX server name to be displayed in the Hosts and Clusters inventory view managed by VMware vCenter server. |
Input |
Disabled |
O |
Virtual environment information |
|
vmware.listOutputFileNameRemote |
Output file name (remote) |
Specifies the full path name of the temporary file for outputting virtual server information to the VMware vCenter control server. |
Input |
Disabled |
R |
Virtual environment information |
|
vmware.listOutputFileNameLocal |
Output file name (local) |
Specifies the full path name of the file on the local server for acquiring the virtual server information. |
Input |
Disabled |
R |
Virtual environment information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
|
Property key |
Characters that can be input |
|---|---|
|
vmware.targetHost |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
vmware.vCenterServerName |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
vmware.userName |
A maximum of 512 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, /, :, =, , , +, %. |
|
vmware.password |
A maximum of 127 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %. |
|
vmware.portNumber |
Integer between 1 and 65535 can be entered. |
|
vmware.protocol |
Select one of the following values: http,https |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
vmware.vmHostName |
A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
vmware.listOutputFileNameRemote |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, /, ', [, ], `, or a trailing \. |
|
vmware.listOutputFileNameLocal |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, or a trailing \ or /. |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
vsphereGetInfo |
Get list of virtual server information |
Outputs a list of virtual server information to a temporary file on the VMware vCenter control server. |
Eliminate the cause of the error, and then re-execute the service. |
|
2 |
fileTransfer |
File-Forwarding Plug-in |
Transfers a remote temporary file to the specified local output file. |
Eliminate the cause of the error, and then re-execute the service. |
|
3 |
osDeleteFile |
Delete file |
Deletes the remote temporary file. |
Eliminate the cause of the error, and then re-execute the service. |