...
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:
- use a Get vApp/ Create vApp activity to extract the vAppID:
- 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 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:
- New vApp Name Location (text box editor type) (type: string): the folder path where the new vApp name that will be created. Parent vApp ID 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 ID of folder ID where the parent new vApp to will be used.
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 CreateVApp activity:
- 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:
- use a Get Resource Pool activity to extract the ResourcePoolID:
- 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:
- use a Get vApp activity to extract the vAppID:
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
...
- 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.
Get Attributes
This activity retrieves a list of all the Attributes of the specified object (Virtual machine, Folder, ..).
...
- 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.
Get VApp
This activity returns the id of a specified VApp.
...
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.
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 CloneVApp activity:
...
- 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:
Maintenance Mode
This activity enters and exits maintenance mode for an ESX host.
...
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 Mainetnance Mode activity:
Set Annotation
This activity sets value for the specified Annotation of selected object (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 Set Annotation activity:
Set Description
This activity sets value of Description field of selected object(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 Set Description activity:
Set Field
This activity sets value of specified field of selected object(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 Set Field activity:
VM Answer
This activity responds to a question that is blocking 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 Clone activity:
VM Create
This activity creates a new virtual machine on Host.
...
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).
- 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.
...
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.
...
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.
...
- 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.
...
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.
...
- Output (type: string): outputs 'true' if the specified VM exists, otherwise 'false'.
VM Export
This activity exports the specified virtual machine.
...
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.
...
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.
...