5.5.42 Start virtual server
Function
In a VMware vSphere environment, turns on a virtual server's power (sets its power status to ON).
This plugin 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 ESXi.
When the virtual server is started, the plugin waits for the amount of time (in seconds) specified in the VMware.checkPowerStateInterval property, then it checks the virtual server's start status, which it does up to the number of times specified in the VMware.checkPowerStateCount property. If the default values are not appropriate, specify values that are suitable for your environment. If the plugin terminates normally, it sets "PoweredOn" in the VMware.powerState output property.
Use situation
You use this plugin to start a virtual server.
The start processing involves execution of the vsphereGetPower plugin, followed by execution of this plugin if the power status is "PoweredOff".
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
Cautions
(1) The VMware vSphere ESXi that is to be started cannot be specified. Start the plugin on a VMware vSphere ESXi that contains virtual servers.
Execution privilege
(1) The user who will be connecting to VMware vCenter Server must have the following permissions:
Role with power-on permission for the target virtual server or system administrator role
Version
02.11.00
Plug-in tags
Control VM,VMware vSphere
Plug-in name displayed in the task log
vsphereSetPowerOn
Return code
0: Normal
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 |
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 |
VMware.checkPowerStateCount |
Power status check count |
Specify the number of times the service attempts to check the power status to confirm that the virtual server has started. The maximum wait time is determined by this property and the property that defines the power status check interval. |
60 |
Input |
R |
VMware.checkPowerStateInterval |
Power status check interval |
Specify the interval by a second unit. The service attempts to acquire the power status to confirm that the virtual server has started at the interval. |
10 |
Input |
R |
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |
VMware.powerState |
Power state of the virtual server |
This property is used to store the power state of the specified virtual server. |
-- |
Output |
O |