This service template turns off the power to multiple virtual servers in a VMware vSphere environment.
The general steps for using this service template to stop a virtual machine are as follows:
- The power status of each virtual server is obtained.
- If a virtual server's power status is on, it is turned off.
The specified group of virtual servers are turned off according to the number of seconds specified through the vmware.checkPowerStateInterval property and then verified to determine if the power is off, which it does up to the number of times specified through the vmware.checkPowerStateCount property. If the default values are not suitable, specify values that suit your environment.
Service Definition Properties
The following table lists the properties visible in the Service Definition window for the Stop Virtual Machine service template.
| Property Key | Property Name | Description | Required or optional |
|---|---|---|---|
| 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. | R |
| vmware.vCenterServerName | VMware vCenter server name | Specify the host name or IP address of the VMware vCenter server. You cannot specify an IPv6 address. | R |
| vmware.userName | User name for VMware vCenter Server connection | Specify the user name to use when connecting to the VMware vCenter server. | R |
| vmware.password | Password for VMware vCenter Server connection | Specify the password to use when connecting to the VMware vCenter server. | 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. | O |
| vmware.protocol | Protocol for VMware vCenter Server connection | Specify the protocol to use when connecting to the VMware vCenter server. | R |
| vmware.checkPowerStateCount | Power status check count | Specifies the number of times to verify the power status when confirming that the virtual server is stopped. In combination with the power status verification interval, this determines the maximum wait time. | R |
| vmware.checkPowerStateInterval | Power status check interval | Specifies the interval in seconds for verifying the power status when confirming that the virtual server is stopped. | R |
Service Definition and Submit Service Properties
The following table lists the properties visible in the Service Definition and Submit Service windows for the Stop Virtual Machine service template.
| Property Key | Property Name | Description | Required or optional |
|---|---|---|---|
| vmware.foreachVmName | Virtual server name(s) | Specify the virtual server name or names. Specify server names as they appear in VMware vCenter Server, not by host name. Separate multiple virtual servers with commas. The maximum number of virtual servers you can specify is 99. | R |
Prerequisites
The following conditions must be met:
- VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.
- Each virtual server name is unique among the vCenter servers.
- VMwareTools is installed on the target virtual server.
Server requirements
To use this service template, the following servers are needed:
- 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.
Software requirements
One of the following is required:
- VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1
- VMware PowerCLI 6.5 Release1
- VMware PowerCLI 6.5.1, 6.5.4
- VMware PowerCLI 10.1.0, 10.1.1