Activities

Add Send Target Server
Get Advanced Options from Host
Get Host
Get Multipaths
Host Operations
List Hosts
List ISO Files
Maintenance Mode
Remove Target Entry
Rescan Adapters
Set Advanced Options from Host
Set Multipaths

Add Send Target Server

This activity adds the new SCSI send target server.

Activity Parameters

The Add Send Target Server activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Device (text box editor type) (type: string): the device of the Internet SCSI HBA adapter.
Host ID (text box editor type) (type: string): the the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
The value can also be obtained from activity: Get Host using the following steps:
- use a Get Host activity to extract the HostID:
- bind the obtained HostID (stored in variable) to the HostID field from AddScsiSendTargetServer activity:
Host IP (text box editor type) (type: string): the Host IP.
iSCSI Server (text box editor type) (type: string): the IP address or hostname of the storage device.
Parent (text box editor type) (type: string): the device name of the host bus adapter from which settings can be inherited.
Port (text box editor type) (type: int32): the TCP port of the storage device. If not specified, the standard default of 3260 is used.

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

Output (type: boolean): outputs the result status.

Execution: The example below is an execution where a new iSCSI target server:

Get Advanced Options from Host

This activity gets and returns all the advanced setting values for the specified Host.

Activity Parameters

The Get Advanced Options from Host activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

HostID (text box editor type) (type: string): the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
The value can also be obtained from activity: Get Host using the following steps:
- use a Get Host activity to extract the HostID:
- bind the obtained HostID (stored in variable) to the HostID field from Get Advanced Options from Host activity:
HostIP (text box editor type) (type: string): the IP of the host.
Selected Attribute (text box editor type) (type: string): specify an attribute for which you want a separate output. E.g. "Disk.DiskMaxIOSize".

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

Output (type: string): outputs a collection containing all the advanced setting values.
Selected Attr Output (type: string): outputs the values of the specified Seledted Attribute parameter.

In order to extract the values from the HostAdvancedOptions collection, For Each and Get Element From Collection activities should be used:

Execution: The example below is an execution where information is returned about host with IP 10.201.0.51:

Get Host

This activity gets and returns the Host ID.

Activity Parameters

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

Parameters:

Datacenter Name (text box editor type) (type: string): the name of the datacenter.
Host Name (text box editor type) (type: string): the name of the Host under the datacenter branch.

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

Output (type: string): outputs the resulting Host ID. If the Host is not found, value is empty.

Execution: The example below is an execution where the host ID is returned of the specified host name:

Get Multipaths

This activity gets and returns all the multipaths names for a specified Host.

Activity Parameters

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

Parameters:

Host ID (text box editor type) (type: string): the the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
The value can also be obtained from activity: Get Host using the following steps:
- use a Get Host activity to extract the HostID:
- bind the obtained HostID (stored in variable) to the HostID field from Get Multipaths activity:
Host IP (text box editor type) (type: string): the Host IP.

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

Output (type: collection<collection<string>>): outputs a collection of sub-collections containing all the paths values.

In order to extract the values from the MultiPathsConfig collection, For Each and Get Element From Collection activities should be used:

Execution: The example below is an execution where all multipaths are returned for the specified host:

Host Operations

This activity performs operations on the specified ESX host.

Activity Parameters

The Host Operationsactivity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Evacuate Powered Off VMs (combo box control) (type: string): this parameter is only used for PowerDownToStandBy operation. If true, this activity will not succeed on a non-DRS cluster unless all powered-off virtual machines have been reregistered. On a DRS-enabled cluster, vCluster will automatically reregister powered-off virtual machines. Flowster Studio provides the following options:
- True
- False
Force (combo box control) (type: string): specify whether or not the host should be shutdown regardless of whether it is in maintenance mode. Flowster Studio provides the following options:
- True
- False
Host Operation (combo box control) (type: string): specify the operation to be performed. Flowster Studio provides the following options:
- Shutdown
- Disconnect
- Reconnect
- Reboot
- PowerDownToStandBy
- PowerUpToStandBy
Host ID (text box editor type) (type: string): the the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
The value can also be obtained from activity: Get Host using the following steps:
- use a Get Host activity to extract the HostID:
- bind the obtained HostID (stored in variable) to the HostID field from Host Operationsactivity:
Host IP (text box editor type) (type: string): the Host IP.
Password (password editor type) (type: string): the password for the user that is required to perform Reconnect operation.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the remote computer. (This parameter is used only when the user wants to send an encrypted password from outside the workflow, for example Flowster Studio Portal).
Username (text box editor type) (type: string): the username used to perform Reconnect operation.

List Hosts

This activity lists all the Hosts from the specified Datacenter.

Activity Parameters

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

Parameters:

Datacenter Name (text box editor type) (type: string): the name of the Datacenter.

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

Output (type: string): outputs a collection of existing Host names.

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

Execution: The example below is an execution where all host names from the specified datacenter are listed:

List ISO files

This activity lists all the existing ISO files for all the Datastores existing on the specified host.

Activity Parameters

The List ISO Files activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Host ID (text box editor type) (type: string): the the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
The value can also be obtained from activity: Get Host using the following steps:
- use a Get Host activity to extract the HostID:
- bind the obtained HostID (stored in variable) to the HostID field from List ISO Filesactivity:
Host IP (text box editor type) (type: string): the Host IP.

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

Output (type: collection<collection<string>>): outputs a collection of sub-collections containing all the ISO files.

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

Execution: The example below is an execution where all ISO files from the specified datastore are listed:

Maintenance Mode

This activity enters and exits maintenance mode for an ESX host.

Activity Parameters

The Maintenance 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.
The value can also be obtained from activity: Get Host using the following steps:
- use a Get Host activity to extract the HostID:
- bind the obtained HostID (stored in variable) to the HostID field from Maintenance Modeactivity:
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 workflow execution to complete before moving to the next activity.

Remove Target Entry

This activity removes send target entries from the host bus adapter discovery list.

Activity Parameters

The Remove Target Entry activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Device (text box editor type) (type: string): the device of the Internet SCSI HBA Adapter.
Host ID (text box editor type) (type: string): the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
The value can also be obtained from activity: Get Host using the following steps:
- use a Get Host activity to extract the HostID:
- bind the obtained HostID (stored in variable) to the HostID field from Remove Target Entry activity:
Host IP (text box editor type) (type: string): the Host IP.
iSCSI Server(combo box control) (type: string): the IP address or hostname of the storage device.
Port (text box editor type) (type: int32): the TCP port of the storage device. If not specified, the standard default of 3560 is used.

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

Output (type: boolean): outputs the result status.

Rescan Adapters

This activity rescans vmfs devices and all host bus adapters.

Activity Parameters

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

Parameters:

Host ID (text box editor type) (type: string): the the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
The value can also be obtained from activity: Get Host using the following steps:
- use a Get Host activity to extract the HostID:
- bind the obtained HostID (stored in variable) to the HostID field from Rescan Adapters activity:
Host IP (text box editor type) (type: string): the Host IP.
Rescan (combo box control) (type: string): specify the desired rescan type.

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

Output (type: boolean): outputs the resulting status.

Execution: The example below is an execution where all adapters are rescanned for the specified host:

Set Advanced Options from Host

This activity updates the selected advanced settings for a specified Host.

Activity Parameters

The Set Advanced Options from Host activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Attributes (text box editor type) (type: string): the attributes as a collection for the advanced settings that you want to edit. If you enter values for this parameter, the 'Key' and 'Value' parameters will be ignored.
Host ID (text box editor type) (type: string): the the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
The value can also be obtained from activity: Get Host using the following steps:
- use a Get Host activity to extract the HostID:
- bind the obtained HostID (stored in variable) to the HostID field from Set Advanced Options from Host activity:
Host IP (text box editor type) (type: string): the Host IP.
Key (text box editor type) (type: string): the key of the Option Value from the advanced settings list (the name of the setting).
Value (text box editor type) (type: string): the value of the Option Value from the advanced settings list (the value which will be set).

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

Status (type: string): outputs the result status.

Set Multipaths

This activity updates the selected multipath for a specified Host..

Activity Parameters

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

Parameters:

Host ID (text box editor type) (type: string): the the ID of the host. If you enter a value for this parameter, the 'Host IP' parameter is ignored.
The value can also be obtained from activity: Get Host using the following steps:
- use a Get Host activity to extract the HostID:
- bind the obtained HostID (stored in variable) to the HostID field from Set MultiPaths activity:
Host IP (text box editor type) (type: string): the Host IP.
Multipath ID (text box editor type) (type: string): the ID of the multipath.
The value can also be obtained from activity: Get MultiPaths using the following steps:
- use a Get MultiPaths activity to extract the Multipath ID. Obtain the first element from the MultiPaths list and return the index 1 specific element using Get Element From Collection activity:
- bind the obtained MultiPathID (stored in variable) to the Multipath ID field from Set MultiPaths activity:
Multipath Policy (text box editor type) (type: string): the logical unit policy of the multipath. The following parameters are available: 'VMW_PSP_FIXED'-Use a preferred path whenever possible (in order to use this option you must enter a prefered path name) 'VMW_PSP_RR'-Load balance 'VMW_PSP_MRU'-Use the most recently used path.
Preferred Path (text box editor type) (type: string): the name of the preferred path.

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

Output (type: boolean): outputs the result status.

Browser not supported