3.16.2 Clone Virtual Machine

Virtual system environment information

Specify the VMware vCenter Server information.

Y

Information about a virtual server as the cloning source

Specify the information of a virtual server as the cloning source.

Y

Information about a virtual server as the cloning destination

Specify the information about the cloning destination.

Y

Option that allows waiting for a user response

This is an option that allows you to wait for a user response if the virtual server is up and running. Change the option as appropriate.

N

Runtime option

This is a property related to the status confirmation performed when stopping a virtual server. Change the option as appropriate.

N

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

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

Input

Disabled

O

Option that allows waiting for a user response

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

Input

Disabled

O

Option that allows waiting for a user response

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

Input

Disabled

O

Option that allows waiting for a user response

UserResponsePlugin.mailSubject

Subject line

Specify the subject line of notification emails sent when the service is waiting for a user response.

Input

Disabled

O

Option that allows waiting for a user response

UserResponsePlugin.mailBody

Email text

Specify the body text of notification emails sent when the service is waiting for a user response.

Input

Disabled

O

Option that allows waiting for a user response

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.

Input

Disabled

O

Option that allows waiting for a user response

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.

Input

Disabled

O

Option that allows waiting for a user response

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 terminate abnormally.

Input

Disabled

R

Option that allows waiting for a user response

vmware.checkPowerStateCount

Number of power status confirmation retries

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.

Input

Disabled

R

Runtime option

vmware.checkPowerStateInterval

Frequency of power status confirmation retries

Specify the interval at which the service attempts to acquire the power status to confirm that the virtual server has started.

Input

Disabled

R

Runtime option

vmware.cloneName

Clone name

Specifies the name of a clone (This is the display name of a clone under VMware vCenter Server. It is not a host name under the OS.)

Input

Disabled

R

Information about a virtual server as the cloning destination

vmware.vmName

Virtual server name

Specify the name of a virtual server as the cloning source. (This is the display name of a virtual server under VMware vCenter Server. It is not a host name under the OS.)

Input

Disabled

R

Information about a virtual server as the cloning source

vmware.vmHostName

ESX server name

Specify the ESX server name displayed in the Hosts and Clusters inventory view managed by VMware vCenter Server, which serves as the cloning destination.

Input

Disabled

R

Information about a virtual server as the cloning destination

vmware.dataStoreName

Datastore name

Specify the name of a data store as the cloning destination.

Input

Disabled

R

Information about a virtual server as the cloning destination

vmware.resourcePoolName

Resource pool name

Specify a resource pool or cluster as the cloning destination.

Input

Disabled

O

Information about a virtual server as the cloning destination

vmware.diskFormat

Virtual disk format

Specifies format of the virtual disk of the clone to be created. Specify "Default" when the format is the same as the virtual disk of the virtual server of the clone source, "Thin" when committing it on demand, or "Thick" when committing it in full size.

Input

Disabled

R

Information about a virtual server as the cloning destination

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

UserResponsePlugin.toAddress

A maximum of 1024 characters can be entered. Characters that can be used include alphanumeric characters and symbols.

UserResponsePlugin.ccAddress

A maximum of 1024 characters can be entered. Characters that can be used include alphanumeric characters and symbols.

UserResponsePlugin.bccAddress

A maximum of 1024 characters can be entered. Characters that can be used include alphanumeric characters and symbols.

UserResponsePlugin.mailSubject

A character string of no more than 256 characters can be entered.

UserResponsePlugin.mailBody

A character string of no more than 1024 characters can be entered.

UserResponsePlugin.encodeType

Select one of the following values:

us-ascii,iso-2022-jp,shift_jis,euc-jp,utf-8

UserResponsePlugin.dialogText

A character string of no more than 512 characters can be entered.

UserResponsePlugin.responseTimeOut

Integer between 1 and 9999 can be entered.

vmware.checkPowerStateCount

Integer between 1 and 3600 can be entered.

vmware.checkPowerStateInterval

Integer between 1 and 60 can be entered.

vmware.cloneName

This is a character string of up to 60 characters. < > | ; & ' " * ? [ ] ` , and % are not allowed.

vmware.vmName

A character string of no more than 60 characters can be entered. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, , and %.

vmware.vmHostName

A maximum of 256 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -.

vmware.dataStoreName

A maximum of 42 characters can be entered. Characters that can be used include alphanumeric characters and symbols. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], `, %.

vmware.resourcePoolName

A character string of no more than 60 characters can be entered. It cannot include <, >, |, ;, &, ', ", *, ?, [, ], ` and %.

vmware.diskFormat

Select one of the following values:

Default,Thin,Thick

1

vsphereGetPower

Get power status of virtual server

Obtains the power status of the virtual server in the VMware vSphere environment.

Remove the cause of the error, and then execute the service again.

2

vsphereCheckPower

Flow Plug-in

Checks the power status, and if the status is not OFF, reports it to the user.

--

2-3

Compatible Plug-in

Determines whether the output character string matches "PoweredOn".

After removing the cause of the error, run the service again.

2-4

Flow Plug-in

Checks whether or not to turn the power to OFF.

--

2-4-1

User-Response Wait Plug-in

Checks whether or not to turn the power to OFF.

After removing the cause of the error, run the service again.

2-4-2

Judge ReturnCode Plug-in

Determines whether timeout has occurred in the component where Cancel has been selected or in the component waiting for a user response.

After removing the cause of the error, run the service again.

2-4-3

Abnormal-End Plug-in

Makes the jobnet an error.

Check the power supply state of the virtual server and execute the service again.

2-4-4

Shut down a virtual server

In the VMware vSphere environment, shuts down the virtual server and then sets the power supply state to OFF.

After removing the cause of the error, run the service again.

3

vsphereCreateClone

Creating a virtual server clone

Creates a clone of a virtual server in the VMware vSphere environment.

Remove the cause of the error, and then execute the service again.