Versions Compared

Version Old Version 31 New Version 32
Changes made by

Silvia Neag (Unlicensed)

Silvia Neag (Unlicensed)

Saved on

Key

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

...

...

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

Image RemovedImage Added

Parameters:

  • Cluster Name (text box editor type) (type: string): the name of the Cluster (only necessary if 'Host' parameter is empty).
  • Customization Name (text box editor type) (type: string): the name of the customization you wish to apply (optional).
  • Datacenter Name (text box editor type) (type: string): specify the datacenter name when using Host and Network Name parameters if a different network adapter is desired than the one from the template.
  • Datastore Name (text box editor type) (type: string): the Datastore name (optional).
  • Disk Mode (combo box control) (type: string): the Disk Mode.
  • Folder Fullpath (text box editor type) (type: string): the folder where you want to place the new virtual machine; 'Folder ID' parameter takes precedence over this parameter. If no value is provided for both 'Folder ID' and 'Folder Fullpath' parameters, the new VM will be created in the same location as the initial Template.
  • Folder ID (text box editor type) (type: string): the ID of the folder where you want to place the new virtual machine. If no value is provided for both 'Folder ID' and 'Folder Fullpath' parameters, the new VM will be created in the same location as the initial Template.
  • Host (text box editor type) (type: string): the Host (IP address) where you want to create the new virtual machine (optional).
  • Network Name (text box editor type) (type: string): the network name for the Ethernet Device. If left empty it will set the first network found in the current environment.
  • New VM Name (text box editor type) (type: string): the name for the new virtual machine.
  • Port Group Key (text box editor type) (type: string): the Port Group Key ID of the network adapter which you want to set for the new virtual machine. Only needed when dvPortGroup network type is selected. (Optional) Bind the value to the output 'PortGroupKey' from 'GetNetworkAdapterProperties' activity.
  • VM (text box editor type) (type: string): the input template virtual machine (enter the ID of the VM or the output from a VM Get 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 VM field from VM Deploy activity:
      Image Added

  • VM Network Type (combo text box controleditor type) (type: string): the network adapter type for the virtual machine.
  • Wait (combo text box controleditor 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 VM ID (type: string): outputs the new virtual machine ID.
 

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 Deploy activity:

Image Removed

 

 Execution: The example below is an execution where a new vm will be deployed after a given template:

Image Added



VM Disable Secondary

...

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

Image Removed

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to edit (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 Edit activity:
      Image Added

Boot Options (parameters):

...

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


Execution: The example below is an execution where the virtual machine with ID vm-25 is edited:

Image Added

 

VM Enable Secondary

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

...

  • 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:
    • bind the obtained HostID (stored in variable) to the HostID field from VM Enable Secondary activity:   
  • 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. 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:
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Enable Secondary activity:
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to make the call to enable the secondary virtual machine.
    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 Enable Secondary 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 Exists

This activity verifies if the specified virtual machine exists.

...

 

 

Execution: The example below is an execution where True is returned for virtual machine with ID: vm-25:

 

VM Export

This activity exports the specified virtual machine.

...

Execution: The example below is an execution where the ID for DemoWin7 virtual machine:

Image Modified

 

VM Get Parent

This activity gets and returns the specified virtual machine's parents.

...

 

 

Execution: The example below is an execution where the parents IDs for DemoWin7 virtual machine are returned:

 

 

VM Get Status

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

...

 

In order to extract the values from the OutputStatus collection, For Each and Log Track Data activities should be used:

 

Execution: The example below is an execution where the status details for DemoWin7 virtual machine are returned:

Image Modified

VM Get Storage Usage

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

Activity Parameters

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


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

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

 

Execution: The example below is an execution where the storage usage for DemoWin7 virtual machine is returned:

Image Modified

VM List

This activity lists all virtual machines from the specified location.

...

 

In order to extract the values from the OutputVMsList collection, For Each and Log Track Data activities should be used:

 


Execution: The example below is an execution where all VMs are listed from the specified location:

Image Modified

 

 

 

VM List All Snapshots

This activity lists all the existing Snapshots from the existing virtual machine.

...

In order to extract the values from the OutputSnapshots collection, For Each and Log Track Data activities should be used:

 

Execution: The example below is an execution where snapshots are listed for virtual machine with ID vm-25:

Image Modified

 

VM List from Host

This activity lists all virtual machines on a specified Host.

...

 

In order to extract the values from the OutputVMs collection, For Each and Get Element from Collection activities should be used:
 

 

Execution: The example below is an execution where vms from host 10.201.0.51 are listed:

Image Modified

 

 

 

VM List Templates

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

...

 

In order to extract the values from the OutputVMs collection, For Each and Get Element From Collection activities should be used:
 

 

Execution: The example below is an execution where templates from the specified location are listed:

Image Modified

 

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.
    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 Mark As Template  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.
    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:
        
  • 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.

...

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

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

 

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

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:

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:



 

 

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

...

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

 


  

VM Rename

This activity renames the specified virtual machine.

...

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

This activity resets the specified virtual machine.

...

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

...

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

...

  • 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:
  • 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 Tools

...

Status

This activity unmounts Tools Installer for the selected virtual machineverifies the specified virtual machines tools status.

Activity Parameters

The VM Unmount Tools Installer 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 you want to 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:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Tools Status activity:
      Image Added

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

  • Output (type: string): outputs the current status of VMware Tools running in the guest operating system. One of these strings will be returned, each having a different meaning: 'toolsNotInstalled' , 'toolsNotRunning' , 'toolsOK' , 'toolsOld'.
  • Output Running Status (type: string): outputs the running status of VMware Tools running in the guest operating system. One of these strings will be returned, each having a different meaning: 'guestToolsExecutingScripts' , 'guestToolsNotRunning' , 'guestToolsRunning'.
 

 

Execution: The example below is an execution where tools status is returned for virtual machine with ID: vm-25:

Image Added

 

 

 

VM Unmount Tools Installer

This activity unmounts Tools Installer for the selected virtual machine.

Activity Parameters

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

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

Activity Parameters

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

...

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

Activity Parameters

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

...

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

Activity Parameters

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

...

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

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

 

  • 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:
      Image Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Suspend 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.