...
- 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:
- use a Get Host activity to extract the HostID:
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.
...
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..
...
- .
...
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.
...
In order to extract the values from the OutputVMs collection, For Each and Get Element From Collection activities should be used:
Execution: The example below is an execution where templates from the specified location are listed:
VM Mark as Template
This activity marks the specified Virtual Machine as Template.
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to mark as Template(Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Mount Tools Installer
This activity mounts Tools Installer for the specified virtual machine.
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to mount Tools Installer (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Move
This activity moves the specified virtual machine to the selected destination.
...
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Move activity:
VM Power Off
This activity stops a virtual machine that has already been added to a VMware vSphere server.
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to power off (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Power On
This activity starts a virtual machine that has been added to a VMware vSphere server and is not already running.
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to power on (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Reboot Guest
This activity reboots the guest operating system of the specified virtual machine.
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset the guest information (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Refresh Storage Info
This activity refreshes Storage Info for the specified virtual machine.
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to refresh storage information (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Reload
This activity reloads the specified virtual machine.
...
VM Remove
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 (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
VM Remove All Snapshots
This activity removes All Snapshots of the specified virtual machine
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to remove all snapshots (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Remove Snapshot
This activity removes the specified Snapshot from the existing virtual machine.
...
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Remove Snapshot activity:
VM Rename
This activity renames the specified virtual machine.
...
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Rename 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 (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Reset Guest Information
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset the guest information (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Revert to Current Snapshot
...
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Revert to Current Snapshot 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 (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
- Width (text box editor type) (type: string): the Screen Width. For example: 1920.
VM Shut Down Guest
This activity shuts down the Guest Operating System of the specified virtual machine.
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to shut down guest OS (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Standby Guest
This activity stands By Guest of the specified virtual machine.
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to standby guest OS (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Suspend
This activity suspends the specified virtual machine.
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to suspend (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Take Snapshot
This activity takes a snapshot of the specified virtual machine.
...
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the VM Take Snapshot activity:
VM Unmount Tools Installer
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to unmount Tools installer (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Unregister
This activity unregisters the specified virtual machine.
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to unregister (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Upgrade Tools
This activity upgrades Tools for the specified virtual machine.
...
- Installer Options (text box editor type) (type: string): the Installer Options that you want to upgrade.
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to upgrade Tools (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity).
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Upgrade Version
This activity upgrades Version of the specified virtual machine.
...