Versions Compared

Version Old Version 5 New Version 6
Changes made by

Silvia Neag (Unlicensed)

Silvia Neag (Unlicensed)

Saved on

Key

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

Activities




 

 

Clone VApp

This activity creates a clone of a VApp.

Activity Parameters

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

...

Execution: The example below is an execution where a vApp will be cloned after Demo_vApp_Flowster vApp:

Image Modified

Create VApp

This activity creates a new VApp.

Activity Parameters

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

Parameters:

  • Location (text box editor type) (type: string): the folder path where the new vApp will be created. This parameter is needed only when the new vApp won't be child of another vApp. E.g. "Datacenter/vm/DemoFolder/vApps". 
  • LocationByID (text box editor type) (type: string): the folder ID where the new vApp will be created. This parameter is needed only when the new vApp won't be child of another vApp. E.g. "folder-20".
  • New vApp Name (text box editor type) (type: string): the new vApp name that will be created.
  • Parent Resource Pool ID (text box editor type) (type: string): the ID of the parent resource pool where the vApp will be created. If this parameter is used, Parent vApp ID field is ignored. E.g. "respool-30".
    The value can also be obtained from activity: Get Resource Pool using the following steps:
    • use a Get Resource Pool activity to extract the ResourcePoolID: 
       
    • bind the obtained ResourcePoolID(stored in variable) to the Parent Resource Pool ID field from Create vApp activity:
         
  • Parent vApp ID (text box editor type) (type: string): the ID of the parent vApp to be used.
    The value can also be obtained from activity: Get vApp using the following steps:
    • use a Get vApp activity to extract the vAppID: 
       
    • bind the obtained vAppID(stored in variable) to the vApp ID field from Create vApp activity:  

Resources (parameters):

  • CPU Limit (text box editor type) (type: int32): limit the utilization of the resource pool,and it will not exceed it even if there are available resources. This is typically used to ensure a consistent performance of resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MHz. E.g. 40 and this number should be higher than CPU reservation parameter.
  • CPU Reservation (text box editor type) (type: int32): amount of resource that is guaranteed available to the resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MHz. E.g. 20 and this number should be lower than CPU Limit parameter.
  • CPU Shares (text box editor type) (type: int32): the number of shares allocated. Used to determine resource allocation in case of resource contention. This value is only set if level is set to custom. If level is not set to custom, this value is ignored. Therefore, only shares with custom values can be compared.
  • CPU Shares Level (combo box control) (type: string): set the allocation level, it is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as custom.If custom -> Shares value is specified in the 'shares' parameter, if high -> Shares = 2000 * number of virtual CPUs, if low -> Shares = 500 * number of virtual CPUs, or if normal -> Shares = 1000 * number of virtual CPUs
  • Expandable CPU Reservation (combo box control) (type: string): in a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation.
  • Expandable Memory Reservation (combo box control) (type: string): in a resource pool with an expandable reservation, the reservation on a resource pool can grow beyond the specified value, if the parent resource pool has unreserved resources. A non-expandable reservation is called a fixed reservation.
  • Memory Limit (text box editor type) (type: int32): limit the utilization of the resource pool,and it will not exceed it even if there are available resources. This is typically used to ensure a consistent performance of resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB. E.g. 40 and this number should be higher than Memory reservation parameter.
  • Memory Reservation (text box editor type) (type: int32): amount of resource that is guaranteed available to the resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB. E.g. 20 and this number should be lower than Memory Limit parameter.
  • Memory Shares (text box editor type) (type: int32): the number of shares allocated. Used to determine resource allocation in case of resource contention. This value is only set if level is set to custom. If level is not set to custom, this value is ignored. Therefore, only shares with custom values can be compared.
  • Memory Shares Level (combo box control) (type: string): this is the allocation level, it is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as custom.


 

 

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

  • Output VApp Id (type: string): outputs the ID of the new created vApp.
     
 

Get Annotations

This activity retrieves a list of all the Annotations of the specified object (Virtual machine, ..).

Activity Parameters

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

...

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

 

Execution: The example below is an execution where all annotation are returned for object of type VirtualMachine with ID vm-25:

 

 

Get Attributes

This activity retrieves a list of all the Attributes of the specified object (Virtual machine, Folder, ..).

Activity Parameters

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

...

  • Output (type: collection<collection<string>>): outputs a collection of Attributes (name and value).To use the elements of the collection, use Get Element From Collection activity where the Input Collection parameter should be bound to this parameter.
  • Output Attribute (type: string): outputs selected attribute value.
  • Output Rows Count (type: int32): outputs Rows Count.

 

 

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


 

Execution: The example below is an execution where "name,config" attributes are returned for object of type VirtualMachine with ID vm-25:

Get VApp

This activity returns the id of a specified VApp.

Activity Parameters

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

...

Execution: The example below is an execution where the ID for Demo_vApp_Flowster vApp is returned:

 

Set Annotation

This activity sets value for the specified Annotation of selected object (Virtual machine, ..).

Activity Parameters

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

...

 


Execution: The example below is an execution where a new value is set for DemoAnno annotation for object of type VirtualMachine with ID vm-25:

Image Modified

 

Set Description

This activity sets value of Description field of selected object(Virtual machine, ..).

Activity Parameters

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

...

 

Execution: The example below is an execution where a new description is set for object of type VirtualMachine with ID vm-25:

Image Modified

 

 

 

Set Field

This activity sets value of specified field of selected object(Virtual machine, ..).

Activity Parameters

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

...

Execution: The example below is an execution where a new value is set for field with key 1 for object of type VirtualMachine with ID vm-25:

Image Modified



 

VM Answer

This activity responds to a question that is blocking the specified virtual machine.

Activity Parameters

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

...

  • Answer Choice (text box editor type) (type: string): the answer choice. E.g "1" to select the first answer choice set for the specified VM. 
  • Question ID (text box editor type) (type: string): the question ID for which the answer is needed. E.g. "12" is the question ID set for the specified VM. 
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine ID.
    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 Answer 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 Clone

This activity clones a virtual machine from a specified virtual machine on Host.

Activity Parameters

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

...

Execution: The example below is an execution where a new vm is cloned after DemoWin7 virtual machine:

Image Modified

 

VM Create

This activity creates a new virtual machine on Host.

Activity Parameters

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

...


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:

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


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.
    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 Customize activity:

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.
 

 


 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:

Parameters:

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

This activity deploys a new VM from an existing template.

Activity Parameters

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

...

 

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



VM Disable Secondary

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

Activity Parameters

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

...

  • 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 Disable 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 disable. 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 SVirtualMachine ID field from VM Disable Secondary activity:
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to make the call to disable 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 Disable 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 Edit

This activity edits the specified virtual machine.

Activity Parameters

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

...


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

Image Modified

 

VM Enable Secondary

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

Activity Parameters

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

...

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

Activity Parameters

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

...

 

 

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.

Activity Parameters

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

...

Use the following workflow logic as example to iterate through the elements of the list. For more information on how to use Custom ForEach activity please check Workflow link. At the end of the sequence, LogTrackData activity is used to display OutputOVFPath value.

 

 

VM Get

This activity gets and returns the specified virtual machine.

Activity Parameters

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

...

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.

Activity Parameters

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

...

 

 

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.

Activity Parameters

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

...

 

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.

Activity Parameters

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

...

 

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.

Activity Parameters

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

...

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

 

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

 

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.

Activity Parameters

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

...

 

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.

Activity Parameters

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

...

 

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.

Activity Parameters

The VM Mark as Template 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 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.

Activity Parameters

The VM Mount Tools Installer 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 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.

Activity Parameters

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

...

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

Activity Parameters

The VM Power Off 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 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.

Activity Parameters

The VM Power On 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 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.

Activity Parameters

The VM Reboot Guest 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 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.

Activity Parameters

The VM Refresh Storage Info 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 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.

Activity Parameters

The VM Reload 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 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:
    •  
  • 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:

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

Activity Parameters

The VM Remove All Snapshots 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 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.

Activity Parameters

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

...

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

 


  

VM Rename

This activity renames the specified virtual machine.

Activity Parameters

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

...

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

Activity Parameters

The VM Reset 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 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

This activity resets the Guest Operating System Information of the specified virtual machine.

Activity Parameters

The VM Reset Guest Information 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 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

This activity reverts to Current Snapshot the specified virtual machine.

Activity Parameters

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

...

  • 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

This activity sets the Display Resolution of the console window for the selected virtual machine.

Activity Parameters

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

...

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

Activity Parameters

The VM Shut Down Guest 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 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.

Activity Parameters

The VM Standby Guest 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 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.

Activity Parameters

The VM Suspend 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 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.

Activity Parameters

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

...

  • 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 verifies the specified virtual machines tools status.

Activity Parameters

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

...

 

 

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

 

 

 

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:

...

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

...