Activities

Clone VApp
Create VApp
Get Annotations
Get Attributes
Get VApp
Set Annotation
Set Description
Set Field
VM Answer
VM Clone
VM Create
VM Create Screenshot
VM Create Secondary
VM Customize
VM Defragment All Disks
VM Deploy
VM Disable Secondary
VM Edit
VM Enable Secondary
VM Exists
VM Export
VM Get
VM Get Parent
VM Get Status
VM Get Storage Usage
VM List
VM List All Snapshots
VM List from Host
VM List Templates
VM Mark as Template
VM Migrate
VM Mount Tools Installer
VM Move
VM Power Off
VM Power On
VM Reboot Guest
VM Refresh Storage Information
VM Reload
VM Remove
VM Remove All Snapshots
VM Remove Snapshot
VM Rename
VM Reset
VM Reset Guest Information
VM Revert to Current Snapshot
VM Revert to the given Snapshot
VM Set Display Resolution
VM Shut Down Guest
VM Standby Guest
VM Suspend
VM Take Snapshot
VM Tools Status
VM Unmount Tools Installer
VM Unregister
VM Upgrade Tools
VM Upgrade Version

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:

Parameters:

New vApp Name (text box editor type) (type: string): the new vApp name that will be created as a clone of the input vApp.
vApp ID (text box editor type) (type: string): the ID of the vApp to be used in the cloning process.
The value can also be obtained from activities: Create vApp or Get vApp using the following steps:
- use a Get vApp/ Create vApp activity to extract the vAppID:
- bind the obtained vAppID(stored in variable) to the vApp ID field from Clone vApp activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow execution to complete before moving to the next activity.

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, clone after the vApp specified in vApp ID field.

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

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:

Parameters:

Object ID (text box editor type) (type: string): the ID of the Object for which you want to retrieve the annotations (MoRef).
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 Get Annotations activity:
Object Type (combo box control) (type: string): the type of the Object. Flowster Studio provides the following options:
- VirtualMachine
- Folder
- Resource Pool
- VMHost
- Cluster
- Datacenter
Selected Annotation (text box editor type) (type: string): enter an annotation. E.g "DemoAnno".

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

Output (type: collection<collection<string>>): outputs a collection of Annotations (name and value).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 Annotation (type: string): outputs selected annotation value.
Output Rows Count (type: int32): outputs Rows Count.

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:

Parameters:

Attributes to be Retrieved (text box editor type) (type: string): a list of comma separated attributes you want to retrieve (example: "name,config").
Object ID (text box editor type) (type: string): the ID of the Object for which you want to retrieve the Attributes.
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 Get Attributes activity:
Object Type (combo box control) (type: string): the type of the Object. Flowster Studio provides the following options:
- VirtualMachine
- Folder
- Resource Pool
- VMHost
- Cluster
- Datacenter
Selected Attribute (text box editor type) (type: string): the attribute to be retrieved (example: "config").

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

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:

Parameters:

Cluster Name (text box editor type) (type: string): the name of the cluster where the vApp is stored.
Datacenter Name (text box editor type) (type: string): the name of the datacenter where the vApp is located.
Path (text box editor type) (type: string): the path where the desired vApp is. E.g "vAppRoot/vAppChild".

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

Output (type: string): outputs the ID of the vApp.

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:

Parameters:

Annotation Name (text box editor type) (type: string): the name of the Custom Attribute that you want to set.
Annotation New Value (text box editor type) (type: string): the new value for the annotation.
Object ID (text box editor type) (type: string): the ID of the Object for which you want to retrieve the Attributes.
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 Set Annotation activity:

Object Type (combo box control) (type: string): the type of the Object. Flowster Studio provides the following options:
- - VirtualMachine
  - Folder
  - Resource Pool
  - VMHost
  - Cluster
  - Datacenter

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:

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:

Parameters:

Description New Value (text box editor type) (type: string): the new value for the 'Description' property of the object.
Object ID (text box editor type) (type: string): the ID of the Object for which the Description is to be edited.
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 Set Description activity:
Object Type (combo box control) (type: string): the type of the Object. Flowster Studio provides the following options:
- - VirtualMachine
  - Folder
  - Resource Pool
  - VMHost
  - Cluster
  - Datacenter

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

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:

Parameters:

Field Key (text box editor type) (type: string): the key (int value) of field you want to set.
Field Value (text box editor type) (type: string): the new value for the field.
Object ID (text box editor type) (type: string): the ID of the Object for which the Field value is to be edited.
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 Set Field activity:
Object Type (combo box control) (type: string): the type of the Object. Flowster Studio provides the following options:
- - VirtualMachine
  - Folder
  - Resource Pool
  - VMHost
  - Cluster
  - Datacenter
Object Type (combo box control) (type: string): the type of the Object (Folder, VirtualMachine, ..).

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:

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:

Parameters:

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

Parameters:

Location By 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, the new VM will be created in the same location as the initial VM.
New VM Name (text box editor type) (type: string): the name for the new virtual machine.
VM (text box editor type) (type: string): the input virtual machine to clone. 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 Clone activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow execution to complete before moving to the next activity.

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

Output VM ID (type: string): outputs the new virtual machine ID.

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

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:

Parameters:

Datacenter (text box editor type) (type: string): the datacenter root name.
Datastore (text box editor type) (type: string): the datastore name where you want to place the new virtual machine.
Disk Provisioning (combo box control) (type: string): the virtual disk provisioning mode.Flowster Studio provides the following options:
- Thick Provision Lazy Zeroed: Creates a virtual disk in a default thick format. Space required for the virtual disk is allocated when the virtual disk is created. Data remaining on the physical device is not erased during creation, but is zeroed out on demand at a later time on first write from the virtual machine.
- Thick Provision Eager Zeroed: A type of thick virtual disk that supports clustering features such as Fault Tolerance. Space required for the virtual disk is allocated at creation time. In contrast to the flat format, the data remaining on the physical device is zeroed out when the virtual disk is created. It might take much longer to create disks in this format than to create other types of disks.
- Thin Provision: Use this format to save storage space. For the thin disk, you provision as much datastore space as the disk would require based on the value that you enter for the disk size. However, the thin disk starts small and at first, uses only as much datastore space as the disk needs for its initial operations.
Disk MB (text box editor type) (type: string): the size in MB of the disks that you want to create and add to the new virtual machine.
Guest ID (text box editor type) (type: string): the guest operating system id of the new virtual machine.
Host (text box editor type) (type: string): the host on which you want to create the new virtual machine.
Location (text box editor type) (type: string): the folder where you want to place the new virtual machine.For example: root/folder/sub-folder.
Location By ID (text box editor type) (type: string): the ID of the folder where you want to place the new virtual machine. If you enter a value for this parameter, the 'Location' parameter is ignored.
Memory MB (text box editor type) (type: string): the memory size in MB of the new virtual machine.
New VM Name (text box editor type) (type: string): the name for the new virtual machine. If you are registering or cloning an existing virtual machine, this parameter is not mandatory.
Num CPU (text box editor type) (type: string): the number of the virtual CPUs of the new virtual machine.
VM Description (text box editor type) (type: string): the description of the new virtual machine.
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow execution to complete before moving to the next activity.

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

Output (type: string): outputs the new virtual machine ID.

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

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.
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 VM field from VM Deploy activity:
VM Network Type (text box editor type) (type: string): the network adapter type for the virtual machine.
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow execution to complete before moving to the next activity.

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

Output VM ID (type: string): outputs the new virtual machine ID.

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:

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:
- 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 VirtualMachine 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 workflow 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:

Parameters:

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

Boot Options (parameters):

Boot Delay (text box editor type) (type: int64): the delay in milliseconds to add to the boot time of a virtual machine.
Boot Retry Delay (text box editor type) (type: int64): the retry delay in milliseconds to add to the boot time of a virtual machine.
Boot Retry Enabled (combo box control) (type: string): enable boot retry.
Enter BIOS Setup (combo box control) (type: string): if set to 'true', then the virtual machine will drop into BIOS setup upon the next boot. This flag will subsequently be reset to 'false' so that subsequent boots proceed normally.

General Settings (parameters):

Disable Acceleration (combo box control) (type: string): flag to turn off video acceleration for the virtual machine console window.
Disk UUID Enabled (combo box control) (type: string): whether disk UUIDs are being used by this virtual machine. If this flag is set to false, disk UUIDs are not exposed to the guest.
Enable Logging (combo box control) (type: string): enable logging for a virtual machine.
Memory (text box editor type) (type: int64): the size of the virtual machine's memory, in MB.
Number of CPUs (text box editor type) (type: int32): the number of virtual processors in the virtual machine.

Resources (parameters):

CPU Limit (text box editor type) (type: int64): limit the utilization of the virtual machine,and it will not exceed it even if there are available resources. This is typically used to ensure a consistent performance of virtual machines 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.
CPU Reservation (text box editor type) (type: int64): the amount of resource that is guaranteed available to the virtual machine. 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.
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.
Hyperthreaded Sharing (combo box control) (type: string): specifies how the VCPUs of a virtual machine are allowed to share physical cores on a hyperthreaded system. Two VCPUs are 'sharing' a core if they are both running on logical CPUs of the core at the same time.
Memory Limit (text box editor type) (type: int64): limit the utilization of the virtual machine,and it will not exceed it even if there are available resources. This is typically used to ensure a consistent performance of virtual machines 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.
Memory Reservation (text box editor type) (type: int64): the amount of resource that is guaranteed available to the virtual machine. 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.
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): 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.

Tools (parameters):

After Power On (combo box control) (type: string): whether or not scripts should run after the virtual machine powers on.
After Resume (combo box control) (type: string): whether or not scripts should run after the virtual machine resumes.
Before Guest Reboot (combo box control) (type: string): whether or not scripts should run before the virtual machine reboots.
Before Guest Shutdown (combo box control) (type: string): whether or not scripts should run before the virtual machine powers off.
Before Guest Standby (combo box control) (type: string): whether or not scripts should run before the virtual machine suspends.
Sync Time with Host (combo box control) (type: string): whether or not the tools program will sync time with the host time.

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.

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

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:

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

Parameters:

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

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

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

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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to export. E.g "vm-100".
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 Export activity:
Destination Folder Path (text box editor type) (type: string): the path of the folder where you wish to export the VM.

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

Output Devices Path (type: list<string>): outputs all the path to the devices found for the specified VM.
Output OVF Path (type: string): outputs the path to the OVF file.

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:

Parameters:

Location (text box editor type) (type: string): the location (full-path) where you want to search for the virtual machine. For example: root/vm/folder/subfolder.
Location ID (text box editor type) (type: string): the ID of the location where you want to search. If you enter a value for this parameter, the 'Location' parameter is ignored.
Location Type (text box editor type) (type: string): the type of the location (ex. 'Folder'). This parameter is used when the 'Location ID' parameter is not empty.
VM Name (text box editor type) (type: string): the name of the Virtual Machine.

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

Output (type: string): outputs the resulting VM ID. If the VM is not found, value is empty.

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

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:

Parameters:

VM ID (text box editor type) (type: string): the ID of the 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 Get Parent activity:

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

Output Cluster ID(type: string): outputs the ID of the vm's parent cluster. If the VM has no cluster parent, value is empty.
Output FullPath(type: string): outputs the FullPath of the parent folder.
Output Host ID(type: string): outputs the ID of the vm's parent host.
Output Parent Folder ID(type: string): outputs the ID of the vm's parent folder. If the VM has no folder parent, value is empty.

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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the ID of the virtual machine to retrieve the status for .
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 Status activity:

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

Output (type: collection<string>): outputs a collection containing information about the state of the 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:

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:

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:

Parameters:

Location (text box editor type) (type: string): the location where you want to search for VMs. For example root/folder/subfolder.
Location Type (text box editor type) (type: string): the type of the location (ex. 'Folder'). This parameter is used when the 'Location ID' parameter is not empty.
Location By ID (text box editor type) (type: string): the ID of the folder where you want to search. If you enter a value for this parameter, the 'Location' parameter is ignored.
No Recursion (text box editor type) (type: string): enter "true" to indicate that you want to disable the recursive behavior of the command.
PowerStateFilter (combobox editor type) (type: string): choose to filter the returned results by PowerState. Flowster Studio provides the following options:
- All
- poweredOn
- poweredOff
- suspended
VM Name (text box editor type) (type: string): this is an optional parameter, allowing to extract a specific VM ID for a specific VM Name. Insert the name of the VM for which the ID will be separately retrieved.

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

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.
Output Rows Count (type: string): outputs the ID of the VM specified in the VM Name field. This value will be displayed at the beginning of the Tracking Data, before the rest of the results.

Execution: the activity can be executed in two (2) different ways:

without a given VM Name: the activity will simply look for virtual machines in the given folder, outputting a list with all found vms and their IDs:
with a given VM Name: the activity will first search for the given VM Name and will output its ID, after that will get and output all other VMs located in the given location:

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

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:

Parameters:

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

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

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:

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

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:

Parameters:

Host IP (text box editor type) (type: string): the IP of Host where you want to search for VMs.
Host ID (text box editor type) (type: string): the ID of the host where you want to search. 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 List From Host activity:

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

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.

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:

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:

Parameters:

Location (text box editor type) (type: string): the location name. For example root/folder/folder.
Location Type (text box editor type) (type: string): the type of the location (ex. 'Folder'). This parameter is used when the 'Location ID' parameter is not empty.
Location By ID (text box editor type) (type: string): the ID of the folder where you want to search. If you enter a value for this parameter, the 'Location' parameter is ignored.
No Recursion (text box editor type) (type: string): if value 'true' is entered, the activity also returns results from the subfolders of the specified location.
Template Name (text box editor type) (type: string): this is an optional parameter, allowing to extract a specific VM Template ID for a specific VM Template Name. Insert the name of the Template VM for which the ID will be separately retrieved.

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

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.
Output Template ID (type: string): outputs the ID of the VM Template specified in the Template Name field. This value will be displayed at the beginning of the Tracking Data, before the rest of the results.

Execution: the activity can be executed in two (2) different ways:

without a given Template Name: the activity will simply look for templates in the given folder, outputting a list with all found templates and their IDs:
with a given Template Name: the activity will first search for the given Template Name and will output its ID, after that will get and output all other templates located in the given location:

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

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:

Parameters:

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 workflow execution to complete before moving to the next activity.

VM Migrate

This activity moves the specified virtual machine to another host and/or another datastore.

Activity Parameters

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

Parameters:

Datastore ID (text box editor type) (type: string): the ID of the datastore where you want to migrate the VM. If not specified, the current datastore is used. E.g. "datastore-10"
The value can also be obtained from activity: Get Datastore using the following steps:
- use a Get Datastore activity to extract the Datastore ID:
- bind the obtained Datastore ID (stored in variable) to the Datastore ID field from VM Migrate activity:
Host ID (text box editor type) (type: string): the ID of the host where you want to migrate the VM. E.g. "host-10"
The value can also be obtained from activity: Get Host using the following steps:
- use a Get Host activity to extract the Host ID:
- bind the obtained Host ID (stored in variable) to the Host ID field from VM Migrate activity:
Migration Type (combobox control)(type:string): specify the migration type in order to change the virtual machine's host. datastores or both.
ResourcePool ID (text box editor type) (type: string): the ID of the resource pool where you want to migrate the VM. This parameter will not be considered if the 'Datastore ID' is not specified. E.g. "resourcepool-10"
The value can also be obtained from activity: Get Resource Pool using the following steps:
- use a Get Resource Pool activity to extract the ResourcePool ID:
- bind the obtained Resource Pool ID (stored in variable) to the ResourcePool ID field from VM Migrate activity:
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 Migrate activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to mount Tools Installer.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Mount Tools Installer activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Destination (text box editor type) (type: string): the destination folder where you want to move the VM. For example: root/folder/subfolder.
Destination ID (text box editor type) (type: string): the ID of the folder where you want to move the VM. If you enter a value for this parameter, the 'Destination' parameter is ignored.
Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to move.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Move activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to power off .
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Power Off activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

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

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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset the guest information.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reboot Guest activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to refresh storage information.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Refresh Storage Info activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reload.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reload activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to remove all snapshots.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Remove All Snapshots activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Remove Children (combo box control) (type: string): whether to remove the entire snapshot subtree.
Snapshot Name (text box editor type) (type: string): the name of the existing Snapshot.
Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to remove all snapshots.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Remove Snapshot activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow execution to complete before moving to the next activity.

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

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:

Parameters:

New Virtual Machine Name (text box editor type) (type: string): the new name for the specified virtual machine.
Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to rename.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Rename activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reset activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset the guest information.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reset Guest Information activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Host ID (text box editor type) (type: string): the ID of the host. If you enter a value for this parameter, the 'HostName' parameter is ignored.
Host Name (text box editor type) (type: string): the host name.
Suppress Power On (combo box control) (type: string): if set to Yes, the virtual machine will not be powered on regardless of the power state when the current snapshot was created. Default to No.
Suppress Power On Specified (combo box control) (type: string): suppress Power On Specified.
Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to revert to current snapshot.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Revert To Current Snapshot activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow execution to complete before moving to the next activity.

VM Revert to the given Snapshot

This activity reverts to a given Snapshot the specified virtual machine.

Activity Parameters

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

Parameters:

Connection (text box editor type) (type: string): Contains the connection string for the VMware
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.
Snapshot ID (text box editor type) (type: string): the ID of the Snapshot. The value can be added manually or can be obtain by using VM List All Snapshots.
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.
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Height (text box editor type) (type: string): the Screen Height.For example: 1080.
Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to set screen resolution.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Set Screen Resolution activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to shut down guest OS.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Shutdown Guest activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to standby guest OS.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Standby Guest activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to suspend.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Suspend activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

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

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine for which the tools status will be checked.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Tools Status activity:

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:

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:

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

Parameters:

Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to unregister.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Unregister activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

Installer Options (text box editor type) (type: string): the Installer Options that you want to upgrade.
Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to upgrade Tools.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Upgrade Tools activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:

Parameters:

New Version (text box editor type) (type: string): the new version for the specified virtual machine.
Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to upgrade Version.
The value can also be obtained from activity: Get VM using the following steps:
- use a Get VM activity to extract the VM ID:
- bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Upgrade Version activity:
Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the workflow 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:
- 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 workflow execution to complete before moving to the next activity.

Browser not supported