...
- 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:
- use a Get Host activity to extract the HostID:
- 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 enabledisable. 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:
- use a Get VM activity to extract the VM ID:
- 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:
- use a Get VM activity to extract the VM ID:
- 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.
...
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 (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity)..
The value can also be obtained from activity: Get VM using the following steps:- use a Get VM activity to extract the VM ID:
- use a Get VM activity to extract the VM ID:
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.
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to export(Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity). E.g "vm-100"Destination .
The value can also be obtained from activity: Get VM using the following steps:- use a Get VM activity to extract the VM ID:
- use a Get VM activity to extract the VM ID:
- Destination Folder Path (text box editor type) (type: string): the path of the folder where you wish to export the VM.
...
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.
...
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.
...
- Output (type: string): outputs the resulting VM ID. If the VM is not found, value is empty.
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 Get activity:
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.
...
- VM ID (text box editor type) (type: string): the ID of the virtual machine. Can be inserted manually or bound to the output from VM Get activity.
The value can also be obtained from activity: Get VM using the following steps:- use a Get VM activity to extract the VM ID:
- use a Get VM activity to extract the VM ID:
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.
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables.
Execution: The example below is an execution where the parents IDs for DemoWin7 virtual machine are returned:
VM Get Status
This activity retrieves the state and other related information about a virtual machine.
...
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 (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM activity)..
The value can also be obtained from activity: Get VM using the following steps:- use a Get VM activity to extract the VM ID:
- use a Get VM activity to extract the VM ID:
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 Attributes 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.
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 Get Storage Usage activity:
The Read Only Output variable are the possible output values that the activity will provide:
- Output Commited (type: collection<string>): outputs a collection of information about the total storage space, commited to the VM across all datastores.
- Output Uncommited (type: collection<string>): outputs a collection of information about the additional storage space, potentially used by the VM across all datastores.
- Output Unshared (type: collection<string>): outputs a collection of information about the total storage space occupied by the VM across all datastores that is not shared with any other VM.
VM List
This activity lists all virtual machines from the specified location.
...
- 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.
VM List from Host
This activity lists all virtual machines on a specified Host.
...
- 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.
VM List Templates
This activity gets the list of VM templates from the specified location.
...
- 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.
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.
...