Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Image RemovedImage Added

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: 
       Image RemovedImage Added
    • bind the obtained vAppID(stored in variable) to the vApp ID field from Clone vApp activity:  
      Image RemovedImage Added
  • 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.

...

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:

Image RemovedImage Added

Parameters:

  • Location (text box editor type) (type: string): the folder path where the new vApp will be created. 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 folder ID where the new vApp will be 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: 
       Image RemovedImage Added
    • bind the obtained ResourcePoolID(stored in variable) to the Parent Resource Pool ID field from Create vApp activity:
        Image Removed Image Added 
  • 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: 
       Image RemovedImage Added
    • bind the obtained vAppID(stored in variable) to the vApp ID field from Create vApp activity:  
      Image RemovedImage Added

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.
     
 

...

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

Image RemovedImage Added

Parameters:

  • Object ID (text box editor type) (type: string): the ID of the Object for which you want to retrieve the annotations (MoRef).
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from Get Annotations activity:
      Image RemovedImage Added
  • Object Type (combo box control) (type: string): the type of the Object. Flowster Studio provides the following options:
    • VirtualMachine
    • Folder
    • Resource Pool
    • VMHost
    • Cluster
    • Datacenter
  • Selected Annotation (text box editor type) (type: string): enter an annotation. E.g "DemoAnno". 

...

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

Image RemovedImage Added

Parameters:

  • Attributes to be Retrieved (text box editor type) (type: string): a list of comma separated attributes you want to retrieve (example: "name,config").
  • Object ID (text box editor type) (type: string): the ID of the Object for which you want to retrieve the Attributes.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from Get Attributes activity:
      Image RemovedImage Added
  • Object Type (combo box control) (type: string): the type of the Object. Flowster Studio provides the following options:
    • VirtualMachine
    • Folder
    • Resource Pool
    • VMHost
    • Cluster
    • Datacenter
  • Selected Attribute (text box editor type) (type: string): the attribute to be retrieved (example: "config").

...

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

Image RemovedImage Added

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. E.g "vAppRoot/vAppChild". 

...

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

Image RemovedImage Added

Parameters:

  • Annotation Name (text box editor type) (type: string): the name of the Custom Attribute that you want to set.
  • Annotation New Value (text box editor type) (type: string): the new value for the annotation.
  • Object ID (text box editor type) (type: string): the ID of the Object for which you want to retrieve the Attributes.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine the Object ID field from Set Annotation activity:
      Image RemovedImage Added
  • Object Type (combo box control) (type: string): the type of the Object. Flowster Studio provides the following options:
      • VirtualMachine
      • Folder
      • Resource Pool
      • VMHost
      • Cluster
      • Datacenter

...

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

Image RemovedImage Added

Parameters:

  • Description New Value (text box editor type) (type: string): the new value for the 'Description' property of the object.
  • Object ID (text box editor type) (type: string): the ID of the Object for which the Description is to be edited.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine Object ID field from Set Description activity:
      Image RemovedImage Added
  • Object Type (combo box control) (type: string): the type of the Object. Flowster Studio provides the following options:
      • VirtualMachine
      • Folder
      • Resource Pool
      • VMHost
      • Cluster
      • Datacenter

...

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

Image RemovedImage Added

Parameters:

  • Field Key (text box editor type) (type: string): the key (int value) of field you want to set.
  • Field Value (text box editor type) (type: string): the new value for the field.
  • Object ID (text box editor type) (type: string): the ID of the Object for which the Field value is to be edited.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine Object ID field from Set Field activity:
      Image RemovedImage Added
  • Object Type (combo box control) (type: string): the type of the Object. Flowster Studio provides the following options:
      • VirtualMachine
      • Folder
      • Resource Pool
      • VMHost
      • Cluster
      • Datacenter
  • Object Type (combo box control) (type: string): the type of the Object (Folder, VirtualMachine, ..).

...

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

Image RemovedImage Added

Parameters:

  • 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:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Answer activity:
      Image RemovedImage Added
  • 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 Clone activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Location By ID (text box editor type) (type: string): the ID of the folder where you want to place the new virtual machine. If no value is provided, the new VM will be created in the same location as the initial VM.
  • New VM Name (text box editor type) (type: string): the name for the new virtual machine.
  • VM (text box editor type) (type: string): the input virtual machine to clone. 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:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine IDVM field from VM Clone activity:
      Image RemovedImage Added
  • 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 Create activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Datacenter (text box editor type) (type: string): the datacenter root name.
  • Datastore (text box editor type) (type: string): the datastore name where you want to place the new virtual machine.
  • Disk Provisioning (combo box control) (type: string): the virtual disk provisioning mode.Flowster Studio provides the following options:
    • Thick Provision Lazy Zeroed: Creates a virtual disk in a default thick format. Space required for the virtual disk is allocated when the virtual disk is created. Data remaining on the physical device is not erased during creation, but is zeroed out on demand at a later time on first write from the virtual machine.
    • Thick Provision Eager Zeroed: A type of thick virtual disk that supports clustering features such as Fault Tolerance. Space required for the virtual disk is allocated at creation time. In contrast to the flat format, the data remaining on the physical device is zeroed out when the virtual disk is created. It might take much longer to create disks in this format than to create other types of disks.
    • Thin Provision: Use this format to save storage space. For the thin disk, you provision as much datastore space as the disk would require based on the value that you enter for the disk size. However, the thin disk starts small and at first, uses only as much datastore space as the disk needs for its initial operations.
  • Disk MB (text box editor type) (type: string): the size in MB of the disks that you want to create and add to the new virtual machine.
  • Guest ID (text box editor type) (type: string): the guest operating system id of the new virtual machine.
  • Host (text box editor type) (type: string): the host on which you want to create the new virtual machine.
  • Location (text box editor type) (type: string): the folder where you want to place the new virtual machine.For example: root/folder/sub-folder.
  • Location By ID (text box editor type) (type: string): the ID of the folder where you want to place the new virtual machine. If you enter a value for this parameter, the 'Location' parameter is ignored.
  • Memory MB (text box editor type) (type: string): the memory size in MB of the new virtual machine.
  • New VM Name (text box editor type) (type: string): the name for the new virtual machine. If you are registering or cloning an existing virtual machine, this parameter is not mandatory.
  • Num CPU (text box editor type) (type: string): the number of the virtual CPUs of the new virtual machine.
  • VM Description (text box editor type) (type: string): the description of the new virtual machine.
  • 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. 

...


Execution: The example below is an execution where a new vm is created with given specifications:

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:

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to create screenshot.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Create Screenshot activity:
      Image RemovedImage Added
  • 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:

Image RemovedImage Added

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' 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:
      Image RemovedImage Added
    • bind the obtained HostID (stored in variable) to the HostID field from VM Create Secondary activity:   
      Image RemovedImage Added
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to create 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:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Create Secondary activity:
      Image RemovedImage Added
  • 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 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:

Image RemovedImage Added

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.
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Customize activity:
      Image RemovedImage Added

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.
 

 


 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:

Image RemovedImage Added

Parameters:

  • Virtual Device Name (text box editor type) (type: string): the virtual machine you want to have all disks defragmented.
     The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Defragment Disks activity:
      Image RemovedImage Added

  • 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 Deploy activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • Cluster Name (text box editor type) (type: string): the name of the Cluster (only necessary if 'Host' parameter is empty).
  • Customization Name (text box editor type) (type: string): the name of the customization you wish to apply (optional).
  • Datacenter Name (text box editor type) (type: string): specify the datacenter name when using Host and Network Name parameters if a different network adapter is desired than the one from the template.
  • Datastore Name (text box editor type) (type: string): the Datastore name (optional).
  • Disk Mode (combo box control) (type: string): the Disk Mode.
  • Folder Fullpath (text box editor type) (type: string): the folder where you want to place the new virtual machine; 'Folder ID' parameter takes precedence over this parameter. If no value is provided for both 'Folder ID' and 'Folder Fullpath' parameters, the new VM will be created in the same location as the initial Template.
  • Folder ID (text box editor type) (type: string): the ID of the folder where you want to place the new virtual machine. If no value is provided for both 'Folder ID' and 'Folder Fullpath' parameters, the new VM will be created in the same location as the initial Template.
  • Host (text box editor type) (type: string): the Host (IP address) where you want to create the new virtual machine (optional).
  • Network Name (text box editor type) (type: string): the network name for the Ethernet Device. If left empty it will set the first network found in the current environment.
  • New VM Name (text box editor type) (type: string): the name for the new virtual machine.
  • Port Group Key (text box editor type) (type: string): the Port Group Key ID of the network adapter which you want to set for the new virtual machine. Only needed when dvPortGroup network type is selected. (Optional) Bind the value to the output 'PortGroupKey' from 'GetNetworkAdapterProperties' activity.
  • VM (text box editor type) (type: string): the input template 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:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VM field from VM Deploy activity:
      Image RemovedImage Added

  • VM Network Type (text box editor type) (type: string): the network adapter type for the virtual machine.
  • 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 Disable Secondary activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

  • 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:
      Image RemovedImage Added
    • bind the obtained HostID (stored in variable) to the HostID field from VM Disable Secondary activity:   
      Image RemovedImage Added
  • 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 disable. 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:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine the SVirtualMachine ID field from VM Disable Secondary activity:
      Image RemovedImage Added
  • 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:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Disable Secondary activity:
      Image RemovedImage Added
  • 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 Edit activity parameters can be provided by manual inserted values or via IN arguments or variables:

Image RemovedImage Added

Parameters:

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

Boot Options (parameters):

...

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

Image RemovedImage Added

Parameters:

  • 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:
      Image RemovedImage Added
    • bind the obtained HostID (stored in variable) to the HostID field from VM Enable Secondary activity:   
      Image RemovedImage Added
  • 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 enable. 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:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine the SVirtualMachine ID field from VM Enable Secondary activity:
      Image RemovedImage Added
  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to make the call to enable 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:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Enable Secondary activity:
      Image RemovedImage Added

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

Image RemovedImage Added

Parameters:

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

The Read Only Output variable are the possible output values that the activity will provide:

...

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

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the virtual machine you want to export. E.g "vm-100". 
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Export activity:
      Image RemovedImage Added
  • Destination Folder Path (text box editor type) (type: string): the path of the folder where you wish to export the VM.  

...

The VM Get 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 (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.

...

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

Image RemovedImage Added

Parameters:

  • VM ID (text box editor type) (type: string): the ID of the 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:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Get Parent activity:
        Image RemovedImage Added

The Read Only Output variable are the possible output values that the activity will provide:

...

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

Image RemovedImage Added

Parameters:

  • Virtual Machine ID (text box editor type) (type: string): the ID of the virtual machine to retrieve the status for .
    The value can also be obtained from activity: Get VM using the following steps:
    • use a Get VM activity to extract the VM ID:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Get Status activity:
        Image RemovedImage Added

The Read Only Output variable are the possible output values that the activity will provide:

...

VM Get Storage Usage

This activity retrieves a subset of the storage information of this virtual machine.

Activity Parameters

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

Image Added

Image RemovedParameters:

  • VirtualMachine ID (text box editor type) (type: string): the ID of the Virtual Machine for which you want to retrieve the storage usage 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:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM Get Storage Usage activity:
        Image RemovedImage Added


The Read Only Output variable are the possible output values that the activity will provide:

  • Output Commited (type: string): outputs the total storage space, commited to the VM across all datastores. 
  • Output Uncommited (type: string): outputs the additional storage space, potentially used by the VM across all datastores. 
  • Output Unshared (type: string): outputs the total storage space occupied by the VM across all datastores that is not shared with any other VM.

...

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

...

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

Image RemovedImage Added

Parameters:

  • 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:
      Image RemovedImage Added
    • bind the obtained VM ID (stored in variable) to the VirtualMachine ID field from VM List Snapshots activity:
        Image RemovedImage Added

The Read Only Output variable are the possible output values that the activity will provide:

...

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

Image RemovedImage Added

Parameters:

  • 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:
      Image RemovedImage Added
    • bind the obtained HostID (stored in variable) to the HostID field from VM List From Host activity:   
      Image RemovedImage Added

 

The Read Only Output variable are the possible output values that the activity will provide:

...

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

...