...
Execution: The example below is an execution where the ID for Demo_vApp_Flowster vApp is returned:
Maintenance Mode
This activity enters and exits maintenance mode for an ESX host.
Activity Parameters
The Mainetnance Mode activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Evacuate Powered Off VMs (combo box control) (type: string): if true, the activity will not succeed on a non-DRS cluster unless all powered-off virtual machines have been manually reregistered. On a DRS-enabled cluster, vCenter will automatically reregister powered-off virtual machines.
- 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.
- Host IP (text box editor type) (type: string): the Host IP.
- Maintenance Mode (combo box control) (type: string): the action that is to be performed. 'Enter' causes the host to enter maintenance mode, 'Exit' causes the host to exit maintenance mode.
- Timeout (seconds) (text box editor type) (type: string): the time in seconds for the operation to complete.
- 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.
Set Annotation
This activity sets value for the specified Annotation of selected object (Virtual machine, ..).
Activity Parameters
The Set Annotation activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
Execution: The example below is an execution where a new value is set for DemoAnno annotation for object of type VirtualMachine with ID vm-25:
Set Description
This activity sets value of Description field of selected object(Virtual machine, ..).
Activity Parameters
The Set Description activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
Execution: The example below is an execution where a new description is set for object of type VirtualMachine with ID vm-25:
Set Field
This activity sets value of specified field of selected object(Virtual machine, ..).
Activity Parameters
The Set Field activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
Execution: The example below is an execution where a new value is set for field with key 1 for object of type VirtualMachine with ID vm-25:
VM Answer
This activity responds to a question that is blocking the specified virtual machine.
Activity Parameters
The VM Answer activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Answer Choice (text box editor type) (type: string): the answer choice. E.g "1" to select the first answer choice set for the specified VM.
- Question ID (text box editor type) (type: string): the question ID for which the answer is needed. E.g. "12" is the question ID set for the specified VM.
- Virtual Machine ID (text box editor type) (type: string): the virtual machine ID.
The value can also be obtained from activity: Get VM using the following steps:- use a Get VM activity to extract the VM ID:
- 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.
...
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:
...
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 Clone activity:
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:
...
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(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:
- Wait (text box editor type) (type: string): if the parameter is set to 'true', the activity waits for the task execution to complete before moving to the next activity.
VM Create Secondary
This activity creates secondary virtual machine for the specified virtual machine.
Activity Parameters
The VM Create Secondary activity parameters can be provided by manual inserted values or via IN arguments or variables:
Parameters:
- Host (text box editor type) (type: string): the name of the host.
- Host ID (text box editor type) (type: string): the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to create secondary virtual machine (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.
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 Create Secondary 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 (Enter the ID of the virtual machine or bind this parameter with the output parameter from Get VM 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.
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 Customize activity:
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(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 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:
...
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 Deploy activity:
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:
...
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 Disable Secondary 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:
...
- Output (type: string): outputs the result message from the editing action.
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:
...
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 Enable Secondary 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:
...
- Output (type: string): outputs 'true' if the specified VM exists, otherwise 'false'.
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:
...
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:
...
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:
...
As mentioned above, the values for all the required parameters can be provided by IN arguments or variables.
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:
...
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.
Activity Parameters
The VM List activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
This activity lists all the existing Snapshots from the existing virtual machine.
Activity Parameters
The VM List All Snapshots activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Output (type: collection<string>): outputs a collection of Snapshots .To use the elements of the collection, use Get Element From Collection activity where the Input Collection parameter should be bound to this parameter.
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:
...
- 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.
Activity Parameters
The VM List Templates activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- 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.
Activity Parameters
The VM Mark as Template activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to mark as Template(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.
Activity Parameters
The VM Mount Tools Installer activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to mount Tools Installer (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.
Activity Parameters
The VM Move activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
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.
Activity Parameters
The VM Power Off activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to power off (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.
Activity Parameters
The VM Power On activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to power on (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.
Activity Parameters
The VM Reboot Guest activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset the guest information (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.
Activity Parameters
The VM Refresh Storage Info activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to refresh storage information (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.
Activity Parameters
The VM Reload activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
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
Activity Parameters
The VM Remove All Snapshots activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to remove all snapshots (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.
Activity Parameters
The VM Remove Snapshot activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
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.
Activity Parameters
The VM Rename activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
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.
Activity Parameters
The VM Reset activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset (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
This activity resets the Guest Operating System Information of the specified virtual machine.
Activity Parameters
The VM Reset Guest Information activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to reset the guest information (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
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:
...
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
This activity sets the Display Resolution of the console window for the selected virtual machine.
Activity Parameters
The VM Set Display Resolution activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Height (text box editor type) (type: string): the Screen Height.For example: 1080.
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to set screen resolution (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.
Activity Parameters
The VM Shut Down Guest activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to shut down guest OS (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.
Activity Parameters
The VM Standby Guest activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to standby guest OS (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.
Activity Parameters
The VM Suspend activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to suspend (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.
Activity Parameters
The VM Take Snapshot activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
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
This activity unmounts Tools Installer for the selected virtual machine.
Activity Parameters
The VM Unmount Tools Installer activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to unmount Tools installer (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.
Activity Parameters
The VM Unregister activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to unregister (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.
Activity Parameters
The VM Upgrade Tools activity parameters can be provided by manual inserted values or via IN arguments or variables:
...
- Installer Options (text box editor type) (type: string): the Installer Options that you want to upgrade.
- Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to upgrade Tools (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.
Activity Parameters
The VM Upgrade Version activity parameters can be provided by manual inserted values or via IN arguments or variables:
...