VMware: Deploy VM from Template
Description
VMware: Deploy VM from Template plugin step deploys (creates) VM from a template available on the specified vCenter server.
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Name of the step. This name has to be unique in a single workflow. |
| Configuration: | ||
| 1 | vCenter Server Base URL | Specify the vCenter Server Base URL to connect to vCenter. (e.g.: https://vmware.example.com) Note: If vCenter IP is given instead of vCenter server name, it throws certificate error if the vCenter IP entry is not present in the Subject Alternative Name field of the certificate, because the certificate mostly contains entry of vCenter server in FQDN (Fully Qualified Domain Name) format. |
| 2 | Port | Specify the vCenter server port. (Default port is 443). This field should be an integer and value should be less than 65536. |
| 3 | Username | Specify a Username to authenticate vCenter server. |
| Password: | The password to authenticate vCenter server. | |
| 4 | Accept value as variable/static | Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list. Else enable checkbox for Password field to appear as Text box. |
| 5 | Password | Specify the password. Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is mandatory. If checkbox above is enabled Password field appears as Text box and accepts static or variable values. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. Please Note: that Field values can only be accessed when workflow is in running state. |
| 6 | Button: Test Connection | Verifies whether the connection is available or not. For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed. |
Input Tab:
| No. | Field Name | Description |
|---|---|---|
| 1 | Template Name | Name of an existing template to be used to create a new VM. ‘Template Name’ must be unique. The data type is String. This field is mandatory. Note: • If two or more templates with the same name appear in the vCenter Server inventory, then at the run time, the correct template object may not be used among duplicate template names. To resolve this issue, rename the duplicate template to a unique name for each entity • If Template name contains ‘%’ special character then to execute the plugin step, provide Template name by replacing ‘%’ character with ‘%25’ |
| 2 | Button: Get | On click of this button, if the connection is successfully established it populates the list of Templates Names on the vCenter server. |
| 3 | New Virtual Machine Name | Name to be given to new virtual machine to be created. Name of a new virtual machine to be created. The data type is String. This field is mandatory. |
| 4 | Target Location Type | Target location type to create a new VM. Allowed values: 'Datacenter', 'VM Folder'. The data type is String. This field is mandatory. |
| 5 | Target Location Name/ID | Target location name to create a new VM. The data type is String. This field is mandatory. Refer GetTargetIDGet Target ID in VMWare Plugin introduction for the steps to fetch Target ID. |
| 6 | Button: Get | On click of this button, if the connection is successfully established it populates the list of target locations based upon the specified target location type. |
| 7 | Compute Resource Type | Compute resource type to create a new VM. Allowed values: 'Cluster', 'Host’, ‘vApp', ‘ResourcePool’. The data type is String. This field is mandatory. |
| 8 | Compute Resource Name/ID | Compute resource name to create a new VM. The data type is String. This field is mandatory. Note:s: Refer Get Compute Resource ID in VMWare Plugin introduction for the steps to fetch Target ID. |
| 9 | Button: Get | On click of this button, if the connection is successfully established it populates the list of computing resource names based upon the specified compute resource type. |
| 10 | Datastore Name | Datastore name to create a new VM. The data type is String. This field is mandatory. |
| 11 | Button: Get | On click of this button, if the connection is successfully established it populates the list of datastore names on the vCenter server. |
| 12 | Power On Virtual Machine After Creation | Allowed values: ‘Yes’ or ‘No’. If “Yes” then VM will be powered-on after creation. If given “No” then VM power status is off after creation. The data type is String. This field is mandatory. |
Common Buttons:
| No. | Field Name | Description |
|---|---|---|
| 1 | OK | Click this button to check and save the field values. If any required field values are missing then it will display a validation error message else if all the required field values are provided then it will save the field values. |
| 2 | Cancel | Click this button, to cancel the window and does not save any values. |