Versions Compared

Key

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

...

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.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Mount Tools Installer activity:
        Image RemovedImage 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.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Move activity:
        Image RemovedImage 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 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 .
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Power Off activity:
       Image RemovedImage 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 .
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Power On activity:
       Image RemovedImage Added 

 

VM Reboot Guest

...

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.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reboot Guest activity:
       Image RemovedImage 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.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Refresh Storage Info activity:
        Image RemovedImage 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.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reload activity:
    •  Image RemovedImage 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 RemovedImage 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:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Remove activity:
      Image RemovedImage 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.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Remove All Snapshots activity:
      Image RemovedImage 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.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Remove Snapshot activity:
      Image RemovedImage 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 Rename activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • New Virtual Machine Name (text box editor type) (type: string): the new name for the specified virtual machine.
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to rename.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Rename activity:
      Image RemovedImage 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 Reset 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 value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reset activity:
      Image RemovedImage 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 Reset Guest Information 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.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reset Guest Information activity:
      Image RemovedImage 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 Revert to Current Snapshot activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Host ID (text box editor type) (type: string): the ID of the host. If you enter a value for this parameter, the 'HostName' parameter is ignored.
  • Host Name (text box editor type) (type: string): the host name.
  • Suppress Power On (combo box control) (type: string): if set to Yes, the virtual machine will not be powered on regardless of the power state when the current snapshot was created. Default to No.
  • Suppress Power On Specified (combo box control) (type: string): suppress Power On Specified.
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to revert to current snapshot.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Revert To Current Snapshot activity:
      Image RemovedImage 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 Set Display Resolution activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • 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.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Set Screen Resolution activity:
      Image RemovedImage 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.
  • Width (text box editor type) (type: string): the Screen Width. For example: 1920.

...

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

Image Added

Image Removed 

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to shut down guest OS.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Shutdown Guest activity:
      Image RemovedImage 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 Standby 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 standby guest OS.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Standby Guest activity:
      Image RemovedImage 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 Suspend 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 suspend.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Suspend activity:
      Image RemovedImage 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 Take Snapshot activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Memory (text box editor type) (type: string): if set to True and if the virtual machine is currently powered on, the virtual machine's memory state is preserved with the snapshot.
  • Quiesce (text box editor type) (type: string): if Quiesce is set to True and the virtual machine is powered on when the snapshot is taken, VMware Tools is used to quiesce the file system in the virtual machine. This assures that a disk snapshot represents a consistent state of the guest file systems. If the virtual machine is powered off or VMware Tools are not available, the quiesce flag is ignored.
  • Snapshot Description (text box editor type) (type: string): the snapshot description.
  • Snapshot Name (text box editor type) (type: string): the snapshot name.
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to take snapshot of.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Take Snapshot activity:
      Image RemovedImage 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 Tools Status 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 for which the tools status will be checked. 
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Tools Status activity:
      Image RemovedImage Added

The Read Only Output variable are the possible output values that the activity will provide:

...

The VM Unmount 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 unmount Tools 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:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Unmount Tools Installer activity:
      Image RemovedImage 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 Unregister 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 unregister.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Unregister activity:
      Image RemovedImage 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 Upgrade Tools activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • 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.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Upgrade Tools activity:
      Image RemovedImage 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 Upgrade Version activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • New Version (text box editor type) (type: string): the new version for the specified virtual machine.
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to upgrade Version. 
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Upgrade Version activity:
      Image RemovedImage 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.

 

...

  • use a Get VM activity to extract the VM ID:
    Image Removed
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Suspend activity:
    Image Removed

...