Activities

Connect to PVS
Disconnect from PVS
Add Device to Domain
Add vDisk
Add vDisk Maintenance Version
Add vDisk Version
Append vDisk to Device
Clone vDisk
Copy Manifest Files
Create Device
Create vDisk
Device Exists
Export vDisk
Get vDisk Info
Import vDisk
Promote vDisk Version
Remove Device
Remove Device from Domain
Remove vDisk
Remove vDisk from Device
Revert vDisk Version
Set Access Mode vDisk
Set Device
Set Device Type
Set vDisk Build Version

Connect To PVS

This activity connects to a Provisioning Server Host.

Activity Parameters

The Connect to PVS activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Password (password editor type) (type: string): the password for the provided username.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the connection. (This parameter is used only when the user wants to send an encripted password from outside the workflow, for example Flowster Portal).
Protocol (combo box control) (type: string): the Protocol used for connecting to the Provisioning Server. Flowster Studio provides the following options:
- HTTP - Communicate using XML over HTTP.
- HTTPS - Communicate using XML over HTTPS. Useful when GUI is outside of firewall or router.
- TCP - Communicate using TCP/IP. Uses binary stream for increased performance when GUI is on local area network.
- IPC - Communicate using named pipes. Can only be used when GUI is installed on same computer as the server. Useful for high security environments.
Site IP (text box editor type) (type: string): the IP of the Provisioning Server Host machine - example: "10.10.10.1".
Site Port (text box editor type) (type: string): the Port of the Provisioning Server Host machine - example: "8000".
User Domain (text box editor type) (type: string): the Domain Name where the Provision Server is a member.E.g. "FMRP"
Username (text box editor type) (type: string): the username of the Provisioning Server Administrator.E.g. "DemoUser"

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

Connection (type: object): outputs a Citrix PVS connection. The Output of this activity should be used as input for all Connection parameters used for all activities placed under Citrix Provisioning Server category.

Disconnect from PVS

This activity disconnects from a Provisioning Server Host.

Activity Parameters

The Disconnect from PVS activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: object): the PVS Host Connection. The Output from Connect to PVS activity should be used as input for this parameter.

Add Device to Domain

Creates an Active Directory Machine Account for an existing Device on a Citrix Provisioning Server farm

Activity Parameters

The Add Device to Domain activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Device Name (text box editor type) (type: string): the name of an existing device.
Device OU (text box editor type) (type: string): this parameter is optional. Enter the Organizational Unit to add the Device to within the Domain named above. If more than one is needed, put a comma between them. If a comma is needed in the name, put a \ in front of it. For example: namewith\,comma for nested, the child goes first. - example: "ChildOU_Name,parentOU_Name". E.g."__DEV-Testing/Computers".
Server Domain (text box editor type) (type: string): the domain to add the Device(s) to. If not included, the first Domain Controller found on the Server is used.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Add vDisk

Imports and adds vDisk with given name

Activity Parameters

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

Parameters:

Description (text box editor type) (type: string): the vDisk description.
Server Name (text box editor type) (type: string): the Server Name on which the new vDisk will be created.
Site Name (text box editor type) (type: string): the site name on which the new vDisk will be created.
Store Name (text box editor type) (type: string): the Store Name which will store the new vDisk files.
vDisk Name (text box editor type) (type: string): the vDisk name (Disk Locator Name).

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

Output GUID (type: string): outputs the vDisk guid.
Output Status (type: string): outputs the activity execution result.

Execution:

Add vDisk Maintenance Version

This activity adds a new Maintenance Version to a vDisk.

Activity Parameters

The Add vDisk Maintenance Version activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Site Name (text box editor type) (type: string): the site name of the vDisk.
Store Name (text box editor type) (type: string): the Store Name.
vDisk Name (text box editor type) (type: string): the vDisk name (Disk Locator Name).

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

Output Status (type: string): outputs the activity execution result.

Execution:

Add vDisk Version

This activity adds a new Version to a vDisk.

Activity Parameters

The Add vDisk Version activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Site Name (text box editor type) (type: string): the site name of the vDisk.
Store Name (text box editor type) (type: string): the Store Name.
vDisk Name (text box editor type) (type: string): the vDisk name (Disk Locator Name).

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

Output Status (type: string): outputs the activity execution result.

Append vDisk to Device

Appends vDisk to specified device

Activity Parameters

The Append vDisk to Device activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Collection Name (text box editor type) (type: string): the Collection Name of the target device.
Remove Existing vDisk (combo box control) (type: string): choose 'Yes' to remove the existing Disk Locators before assigning the new ones. The Default value is 'No'.
Site Name (text box editor type) (type: string): the site name of the target device.
Store Name (text box editor type) (type: string): the name of the store where the vDisk is stored.
Target Device Name (text box editor type) (type: string): the target device name.
vDisk Name (text box editor type) (type: string): the vDisk name that will be appended to the Device.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Clone vDisk

This activity clones the specified vDisk.

Activity Parameters

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

Import Parameters:

Boot Enabled (combo box control) (type: string): specify whether the disk can be booted or not.
Destination Site Name (text box editor type) (type: string): the Site Name of the cloned vDisk.
Destination Store Name (text box editor type) (type: string): the Store Name that will store the cloned vDisk files.
Destination vDisk Description (text box editor type) (type: string): the description for the vDisk.
Rebalance Enabled (combo box control) (type: string): specify whether the server can automatically rebalance devices or not.
Rebalance Trigger Percent (text box editor type) (type: string): specify the percent over fair load that triggers a dynamic Device rebalance.
Server Name (text box editor type) (type: string): the name of the single server that the Disk Locator is assigned to.
Subnet Affinity (combo box control) (type: string): the Qualifier for subnet affinity when assigning a server. 0 = None, 1 = Best Effort, 2 = Fixed.

Parameters:

Site Name (text box editor type) (type: string): the site name of the source vDisk.
Store Name (text box editor type) (type: string): the Store Name of the source vDisk.
vDisk Name (text box editor type) (type: string): the source vDisk name (Disk Locator Name).
Version (text box editor type) (type: string): the version to use as the start of the export. The export will include all versions starting with this to the highest one. Note: Maintenance and Merging Access versions will not be included in the export manifest file.

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

Output GUUID (type: string): outputs the new vDisk GUUID.
Output Status (type: string): outputs the activity execution result.

Execution:

Copy Manifest Files

This activity prepares the required manifest files for the virtual disk.

Activity Parameters

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

Parameters:

Destination Site Name (text box editor type) (type: string): the Site Name of the vDisk where the manifest files will be copied.
Destination Store Name (text box editor type) (type: string): the Store Name that will store the manifest files.
Server Name (text box editor type) (type: string): the name of the single server that the Disk Locator is assigned to.
Site Name (text box editor type) (type: string): the site name of the source vDisk.
Store Name (text box editor type) (type: string): the Store Name of the source vDisk.
vDisk Name (text box editor type) (type: string): the source vDisk name (Disk Locator Name).
Version (text box editor type) (type: string): the version to use as the start of the export. The export will include all versions starting with this to the highest one. Note: Maintenance and Merging Access versions will not be included in the export manifest file.

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

Output Status (type: boolean): outputs the activity execution result.

Execution:

Create Device

This activity creates a Device in a Citrix Provisioning Server Farm.

Activity Parameters

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

Parameters:

Collection Name (text box editor type) (type: string): the Collection Name.
Device Description (text box editor type) (type: string): the description of the device that will be created.
Device Name (text box editor type) (type: string): the Device Name that will be created.
Domain (text box editor type) (type: string): the Domain Name to which the Device will be added. If not included, the first Domain Controller found on the Server will be used.
MAC (text box editor type) (type: string): the mac address of the device that will be created.
Site Name (text box editor type) (type: string): the site name of the device that will be created.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Create vDisk

This activity creates a virtual disk in a Citrix Provisioning Server Farm.

Activity Parameters

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

Parameters:

Description (text box editor type) (type: string): the description of the vDisk that will be created.
IsEnabled (text box editor type) (type: string): the disk will be created disabled if set to 0. It is created Enabled by default. Default=1 (optional).
Site Name (text box editor type) (type: string): the site name from the Citrix Provisioning Services farm.
Size (text box editor type) (type: integer): the size of the vDisk in MB.
Store Name (text box editor type) (type: string): the store name from the Citrix Provisioning Services farm.
Type (text box editor type) (type: string): the VHD type that will be created.
vDisk Name (text box editor type) (type: string): the name of the vDisk that will be created.
VHD block size (text box editor type) (type: string): the dynamic VHD block size in KB.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Device Exists

This activity checks if the device exists in a Citrix Provisioning Server farm.

Activity Parameters

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

Parameters:

Device ID (text box editor type) (type: string): the GUID for the device to be checked.
Device MAC (text box editor type) (type: string): the MAC for the device to be checked. If the "Device Name" is not specified, this parameter takes precedence over the "Device ID".
Device Name (text box editor type) (type: string): the Name for the device to be checked. If this parameter is specified, the "Device ID" and the "Device MAC" parameters will be skipped.

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

Output Status (type: boolean): outputs TRUE if the device exists, otherwise FALSE.

Execution:

Export vDisk

This activity exports the disk stack to a manifest file.

Activity Parameters

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

Parameters:

Site Name (text box editor type) (type: string): the site name of the vDisk.
Store Name (text box editor type) (type: string): the Store Name.
vDisk Name (text box editor type) (type: string): the vDisk name (Disk Locator Name).
Version (text box editor type) (type: string): the version to use as the start of the export. The export will include all versions starting with this to the highest one. Note: Maintenance and Merging Access versions will not be included in the export manifest file.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Get vDisk Info

this activity gets vDisk information.

Activity Parameters

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

Parameters:

Property Name (text box editor type) (type: string): the name of the property for which you want to output the value.
Site Name (text box editor type) (type: string): the site name of the vDisk.
Store Name (text box editor type) (type: string): the Store Name.
vDisk Name (text box editor type) (type: string): the vDisk name (Disk Locator Name).

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

Output Collection (type: collection<collection<string>>): outputs a collection with items made of 2 columns subcollection (name, value). To use the elements of the collection, use Get Value From Info Collection activity.
Output Property Value (type: string): outputs the value of the property specified in the 'Property Name' parameter.
Output Row Count (type: int32): outputs rows count of the returned info.
Output Status (type: string): outputs the activity execution result.

In order to extract the values from the output collection (in our case the output is a Collection(Of Collection(Of String)) ), For Each and Get Element From Collection activities should be used:

Execution:

Import vDisk

This activity imports a Disk. It will add a Disk Locator for the Disk to the Site. A manifest file must exist in the Store. The return value is the GUID of the added Disk Locator.

Activity Parameters

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

Parameters:

Boot Enabled (combo box control) (type: string): specify whether the disk can be booted or not.
Description (text box editor type) (type: string): the description for the disk.
Rebalance Enabled (combo box control) (type: string): specify whether the server can automatically rebalance devices or not.
Rebalance Trigger Percent (text box control) (type: string): specify the percent over fair load that triggers a dynamic device rebalance.
Server Name (text box editor type) (type: string): the name of the single server that the Disk Locator is assigned to.
Site Name (text box editor type) (type: string): the site name of the vDisk.
Store Name (text box editor type) (type: string): the Store Name.
Subnet Affinity (combo box control) (type: string): the Qualifier for subnet affinity when assigning a server. 0 = None, 1 = Best Effort, 2 = Fixed.
vDisk Name (text box editor type) (type: string): the vDisk name (Disk Locator Name).

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

Output GUUID (type: string): outputs the vDisk GUUID.
Output Status (type: string): outputs the activity execution result.

Promote vDisk Version

This activity promotes the Maintenance version of a Test version to a Test or new Production version.

Activity Parameters

The Promote vDisk Version activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Access (combo box control) (type: string): specify the mode of the Maintenance version to Test by choosing "True". Default is "False".
Scheduled Date (calendar picker) (type: string): the Date/Time when the new disk version will become available. Format is "dd/MM/yyyy HH:mm:ss".
Site Name (text box editor type) (type: string): the site name of the vDisk.
Store Name (text box editor type) (type: string): the Store Name.
vDisk Name (text box editor type) (type: string): the vDisk name (Disk Locator Name).
Version (text box editor type) (type: string): the version number that should be promoted to production. If not specified the highest version will be promoted.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Remove Device

This activity removes a device from Citrix Provisioning Server farm.

Activity Parameters

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

Parameters:

Device Name (text box editor type) (type: string): the name of the device to be removed.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Remove Device from Domain

This activity removes an existing device from an Active Directory domain.

Activity Parameters

The Remove Device from Domain activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Device ID (text box editor type) (type: string): the GUID of the device to be removed.
Device MAC (text box editor type) (type: string): the MAC of the device to be removed.
Device Name (text box editor type) (type: string): the Name of the device to be removed.
Server Domain (text box editor type) (type: string): the Domain from where the device will be removed. If not included, the first Domain Controller found on the server will be used

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

Output Status (type: boolean): outputs TRUE if the device is removed, otherwise FALSE.

Execution:

Remove vDisk

This activity removes a specified vDisk from Citrix Provisioning Server farm.

Activity Parameters

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

Parameters:

Delete from Disk (combo box control) (type: string): permanently delete file from disk.
Server Name (text box editor type) (type: string): the Server Name where the vDisk is located.
Site Name (text box editor type) (type: string): the site name where the vDisk is located.
Store Name (text box editor type) (type: string): the Store Name which stored the vDisk files.
vDisk Name (text box editor type) (type: string): the vDisk name (Disk Locator Name).

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

Output Status (type: string): outputs the activity execution result.

Execution:

Remove vDisk from Device

This activity removes a specified vDisk from Citrix Provisioning Server farm.

Activity Parameters

The Remove vDisk from Device activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Collection Name (text box editor type) (type: string): the Collection Name of the target device.
Site Name (text box editor type) (type: string): the site name of the target device.
Store Name (text box editor type) (type: string): the Store Name in which the vDisk is stored.
Target Device Name (text box editor type) (type: string): the target device name.
vDisk Name (text box editor type) (type: string): the vDisk name that will be removed from the Device.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Revert vDisk Version

This activity reverts the existing highest version disk to Maintenance or Test mode. A specified version can be reverted to Test mode if there are no Production versions higher than it. If the mode is Test, it can be set to Maintenance.

Activity Parameters

The Revert vDisk Version activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Access (text box editor type) (type: string): specify the access mode of the vDisk version. 1 for Test, otherwise Maintenance.
Site Name (text box editor type) (type: string): the site name of the vDisk.
Store Name (text box editor type) (type: string): the Store Name which stored the vDisk files.
vDisk Name (text box editor type) (type: string): the vDisk name (Disk Locator Name).
Version (text box editor type) (type: string): the version number that should be reverted to Test mode.

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

Output Status (type: string): outputs the activity execution result.

Execution:

Set Access Mode vDisk

This activity sets the Access Mode property for vDisk.

Activity Parameters

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

Parameters:

Access Mode (combo box control) (type: string): select the access mode. Flowster Studio provides the following options:
- Private Image: single-device usage, allows the user to modify the image of the vDisk. The changes are persistent.
- Standard Image - Server Disk: multi-device usage. The changes of the image are non-persistent.
- Standard Image - Server Disk Encrypted: multi-device usage. The changes of the image are non-persistent.
- Standard Image - RAM: multi-device usage. The changes of the image are non-persistent.
- Standard Image - Hard Disk: multi-device usage. The changes of the image are non-persistent.
- Standard Image - Hard Disk Encrypted: multi-device usage. The changes of the image are non-persistent.
Site Name (text box editor type) (type: string): the site name of the device.
Store Name (text box editor type) (type: string): the Store Name.
vDisk Name (text box editor type) (type: string): the vDisk name (Disk Locator Name).

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

Output Status (type: string): outputs the activity execution result.

Execution:

Set Device

This activity sets existing Device properties in a Citrix Provisioning Server Farm.

Activity Parameters

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

Parameters:

Boot From (combo box control) (type: string): change the boot device.Choose from the drop down list the boot device: vDisk, HardDisk or Floppy.
Device Description (text box editor type) (type: string): the description of the existing device.
Device Name (text box editor type) (type: string): the name of an existing device.
Domain (text box editor type) (type: string): the Domain on which the device will run.
Port (text box editor type) (type: string): change the port to use with Stream Service. Min=1025, Max=65536, Default=6901.

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

Output (type: string): outputs the activity execution result.

Execution:

Set Device Type

This activity sets a new type for an existing device.

Activity Parameters

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

Parameters:

Device ID (text box editor type) (type: string): the GUID of the device.
Device MAC (text box editor type) (type: string): the MAC of the device. If the "Device Name" is not specified, this parameter takes precedence over the "Device ID".
Device Name (text box editor type) (type: string): the Name of the device. If this parameter is specified, the "Device ID" and the "Device MAC" parameters will be skipped.
Device Type (text box editor type) (type: int32): the new type for the existing device. Allowed values are: 0 - Production, 1 - Test and 2 - Maintenance.

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

Output Status (type: boolean): outputs TRUE if the new type is set, otherwise FALSE.

Execution:

Set vDisk Build Version

This activity sets the Build property for vDisk.

Activity Parameters

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

Parameters:

Build Version (text box editor type) (type: string): the Build Version value.
Site Name (text box editor type) (type: string): the site name of the target vDisk.
Store Name (text box editor type) (type: string): the Store Name which stores the vDisk files.
vDisk Name (text box editor type) (type: string): the vDisk name (Disk Locator Name).

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

Output Status (type: string): outputs the activity execution result.

Execution:

Browser not supported