Content Comparison

...

VM List

This activity lists all virtual machines from the specified location.

...

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

Image RemovedImage Added

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.

...

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

Image Removed Image Removed

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

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

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

Image Added Image Added

VM List All Snapshots

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

...

VM List from Host

This activity lists all virtual machines on a specified Host.

...

VM List Templates

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

...

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

Image RemovedImage Added

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.
   

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

...

...

VM Mark as Template

This activity marks the specified Virtual Machine as Template.

...

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to mark as Template.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Mark As Template  activity:
      
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Mount Tools Installer

This activity mounts Tools Installer for the specified virtual machine.

...

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to mount Tools Installer.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Mount Tools Installer activity:
      
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Move

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

...

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

VM Power Off

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

...

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to power off .
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Power Off activity:
      
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Power On

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

...

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

VM Reboot Guest

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

...

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset the guest information.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reboot Guest activity:
      
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Refresh Storage Info

This activity refreshes Storage Info for the specified virtual machine.

...

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to refresh storage information.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Refresh Storage Info activity:
      
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Reload

This activity reloads the specified virtual machine.

...

VM Remove All Snapshots

This activity removes All Snapshots of the specified virtual machine

...

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to remove all snapshots.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Remove All Snapshots activity:
    
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Remove Snapshot

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

...

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

VM Rename

This activity renames the specified virtual machine.

...

• New Virtual Machine Name (text box editor type) (type: string): the new name for the specified virtual machine.
• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to rename.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Rename activity:
    
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Reset

This activity resets the specified virtual machine.

...

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reset activity:
    
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Reset Guest Information

...

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset the guest information.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Reset Guest Information activity:
    
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Revert to Current Snapshot

...

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

VM Set Display Resolution

...

• Height (text box editor type) (type: string): the Screen Height.For example: 1080.
• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to set screen resolution.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Set Screen Resolution activity:
    
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
• Width (text box editor type) (type: string): the Screen Width. For example: 1920.

VM Shut Down Guest

This activity shuts down the Guest Operating System of the specified virtual machine.

...

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to shut down guest OS.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Shutdown Guest activity:
    
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Standby Guest

This activity stands By Guest of the specified virtual machine.

...

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to standby guest OS.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Standby Guest activity:
    
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Suspend

This activity suspends the specified virtual machine.

...

• Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to suspend.
  The value can also be obtained from activity: Get VM using the following steps:
  • use a Get VM activity to extract the VM ID:
    
  • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Suspend activity:
    
• Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.

VM Take Snapshot

This activity takes a snapshot of the specified virtual machine.

...

VM Unmount Tools Installer

...

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

...

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

...

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

...