5.5.16 Check VMware vCenter Server connectivity
Function
Verifies that VMware vSphere PowerCLI can be used to connect to a VMware vSphere environment.
This module assumes the following servers:
• vCenter server
This is a server on which VMware vCenter Server is installed.
• ESX server
This is a server on which VMware vSphere ESXi is installed.
• vCenter control server (Execution target server)
This is a server on which VMware vSphere PowerCLI is installed. The module is transferred from JP1/AO to this server and then is executed.
Use situation
In a VMware vSphere environment, this module enables you to check in advance the connection status between VMware vSphere ESXi and the execution target server.
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) Prerequisite product of ESX Server
• VMware vSphere ESXi
[Usage conditions for required products in the execution target system]
(1)VMware vSphere ESXi is managed by 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
vsphereConnectChallenge
Return code
0: Normal
23: Error (invalid environment) Required environment is invalid
27: Error (check task logs for the nature of error)
41: Error (error detected in module) Missing property (error detected in module 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 |
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 |
common.connectvCenterResult |
vCenter connectivity check result |
Stores the result of determining whether a connection to VMware vCenter can be established. |
-- |
Output |
O |