VMWare

VMWare

VMWare

VMWare Plugin can be used for managing VMware vSphere - vCenter server. 


Compatibility:  vSphere Web Client (Version 6.5.0.13000 Build 8024368)


Prerequisites:

  1. vCenter Server with access details (Login credentials to authenticate VMware- vCenter server, vCenter port number)


  1. VMware certificate must be installed on the system where the plugin step needs to be executed. For the steps to install the certificate refer Appendix 13: Install VMware certificate













Get VM UUID, Resource ID, Target ID

Get VM UUID

  1. In most VMWare Plugin steps when you work on existing VMs you have to specify the VM Name or UUID. 
  1. VM Name/UUID can be fetched from vSphere vCenter. Login to vCenter server GUI, 
  2. Navigate to vCenter Host (in which VM is created)  Virtual Machines Tab containing tabular information of the VMs including VM Name.
  3. In case VM UUID is not visible in the table, 
  1. Right Click on any column header 
  2. Click on the 'Show/Hide Columns' option and
  3. Select UUID column to be displayed with each of the VM Name.
  1. UUID is now visible in the table. You may fetch this UUID to use in the Plugin steps.


Get Compute Resource ID

  1. To find the ‘Compute Resource ID’, click on a Compute Resource (Host/Cluster/ResourcePool/vApp) on vSphere-vCenter and then click in the URL address bar. 

Scroll the URL in the address bar to copy the ‘Compute Resource ID’ in between ‘%253A’ (which is preceded by the Compute Resource Type) and a ‘~’. 

Compute Resource Type preceding ‘%253A’ is from one of the following.

  1. HostSystem, 
  2. ClusterComputeResource, 
  3. ResourcePool, 
  4. VirtualApp 

Following are samples of Resource ID marked in yellow. Note that Resource ID is is preceded by a %253A and followed by a ~.  %253A must be which preceded by the desired Resource Type.

You may copy the Compute Resource ID required as marked in yellow below.

Host ID

HostSystem%253Ahost-528~

Cluster: 

HostSystem%253Ahost-528~

ResourcePool

ResourcePool%253Aresgroup-545~

vApp: 

ResourcePool%253Aresgroup-545~




The following screen shots depict how to get the Compute Resource ID of a Cluster Resource Type.

  1. Select a cluster in the vSphere-vCenter as seen below. 



  1. Once the Resource Type i.e. Cluster in this case is selected scroll the URL address bar to locate the Resource Type (ClusterComputeResource in this case). Then pick the Resource ID in between %253A and a ~.

Get Target ID

  1. To find the ‘Target ID’, click on a Target Location Type (Datacenter/VM Folder) on vSphere-vCenter and then click in the URL address bar. 

Scroll the URL in the address bar to copy the ‘Target ID’ in between ‘%253A’ (which is preceded by the Target Location Type) and a ‘~’. 

Target Location Type preceding ‘%253A’ is from one of the following.

  1. Datacenter 
  2. VM Folder


Following are samples of Target ID marked in yellow. Note that Target ID is is preceded by a %253A and followed by a ~.  %253A must be which preceded by the desired Target Location Type.You may copy the Target ID required as marked in yellow below.

Datacenter

Datacenter%253Adatacenter-21~

VM Folder

Folder%253Agroup-v381~


The following screen shots depict how to get the Target ID of a Datacenter Target Location Type.

  1. Select a Datacenter in the vSphere-vCenter as seen below. 
  2. Once the Target Location Type, i.e. Datacenter in this case is selected scroll the URL address bar to locate the Target Location Type (Datacenter in this case). Then pick the Target ID in between %253A and a ~.



  1. Similarly, once the Target Location Type i.e. VM Folder is selected scroll the URL address bar to locate the Target Location Type (Folder in this case). Then pick the Target ID in between %253A and a ~ as seen below. 


Following is the list of VMWare Plugin steps,

VMware: Convert Template to VM

VMware: Convert Template to VM plugin step converts a template to a virtual machine.


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

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


Input Fields:


1

Template Name

Specify the Name of an existing Template to be converted to a Virtual Machine.


Note: 

  1. 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
  2. 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

Compute Resource Type

Specify compute resource type for converted VM. Allowed values: 'Cluster', 'Host’, ‘vApp', ‘ResourcePool’.

4

Compute Resource Name/ID

Specify the Name/ID of a Compute Resource Type chosen above - for which the VM is to be created from template.


Notes:

Refer  Get Compute Resource ID

in the VMWare Plugin introduction to get the ‘Compute Resource ID’.

5

Button: Get

On click of this button, if the connection is successfully established it populates the list of computing resources based on the specified compute resource type.


Common Buttons:

No.

Field Name

Description


Buttons:


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.


VMware: Convert VM to Template

VMware: Convert VM to Template plugin step converts a virtual machine to a template.


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:

  1. If vCenter IP is given instead of vCenter server name, it may throw certificate error, because the certificate mostly contains entry of vCenter server in FQDN (Fully Qualified Domain Name) format. In such a case vCenter IP entry must be present in the Subject Alternative Name field of the certificate.

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

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


Input Fields:


1

Virtual Machine Name/UUID

Specify the Name/UUID of an existing VM which is to be converted to a template.

The data type is String. This field is mandatory.


Note: 

  1. Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID.
  2. If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM.
  3. If VM name contains ‘%’ special character then to execute the plugin step, provide VM name by replacing ‘%’ character with ‘%25’.

2

Button: Get

Click of this button, to populate the list of Virtual Machine Names on the vCenter server (if the connection is successfully established).


Note: If VM name contains ‘%’ special character then on click of ‘Get’ button, the VM name is returned by replacing ‘%’ character with ‘%25’. You may leave it like that.


Common Buttons:

No.

Field Name

Description


Buttons:


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.


VMware: Delete Snapshot 

Description

VMware: Delete Snapshot plugin step deletes a specified snapshot optionally along with its   child snapshots associated with a virtual machine.


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

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


Input Fields:


1

Virtual Machine Name/UUID

Specify the Name/UUID of the virtual machine to which the snapshot to be deleted is associated.

The data type is String. This field is mandatory.


Notes: 

  1. Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID.
  2. If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM.
  3. If VM name contains ‘%’ special character then to execute the plugin step, provide VM 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 Virtual Machine Names on the vCenter server.

3

Optional Input Fields:

Provide value for any one of the following only.


i

Snapshot Created Date

Specify the Snapshot Created Date of a snapshot that is to be deleted in specified date format. Date Format:  EEEE, MMMM dd, yyyy h:mm:ss a
Date Example: Tuesday, November 26, 2019, 12:01:36 PM

The data type is String. This field is optional.


Note:

Provide value in Snapshot Created Date or Snapshot Name but not both.


ii

Button: Get

On click of this button, if the connection is successfully established it populates the list of Snapshot Created Dates on the vCenter server.


iii

Snapshot Name

Specify the Snapshot Name to be deleted.    

The data type is String. This field is optional.


Note:

Provide value in Snapshot Created Date or Snapshot Name but not both.                                     


iv

Button: Get

On click of this button, if the connection is successfully established it populates the list of Snapshot Names on the vCenter server.

4

Delete Child Snapshots

Allowed values: ‘Yes’ or ‘No’.

If given “Yes” then all the child snapshots of the specified snapshot will be deleted. If given blank, then no child snapshots will be deleted.

The data type is String. This field is mandatory.


Common Buttons:

No.

Field Name

Description


Buttons:


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.



VMware: Delete All Snapshots 

Description

VMware: Delete Snapshot plugin step deletes all Snapshots associated with a Virtual Machine 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. 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. This field is mandatory.

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


Input Fields:


1

Virtual Machine Name/UUID

Specify the Name/UUID of the virtual machine for which snapshot is to be created.

The data type is String. This field is mandatory.


Notes: 

  1. Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID.
  2. If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM.
  3. If VM name contains ‘%’ special character then to execute the plugin step, provide VM 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 Virtual Machine Names on the vCenter server.


Common Buttons:

No.

Field Name

Description


Buttons:


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.



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


Input Fields:


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: 

  1. 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
  2. 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 Get 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.


Notes:

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


Buttons:


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.



VMware: Get VM Properties 

Description

VMware: Get VM Properties plugin step fetches the properties of a virtual machine.


Configurations 

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.


Configuration:


2

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.

3

Port

Specify the vCenter server port. (Default port is 443).

This field should be an integer and value should be less than 65536.

4

Username

Specify a Username to authenticate vCenter server.


Password:

The password to authenticate vCenter server.

5

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.

6

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.

7

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


Input Fields:


1

Virtual Machine Name/UUID

Specify the Name/UUID of the virtual machine to fetch the properties.

The data type is string. This field is mandatory.


Notes: 

  1. Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID.
  2. If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM.
  3. If VM name contains ‘%’ special character then to execute the plugin step, provide VM 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 Virtual Machine Names on the vCenter server.


Ouput Tab

No.

Field Name

Description


Input Fields:


1

Accept Output as JSON 

Enable checkbox to fetch property values as JSON output. 

Leave this unchecked to fetch Properties and their values as a tabular output fields. 

2

JSON Output

Specify an output field name to hold all of the VM properties and their values in JSON format.


Output Table Fields:

If ‘Accept Fields as JSON’ is not selected then the fields in this table are mandatory.

3

Field Name

On click of the cell in the output table, if the connection is successfully established it populates the list of VM properties. Select one or more properties as rows of the table.

The data type is string. This field is optional.

4

Output Field 

Specify an output field in each row to hold the returned values of the properties selected in the Field Name column.


Common Buttons:

No.

Field Name

Description


Buttons:


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.



VMware: Increase Hard Disk Size

VMware: Increase Disk plugin step increases the hard disk size of a virtual machine 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:

  1. If vCenter IP is given instead of vCenter server name, it may throw certificate error, because the certificate mostly contains entry of vCenter server in FQDN (Fully Qualified Domain Name) format. In such a case vCenter IP entry must be present in the Subject Alternative Name field of the certificate.
  2. Two or more virtual machines with the same name appear in the vCenter Server inventory. In this scenario, at the run time, the correct virtual machine object may not be used among duplicate virtual machine names. To resolve this issue, rename the duplicate virtual machine to a unique name for each entity.

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

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


Intput Fields:


1

Virtual Machine Name/UUID

Specify the Name/UUID of the virtual machine to which hard disk is attached to increase hard disk size.

The data type is String. This field is mandatory.


Note: 

  1. Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID.
  2. If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM.
  3. If VM name contains ‘%’ special character then to execute the plugin step, provide VM 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 Virtual Machine Names on the vCenter server.

3

Hard Disk Name

Specify the name of the Hard Disk to increase size; attached to the specified VM.

The data type is String. This field is mandatory.

4

Button: Get

On click of this button, if the connection is successfully established it populates the list of hard disk names attached with a virtual machine.

5

New Hard Disk Size

Specify the New Hard Disk Size to be given. 

‘New Hard Disk Size’ should be greater than original size.

‘New Hard Disk Size’ should only be an integer. This field is mandatory.

4

Increase Size By Unit

Specify ‘Increase Size By Unit’, as ‘MB’ or ‘GB’ or ‘TB’.  Hard disk size is modified by the given size unit.

The data type is String. This field is mandatory.


Common Buttons:

No.

Field Name

Description


Buttons:


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.



VMWare: Modify CPU Count 

Description

VMware: Modify CPU Count Plugin step modifies the count of CPUs in a virtual machine.



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

vCenter 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.


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


Input Fields:


1

Virtual Machine Name/UUID

Specify the Name/UUID of the virtual machine to modify CPU count. 

This field data type is String. This field is mandatory.


Notes: 

  1. Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID.
  2. If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM.
  3. If VM name contains ‘%’ special character then to execute the plugin step, provide VM 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 Virtual Machine Names on the vCenter server.


Note: If VM name contains ‘%’ special character then on click of ‘Get’ button, the VM name is returned by replacing ‘%’ character with ‘%25’. You may leave it like that.

3

New CPU Count

Specify the new CPU count.  

This field data type is integer. This field is mandatory.


Notes:

  1. The maximum number of virtual CPUs that you can assign to a virtual machine depends on the number of logical CPUs on the host, the host license, and the type of guest operating system that is installed on the virtual machine.
  2. When the virtual machine is Powered-Off, you can set any no. of CPUs through this plugin step (using REST API). But it will cause problems while powering on the virtual machine. Make sure the CPU count should not exceed the maximum no. of CPUs available on the vCenter portal.
  3. To hot add multicore CPUs, verify that the virtual machine has hardware version 8.
  4. Not all guest operating systems support CPU hot add and hot remove. You can disable these settings if not supported.


Common Buttons:

No.

Field Name

Description


Buttons:


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.




VMWare: Modify CPU Properties 

Description

VMware: Modify CPU Properties Plugin step modifies the CPU-related settings of a virtual machine.

Additional Prerequisites:

  1. The virtual machine should be powered off before executing this step. (If the virtual machine is powered on, this step does not provide any error and the changes will not be reflected after the execution of the step.)




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

vCenter 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.


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


Input Fields:


1

Virtual Machine Name/UUID

Specify the Name/UUID of the virtual machine to modify properties. This field data type is String. This field is mandatory.


Notes: 

  1. Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID.
  2. If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM.
  3. If VM name contains ‘%’ special character then to execute the plugin step, provide VM 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 Virtual Machine Names on the vCenter server.


Note: If VM name contains ‘%’ special character then on click of ‘Get’ button, the VM name is returned by replacing ‘%’ character with ‘%25’. You may leave it like that.

3

Cores Per Socket

Specify the new number of cores per socket.  

This field data type is integer. This field is mandatory

4

Enable CPU Hot Add*

Allowed values: ‘Yes’ or ‘No’.

If ‘Yes’ is specified then ‘CPU Hot Add’ will be enabled.
If ‘No’ is specified then ‘CPU Hot Add’ will be disabled.

5

Enable CPU Hot Remove*

Allowed values: ‘Yes’ or ‘No’.

If ‘Yes’ is specified then ‘CPU Hot Remove’ will be enabled.
If ‘No’ is specified then ‘CPU Hot Remove’ will be disabled.

*Notes:

  1. Hot-adding multi core virtual CPUs are supported only with hardware version 8 virtual machines. Not all guest operating systems support CPU hot add and hot remove. You cannot use these settings if the guest is not supported.
  2. To use the CPU hot-add feature with hardware version 7 virtual machines, set the Number of cores per socket to 1.
  3. Ensure that the VMware Tools is installed on the virtual machine for enabling hot plug (add/remove) functionality with Linux guest operating systems. Ensure that the virtual machine has a guest operating system that supports CPU hot plug.
  4. You can set any number of Cores per Socket through this plugin step (uses REST API). But it will cause problems while powering on the virtual machine. Make sure the Cores Per Socket should not exceed the allowed limit.


Common Buttons:

No.

Field Name

Description


Buttons:


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.



VMWare: Modify Memory Property 

Description

VMware: Modify Memory Property Plugin step enables or disables the memory hot add property of a virtual machine.


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

vCenter 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.


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


Input Fields:


1

Virtual Machine Name/UUID

Specify the Name/UUID of the virtual machine to modify CPU count. This field data type is String. This field is mandatory.


Notes: 

  1. Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID.
  2. If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM.
  3. If VM name contains ‘%’ special character then to execute the plugin step, provide VM 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 Virtual Machine Names on the vCenter server.


Note: If VM name contains ‘%’ special character then on click of ‘Get’ button, the VM name is returned by replacing ‘%’ character with ‘%25’. You may leave it like that.

3

Enable Memory Hot Add

Allowed values are - ‘Yes’ or ‘No’.

If ‘Yes’ is specified then ‘Memory Hot Add’ will be enabled.
If ‘No’ is specified then ‘Memory Hot Add’ will be disabled.

This field is mandatory.


Notes:

  1. Ensure that the virtual machine is using hardware version 7 or later.
  2. Ensure that the virtual machine has a guest operating system that supports memory hot-add functionality.
  3. Ensure that VMware Tools is installed.


Common Buttons:

No.

Field Name

Description


Buttons:


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.



VMWare: Modify Memory Size 

Description

VMware: Modify Memory Size Plugin step modifies the available memory size of a virtual machine.


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, because the certificate 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

vCenter 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.


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


Input Fields:


1

Virtual Machine Name/UUID

Specify the Name/UUID of the virtual machine to modify CPU count. This field data type is String. This field is mandatory.


Notes: 

  1. Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID.
  2. If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM.
  3. If VM name contains ‘%’ special character then to execute the plugin step, provide VM 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 Virtual Machine Names on the vCenter server.


Note: If VM name contains ‘%’ special character then on click of ‘Get’ button, the VM name is returned by replacing ‘%’ character with ‘%25’. You may leave it like that.

3

New Memory Size.

Specify the new Memory Size.

This field data type is integer. This field is mandatory.


Notes:

  1. Ensure that the virtual machine is using hardware version 7 or later.
  2. The minimum memory size is 4MB for virtual machines that use BIOS firmware. Virtual machines that use EFI firmware require at least 96MB of RAM or they cannot power on.
  3. When the virtual machine is Powered-Off, you can set any no. of memory size through with this plugin step (using REST API). If the virtual machine memory is greater than the host memory size, swapping occurs, which can have a severe effect on virtual machine performance. The memory size must be a multiple of 4MB.
  4. Ensure that the virtual machine has a guest operating system that supports memory hot-add functionality.

4

Modify Size By Unit

Allowed values: ‘MB’ or ‘GB’. Memory size will be modified in the given size unit. 

This field data type is string. This field is mandatory.


Common Buttons:

No.

Field Name

Description


Buttons:


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.



VMWare: Power off VM 

Description

VMware: Power Off VM plugin step powers off a powered-on or suspended virtual machine.

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, because the certificate 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

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


Input Fields:


1

Virtual Machine Name/UUID

Specify the Name/UUID of the virtual machine to Power Off.

This field data type is String. This field is mandatory.


Notes: 

  1. Refer Get VM UUID in the VMWare Plugin introduction for steps to fetch the VM UUID.
  2. If two or more virtual machines with the same name appear in the vCenter Server inventory, then you may provide the UUID which is unique to each VM.
  3. If VM name contains ‘%’ special character then to execute the plugin step, provide VM 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 Virtual Machine Names on the vCenter server.


Note: If VM name contains ‘%’ special character then on click of ‘Get’ button, the VM name is returned by replacing ‘%’ character with ‘%25’. You may leave it like that.


Common Buttons:

No.

Field Name

Description


Buttons:


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.




      Links to better reach 

            Bot Store

             EPD