Versions Compared

Key

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

...

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
  • VM Name (text box editor type) (type: string):  this is an optional parameter, allowing to extract a specific VM ID for a specific VM Name. Insert the name of the VM for which the ID will be separately retrieved.

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

  • Output (type: collection<collection<string>>): outputs a collection of VMs and their IDs.To use the elements of the collection, use Get Element From Collection activity where the Input Collection parameter should be bind with this parameter.
  • Output Rows Count (type: int32): outputs Rows Count.
  •  Output Rows Count (type: string): outputs  the ID of the VM specified in the VM Name field. This value will be displayed at the beginning of the Tracking Data, before the rest of the results.

 

Execution: the activity can be executed in two (2) different ways:

  • without a given VM Name: the activity will simply look for virtual machines in the given folder, outputting a list with all found vms and their IDs:

    Image Added

  • with a given VM Name: the activity will first search for the given VM Name and will output its ID, after that will get and output all other VMs located in the given location:

    Image Added


In order to extract the values from the OutputVMsList collection, For Each and Log Track Data activities should be used:

 


Execution: The example below is an execution where all VMs are listed from the specified location:

 

 

 

...