Content Comparison

...

Execution: The example below is an execution where a new vm is created with given specifications:

VM Create Screenshot

This activity creates a screenshot of the specified virtual machine.

Activity Parameters

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

Parameters:

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to create screenshot.
  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 Create Screenshot 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 Create Secondary

This activity creates secondary virtual machine for the specified virtual machine.

Activity Parameters

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

Image RemovedImage Added

Parameters:

• Host (text box editor type) (type: string): the name of the host.
• Host ID (text box editor type) (type: string): the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
  The value can also be obtained from activity: Get Host using the following steps:
  • use a Get Host activity to extract the HostID:
    Image Added
  • bind the obtained HostID (stored in variable) to the HostID field from VM Create Secondary activity:   
    Image Added
• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to create secondary virtual machine (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).Wait (text box editor type) (.
  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 Create Secondary 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 variablesImage Removed

• .

Below is an example of predefined arguments, ready to be used by the VM Create Secondary activity:

• 
  
  

 

VM Customize

This activity customize a virtual machine using a designated script.

Activity Parameters

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

Image RemovedImage Added

Parameters:

• Customization Spec (text box editor type) (type: string): the customization spec that will be used to customize the virtual machine.
• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to customize (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).

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

• Output .
  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 Customize activity:
    Image Added

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

• Output (type: string): outputs the result message from the editing action.

 

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 Customize 

activity:Image Removed 

VM

 VM Defragment All Disks

This activity defragments all disks of the specified virtual machine.

Activity Parameters

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

Image RemovedImage Added

Parameters:

• Virtual Device Name (text box editor type) (type: string): the virtual machine you want to have all disks defragmented(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 Defragment Disks 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 Deploy

This activity deploys a new VM from an existing template.

...

VM Disable Secondary

This activity disables secondary virtual machine of the specified virtual machine.

...

The VM Disable Secondary 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 'Host IP' parameter is ignored.
  The value can also be obtained from activity: Get Host using the following steps:
  • use a Get Host activity to extract the HostID:
    Image Added
  • bind the obtained HostID (stored in variable) to the HostID field from VM Disable Secondary activity:   
    Image Added
• Host Name (text box editor type) (type: string): the name of the host.
• S Virtual Machine ID (text box editor type) (type: string): the secondary virtual machine you want to enable(Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity). This field must specify a . This field must specify a secondary virtual machine that is part of the fault tolerant group that this virtual machine is currently associated with. It can only be invoked from the primary virtual machine in the group.
  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 Disable Secondary activity:
    Image Added
• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to make the call to disable the secondary virtual machine (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 Disable Secondary 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  VM Edit

This activity edits the specified virtual machine.

...

• Output (type: string): outputs the result message from the editing action.

VM Enable Secondary

This activity enables secondary virtual machine of the specified virtual machine.

...

The VM Enable Secondary 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 'Host IP' parameter is ignored..: string): the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
  The value can also be obtained from activity: Get Host using the following steps:
  • use a Get Host activity to extract the HostID:
    Image Added
  • bind the obtained HostID (stored in variable) to the HostID field from VM Enable Secondary activity:   
    Image Added
• Host Name (text box editor type) (type: string): the name the name of the host.
• S Virtual Machine ID (text box editor type) (type: string): the secondary the secondary virtual machine you want to enable(Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity). This field must specify a secondary virtual machine that is part of the fault tolerant group that this virtual machine is currently associated with. It can only be invoked from the primary virtual machine in the group.in the group.
  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 Enable Secondary activity:
    Image Added
• Virtual Machine ID (text box editor type) (type: string): the virtual the virtual machine you want to make the call to enable the secondary virtual machine (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 Enable Secondary activity:
    Image Added
    
    
• Wait (text box editor type) (type: string): if  if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
  

...

• .

...

VM Exists

This activity verifies if the specified virtual machine exists.

...

• Output (type: string): outputs 'true' if the specified VM exists, otherwise 'false'.

VM Export

This activity exports the specified virtual machine.

...

VM Get Status

This activity retrieves the state and other related information about a virtual machine.

...

VM Get Storage Usage

This activity retrieves a subset of the storage information of this virtual machine.

Activity Parameters

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

Parameters:

• VirtualMachine ID (text box editor type) (type: string): the ID of the Virtual Machine for which you want to retrieve the storage usage information.
  
  

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 Get Storage Usage activity:

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

• Output Commited (type: collection<string>): outputs a collection of information about the total storage space, commited to the VM across all datastores. 
• Output Uncommited (type: collection<string>): outputs a collection of information about the additional storage space, potentially used by the VM across all datastores. 
• Output Unshared (type: collection<string>): outputs a collection of information about the total storage space occupied by the VM across all datastores that is not shared with any other VM.

VM List

This activity lists all virtual machines from the specified location.

...

• Output (type: collection<string>): outputs a collection of Snapshots .To use the elements of the collection, use Get Element From Collection activity where the Input Collection parameter should be bound to this parameter.

VM List from Host

This activity lists all virtual machines on a specified Host.

...

• Output (type: collection<collection<string>>): outputs a collection of VMs and their IDs.To use the elements of the collection, use Get Element From Collection activity where the Input Collection parameter should be bind with this parameter.
• Output Rows Count (type: int32): outputs Rows Count.
  
  

 

 

VM List Templates

This activity gets the list of VM templates from the specified location.

...

• Output (type: collection<collection<string>>): outputs a collection of Templates and their IDs.To use the elements of the collection, use Get Element From Collection activity where the Input Collection parameter should be bind with this parameter.
• Output Row Count (type: int32): outputs Rows Count.

VM Mark as Template

This activity marks the specified Virtual Machine as Template.

...

• 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).
• 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 Mount Tools Installer

This activity mounts Tools Installer for the specified virtual machine.

...

• 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).
• 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 Move

This activity moves the specified virtual machine to the selected destination.

...

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:

VM Power Off

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

...

• 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).
• 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 Power On

This activity starts a virtual machine that has been added to a VMware vSphere server and is not already running.

...

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

VM Reboot Guest

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

...

• 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 Refresh Storage Info

This activity refreshes Storage Info for the specified virtual machine.

...

• 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) (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 Reload

This activity reloads the specified virtual machine.

...

VM Remove All Snapshots

This activity removes All Snapshots of the specified virtual machine

...

• 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).
• 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 Snapshot

This activity removes the specified Snapshot from the existing virtual machine.

...

VM Rename

This activity renames the specified virtual machine.

...

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

...

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.

...

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.

...