Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The VM Mark as Template activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to mark as Template(Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity)..
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Mark As Template  activity:
        Image Added
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

...

The VM Mount Tools Installer activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to mount Tools Installer (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).Installer.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Mount Tools Installer activity:
        Image Added
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

...

The VM Move activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Destination (text box editor type) (type: string): the destination folder where you want to move the VM. For example: root/folder/subfolder.
  • Destination ID (text box editor type) (type: string): the ID of the folder where you want to move the VM. If you enter a value for this parameter, the 'Destination' parameter is ignored.
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to move(Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity)..
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Move activity:
        Image Added

  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Move activity:

Image Removed

 

 

 

VM Power Off

...

 

 

 

VM Power Off

This activity stops a virtual machine that has already been added to a VMware vSphere server.

...

The VM Power Off activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to power off (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity)..
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Power Off activity:
       Image Added 
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

...

The VM Power On activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to power on (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity..
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Power On activity:
       Image Added 

 

VM Reboot Guest

This activity reboots the guest operating system of the specified virtual machine.

...

The VM Reboot Guest activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset the guest information(Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).Wait (.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reboot Guest activity:
       Image Added 
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

...

The VM Refresh Storage Info activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to refresh storage information (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).Wait (text box editor type) (typeinformation.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Refresh Storage Info activity:
        Image Added
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

...

The VM Reload activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reload (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity)..
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reload activity:
    •  Image Added
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

...



VM Remove

This activity removes the specified virtual machine.

Activity Parameters

The VM Remove activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image Removed

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to remove (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).

arguments or variables:

Image Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to remove.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Remove activity:
      Image Added



 

 

VM Remove All Snapshots

...

The VM Remove All Snapshots activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to remove all snapshots (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity)..
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Remove All Snapshots activity:
      Image Added
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

...

The VM Remove Snapshot activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Remove Children (combo box control) (type: string): whether to remove the entire snapshot subtree.
  • Snapshot Name (text box editor type) (type: string): the name of the existing Snapshot.
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to remove all snapshots (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity)..
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Remove Snapshot activity:
      Image Added

  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

...

  • Output Status (type: string): outputs True if the operation succeeded, otherwise False.
 

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Remove Snapshot activity:

Image Removed

 

...


  

VM Rename

This activity renames the specified virtual machine.

...

 

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Rename activity:



 

VM Reset

This activity resets the specified virtual machine.

...

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.




 

VM Reset Guest Information

...

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset the guest information (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.




 

VM Revert to Current Snapshot

...

 

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Revert to Current Snapshot activity:



 

VM Set Display Resolution

...

  • Height (text box editor type) (type: string): the Screen Height.For example: 1080.
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to set screen resolution (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
  • Width (text box editor type) (type: string): the Screen Width. For example: 1920.

 



 

VM Shut Down Guest

This activity shuts down the Guest Operating System of the specified virtual machine.

...

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to shut down guest OS (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.




 

VM Standby Guest

This activity stands By Guest of the specified virtual machine.

...

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to standby guest OS (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.


 

 

VM Suspend

This activity suspends the specified virtual machine.

...

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to suspend (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.




 

VM Take Snapshot

This activity takes a snapshot of the specified virtual machine.

...

 

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Take Snapshot activity:

 

 

VM Unmount Tools Installer

...

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to unmount Tools installer (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.


 

 

VM Unregister

This activity unregisters the specified virtual machine.

...

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to unregister (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.




 

VM Upgrade Tools

This activity upgrades Tools for the specified virtual machine.

...

  • Installer Options (text box editor type) (type: string): the Installer Options that you want to upgrade.
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to upgrade Tools (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
  • Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.



 

VM Upgrade Version

This activity upgrades Version of the specified virtual machine.

...