Modify Virtual Machine Configuration: Service details

Ops Center Automator User Guide

Version
11.0.x
Audience
anonymous
Part Number
MK-99AUT001-22

This service template modifies a VM configuration in a VMware vSphere environment.

The general steps for using this service template to modify a Virtual Machine configuration are as follows:

  1. Obtain the power status of the virtual server to clone.
  2. Make sure the power status of the virtual server is OFF.
    1. If the power status is not OFF, you can use the User-Response Wait Plug-in to confirm whether to turn the power OFF.
    2. Users with Modify permission can set the e-mail destination/message text, timeout, and display contents through the User-Response Wait Plug-in.
    3. If the user selects "Shutdown" in the UI of the User-Response Wait Plug-in, the service template shuts down the virtual server.
    4. If the user selects "Cancel" or if a timeout occurs while waiting for a user response, the server ends abnormally without completing the process on the virtual server.
  3. Modify the resources (number of CPUs, memory capacity) of the virtual server.
    Note: The maximum number of characters that you can specify for the virtual server name property (vmware.vmName) is 60.

Service Definition Properties

The following table lists the properties shown in the Edit Service window for the Modify Virtual Machine Configuration 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
UserResponsePlugin.toAddress TO addresses Specify the email addresses to enter in the TO field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB O
UserResponsePlugin.ccAddress CC addresses Specify the email addresses to enter in the CC field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB O
UserResponsePlugin.bccAddress BCC addresses Specify the email addresses to enter in the BCC field of notification emails sent when the service is waiting for a user response. Separate multiple addresses with commas. Example: mailA,mailB O
UserResponsePlugin.mailSubject Subject line Specify the subject line of notification emails sent when the service is waiting for a user response. O
UserResponsePlugin.mailBody Email text Specify the body text of notification emails sent when the service is waiting for a user response. O
UserResponsePlugin.encodeType Encoding Specify the encoding of notification emails sent when the service is waiting for a user response. The encodings you can specify are us-ascii, iso-2022-jp, shift_jis, euc-jp, and utf-8. If you omit this property, utf-8 is set. O
UserResponsePlugin.dialogText Additional dialog box text Enter additional text to appear in the response input dialog box, in text or HTML format. Supported HTML tags are anchor tags, bold tags, break tags, font tags, italics tags, and underline tags. O
UserResponsePlugin.responseTimeOut Response timeout time (minutes) Specify how long (in minutes) the service waits for a user response before timing out. In the event of a response timeout, the service will end abnormally. 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 shown in the Service Definition and Submit Service windows for the Modify Virtual Machine Configuration service template.

Property Key Property Name Description Required or optional
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. R
vmware.cpuNum Number of CPUs Specify amount of CPU set to a virtual server. The number must be a number of virtual processors in VMware vCenter Server 4.1 or earlier, or virtual sockets in VMware vCenter Server 5.0 or later. Specify at least "number of CPUs" or "amount of memory". O
vmware.memoryMB Memory size (MB) Specify the amount of memory (in MB) to assign to the virtual server. You must specify either CPUs or memory size property. O
vmware.cpuSharesLevel CPU shares level Specifies the relative priority of CPU resources between virtual servers that have the same parent. O
vmware.cpuReservationMHz CPU reservation (MHz) Specifies, in megahertz, the CPU resources that are reserved by the virtual server. O
vmware.cpuLimitMHz CPU limit (MHz) Specifies, in megahertz, the maximum CPU resources that are to be used by the virtual server. If a value less than 100 MHz is specified, task execution ends abnormally. However, specifying -1 cancels this restriction. O
vmware.memSharesLevel Memory shares level Specifies the relative priority of memory resources between virtual servers that have the same parent. O
vmware.memReservationMB Memory reservation (MB) Specifies, in megabyte, the Memory resources that are reserved by the virtual server. O
vmware.memLimitMB Memory limit (MB) Specifies, in megabyte, the maximum memory resources that are to be used by the virtual server. If a value less than 100 MB is specified, task execution ends abnormally. However, specifying -1 cancels this restriction. O
vmware.diskSharesLevel Disk shares level Specifies the relative priority of virtual servers for storage I/O resources. O
vmware.vHardDiskName Virtual disk name Specifies virtual disk where shares level is changed. Virtual disk is display name in VMware vCenter Server. To specify multiple virtual disks, specify by separating with a comma. O
Note: Although some of the properties in the tables indicate that they can be omitted, they might be required when used in conjunction with some other property setting as indicated in the descriptions.

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

Usage guidelines

  • Do not run multiple instances of this service on the same virtual server.
  • If you specify HTML tags in UserResponseplugin.dialogText, the permitted tags and attributes are the same as those for the User-Response Wait Plug-in.
  • For VMware vCenter Server 5.0 or later, set the number of cores per socket to 1 on the target virtual server. If the number of CPUs is changed for a virtual server on which the number of cores per socket is set to a value other than 1, the virtual server might not start.