VMWare1

VMWare1


VMWare: Power On VM 

Description

VMware: Power On VM powers on a powered-off 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 On.

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.


VMware: Rename Snapshot 

Description

VMware: Rename Snapshot plugin step is designed to rename snapshot associated with VM on 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

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:



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.

8

New Snapshot Name

Specify the new name for the specified Snapshot.

The Snapshot Name must be unique.

The data type is String. This field is mandatory.

9

Snapshot Description

Provide a short Description for Snapshot Rename.

The data type is String. This field is optional.

Note:

Allowed combinations of values for the input fields viz., ‘Snapshot Created Date’ and ‘Snapshot Name’:

No.

Snapshot Created Date

Snapshot Name

1

<Valid DateTime>


2


<Valid SnapshotName>


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: Revert VM to Snapshot 

VMware: Revert To Snapshot plugin step reverts a Virtual Machine to a specified snapshot of a virtual machine or to the latest (current) snapshot.


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


Input Fields:


1

Virtual Machine Name/UUID

Specify the Name/UUID of the virtual machine to revert to a snapshot.

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.


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.


Optional Input Fields: 

Provide any one of the following. 

3

Snapshot Created Date

Snapshot Created Date of a snapshot to revert.                                                                                                       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.

4

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.

5

Snapshot Name

Specify Snapshot Name to revert VM to.      

‘Snapshot Name’ must be unique.   

The data type is string. This field is optional.                                

6

Button: Get

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

7

Revert VM To Latest (Current) Snapshot

Allowed Value: ‘Yes’.

If given “Yes” then a virtual machine will be reverted to the latest (current) snapshot state.

If the field is blank, then ‘No’ is considered.

The data type is string. This field is optional.

Note: 

Allowed combinations of values for the input fields viz., ‘Revert VM To Snapshot Created Date’, ‘Revert VM To Snapshot Name’ and ‘Revert VM To Latest (Current) Snapshot as depicted below. 

As seen below only one of the following values can be provided.

No.

Revert VM To Snapshot Created Date

Revert VM To Snapshot Name

Revert VM To Latest (Current) Snapshot

1

<Valid DateTime>



2


<Valid Name>


3



<Yes>



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: Shutdown VM 

Description

VMware: Shutdown VM plugin step shuts down 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

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

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.



VMWare: Suspend VM 

Description

VMware: Suspend VM plugin step suspends 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

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

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.




VMware: Take VM Snapshot 

Description

VMware: Take VM Snapshot plugin step takes a snapshot of a virtual machine’s state.


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

Virtual Machine Name/UUID

Specify the Name/UUID of the virtual machine to take a snapshot.

The data type is string. This field is mandatory.


Notes: 

  1. Refer Get VM UUIDError! Reference source not found. 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

New Snapshot Name

Specify the name of the New snapshot to be created.
If no value is provided, a New snapshot is generated with the current date-time.  
Example: VM Snapshot 25/11/2019 03:35:09 PM

4

Snapshot Description

Provide a description for the snapshot.

5

Snapshot The Virtual Machine’s Memory

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

If the specified value is “Yes”, then the memory state of the Virtual Machine is also saved with the Snapshot.


Note:

Snapshot The Virtual Machine’s Memory’ and ‘Quiesce Guest File System’ values are considered only if Virtual Machine is in running state. 


Allowed combinations of values for ‘Snapshot The Virtual Machine’ and ‘Quiesce Guest File System’ are:

No.

Snapshot The Virtual Machine

Quiesce Guest File System

1

Yes


2


Yes


6

Quiesce Guest File System

Allowed values: ‘Yes’ or ‘No’.

If the specified value is “Yes” then writing to the memory of Virtual Machine is stopped while creating the Snapshot.

Also, refer Note above.


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