Activities

Disconnect Remote Session

This activity disconnects the specified remote session.

Activity Parameters

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

Parameters:

Password (text box editor type) (type: string): the password for the user that will access the View Configuration Server host.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the specified user. (This parameter is used only when the user wants to send an encrypted password from outside the task, for example Flowster Studio Portal).
Remote User (text box editor type)(type: string): enter the domain and the username for the remote session to be disconnected. E.g. "DemoDomain\Username".
Server (text box editor type) (type: string): the Machine Name or the IP of the View Connection Server host:

User (text box editor type) (type: string): the user (domain and user, or just user) that have rights on the View Configuration Server host. E.g. "DemoDomain\Username".

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

Output (type: boolean): outputs the status of the operation.

Execution:

Get View Connection Server Information

This activity displays the configuration settings of a given View Connection Server instance.

About View Broker:

The View Broker component, which is the core of View Connection Server, is responsible for all user interaction between clients and View Connection Server. View Broker also includes the Administration Server that is used by the View Administrator Web interface.

View Broker works closely with vCenter Server to provide advanced management of remote desktops, including virtual machine creation and power operations.

Activity Parameters

The Get View Connection Server Information activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Broker ID (text box editor type) (type: string): the name of the connection broker for which the information is retrieved. In this example, the broker ID is "VSRPVCS201", the same as the server's name:.
Server (text box editor type) (type: string): the Machine Name or the IP of the View Connection Server host:
Password (text box editor type) (type: string): the password for the user that will access the View Configuration Server host. If querying with the logged in user and if this user has rights over the server, this field can be left empty.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the specified user. (This parameter is used only when the user wants to send an encrypted password from outside the task, for example Flowster Studio Portal).
User (text box editor type) (type: string): the user (domain and user, or just user) that have rights on the View Configuration Server host. If querying with the logged in user and if this user has rights over the server, this field can be left empty.

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

Output (type: Dictionary<String,String>): outputs a dictionary of strings, containing a list of name-value pairs information.

Execution: the activity outputs information about the given Desktop Pool:

Get Desktop Pool

This activity returns information about a desktop pool, which is retrieved by the Pool ID.

Horizon View Desktop Pools:

There are three types of desktop pools: automated, manual, and RDS. Automated desktop pools use a vCenter Server virtual machine template or snapshot to create a pool of identical virtual machines. Manual desktop pools are a collection of existing vCenter Server virtual machines, physical computers, or third-party virtual machines. In automated or manual pools, each Windows machine is available for one user to access remotely at a time. RDS desktop pools are not a collection of Windows machines, but instead, provide users with desktop sessions on RDS hosts. Multiple users can have desktop sessions on an RDS host simultaneously.

Activity Parameters

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

Parameters:

Pool ID (text box editor type) (type: string): the ID of the desktop pool for which the information will be retrieved. In Horizon View a desktop pool ID can be numeric or a string, for example "DemoPool", as it can be seen in Horizon View Administrator:
.
Server (text box editor type) (type: string): the Machine Name or the IP of the server where Horizon View is connected to. This server can be seen in Horizon View Administrator, on the Dashboard page:
Password (text box editor type) (type: string): the password for the user that will access Horizon View. If querying with the logged in user and if this user has rights over the server, this field can be left empty.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the specified user. (This parameter is used only when the user wants to send an encrypted password from outside the task, for example Flowster Studio Portal).
Username (text box editor type) (type: string): the user that will access Horizon View. If querying with the logged in user and if this user has rights over the server, this field can be left empty.

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

Output (type: Dictionary<String,String>): outputs a dictionary of strings, containing a list of name-value pairs information.

Execution: the activity outputs information about the given Desktop Pool:

The output values of the Get Desktop Pool activity can be extracted from the DesktopPoolInfo variable by using a ForEach activity:

the activity will be set to KeyValuePair<String,String> type:

Get View Connection Server Information

This activity displays the configuration settings of a given View Connection Server instance.

About View Broker:

The View Broker component, which is the core of View Connection Server, is responsible for all user interaction between clients and View Connection Server. View Broker also includes the Administration Server that is used by the View Administrator Web interface.

View Broker works closely with vCenter Server to provide advanced management of remote desktops, including virtual machine creation and power operations.

Activity Parameters

The Get View Connection Server Information activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Broker ID (text box editor type) (type: string): the name of the connection broker for which the information is retrieved. In this example, the broker ID is "VSRPVCS201", the same as the server's name:.
Server (text box editor type) (type: string): the Machine Name or the IP of the View Connection Server host:
Password (text box editor type) (type: string): the password for the user that will access the View Configuration Server host. If querying with the logged in user and if this user has rights over the server, this field can be left empty.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the specified user. (This parameter is used only when the user wants to send an encrypted password from outside the task, for example Flowster Studio Portal).
User (text box editor type) (type: string): the user (domain and user, or just user) that have rights on the View Configuration Server host. If querying with the logged in user and if this user has rights over the server, this field can be left empty.

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

Output (type: Dictionary<String,String>): outputs a dictionary of strings, containing a list of name-value pairs information.

Execution: the activity outputs information about the given Desktop Pool:

The output values of the Get View Connection Server Information activity can be extracted from the ConnectionInformation variable by using a ForEach activity:

the activity will be set to KeyValuePair<String,String> type:

Log Off Remote Session

This activity logs out the specified remote session.

Activity Parameters

The Log Off Remote Session activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Password (text box editor type) (type: string): the password for the user that will access the View Configuration Server host.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the specified user. (This parameter is used only when the user wants to send an encrypted password from outside the task, for example Flowster Studio Portal).
Remote User (text box editor type)(type: string): enter the domain and the username for the remote session to be disconnected. E.g. "DemoDomain\Username".
Server (text box editor type) (type: string): the Machine Name or the IP of the View Connection Server host:

User (text box editor type) (type: string): the user (domain and user, or just user) that have rights on the View Configuration Server host. E.g. "DemoDomain\Username".

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

Output (type: boolean): outputs the status of the operation.

Execution:

Update View Connection Server Configuration

This activity updates the configuration settings for a View Connection Server instance.

Activity Parameters

The Update View Connection Server Configuration activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Broker ID (text box editor type) (type: string): the name of the connection broker for which the information will be changed. In this example, the broker ID is "VSRPVCS201", the same as the server's name:.
Server (text box editor type) (type: string): the Machine Name or the IP of the View Connection Server host:
Password (text box editor type) (type: string): the password for the user that will access the View Configuration Server host. If querying with the logged in user and if this user has rights over the server, this field can be left empty.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the specified user. (This parameter is used only when the user wants to send an encrypted password from outside the task, for example Flowster Studio Portal).
User (text box editor type) (type: string): the user (domain and user, or just user) that have rights on the View Configuration Server host. If querying with the logged in user and if this user has rights over the server, this field can be left empty.
Direct Connect (combo box editor type) (type: string): True if direct connection will be enabled, otherwise False. This setting specifies if the users will need to connect to a Connection Server or if they will be able to connect right to the virtual machine.
Direct Connect For Local (combo box editor type) (type: string): True if direct connection for local is enabled, otherwise False.
LDAP Backup Frequency (combo box editor type) (type: string): the frequency of the LDAP backups. When you use View Administrator to perform backups, the Connection Server backs up the View LDAP configuration data and the View Composer database. Flowster Studio provides the following options:
- Every 12 Hours
- Every 2 Days
- Every 2 Weeks
- Every 6 Hours
- Every Day
- Every Hour
- Every Week
- Never
Name Mapping (combo box editor type) (type: string): True if name mapping is enabled, otherwise False. This option specifies if the SecureID authentication name should match the Active Directory name. If set to True, then the SecureID authentication name is mapped. If False, the SecureID authentication name is not mapped.
Secure ID Enabled (combo box editor type) (type: string): True is secure ID is enabled, otherwise False. This option refers to configuring a View Connection Server instance so that users are required to use RSA SecurID authentication or RADIUS (Remote Authentication Dial-In User Service) authentication.
Use Compression For Local (combo box editor type) (type: string): True if compression for local is enabled, otherwise False. This option refers to the usage of the data compression.
Use Dedup For Local (combo box editor type) (type: string): True if dedup for local connection is enabled, otherwise False. This option refers to getting round the limited capacity of memory by using in-line de-duplication.
Use SSL For Local (combo box editor type) (type: string): True if SSL for local connections is enabled, otherwise False. This option specifies if the Connection Server is using a secure connection (SSL certificate).
Use SSL For Local Provisioning (combo box editor type) (type: string): True if SSL for local provisioning is enabled, otherwise False. This options specifies if the provisioning remote desktops will use a secure connection (SSL certificate, SSL tunneling).

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

Output (type: Boolean): outputs a dictionary of strings, containing a list of name-value pairs information.

Execution: the activity outputs information about the given Desktop Pool:

Reset Virtual Machines

This activity resets the Virtual Machines for a given Desktop Pool.

Activity Parameters

The Reset Virtual Machines activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Pool ID (text box editor type) (type: string): the ID of the desktop pool for which the VMs will be reset. In Horizon View a desktop pool ID can be numeric or a string, for example "DemoPool", as it can be seen in Horizon View Administrator:
.
Server (text box editor type) (type: string): the Machine Name or the IP of the server where Horizon View is connected to. This server can be seen in Horizon View Administrator, on the Dashboard page:
Password (text box editor type) (type: string): the password for the user that will access Horizon View. If querying with the logged in user and if this user has rights over the server, this field can be left empty.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the specified user. (This parameter is used only when the user wants to send an encrypted password from outside the task, for example Flowster Studio Portal).
Username (text box editor type) (type: string): the user that will access Horizon View. If querying with the logged in user and if this user has rights over the server, this field can be left empty.

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

Output (type: boolean): outputs the status of the operation (True if successful, otherwise False).

Execution: the activity outputs information about the VMs reset operation:

Remove Desktop Pool

This activity removes the given Desktop Pool from Horizon View.

Activity Parameters

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

Parameters:

Pool ID (text box editor type) (type: string): the ID of the desktop pool for which will be removed. In Horizon View a desktop pool ID can be numeric or a string, for example "DemoPool", as it can be seen in Horizon View Administrator:
.
Server (text box editor type) (type: string): the Machine Name or the IP of the server where Horizon View is connected to. This server can be seen in Horizon View Administrator, on the Dashboard page:
Password (text box editor type) (type: string): the password for the user that will access Horizon View. If querying with the logged in user and if this user has rights over the server, this field can be left empty.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the specified user. (This parameter is used only when the user wants to send an encrypted password from outside the task, for example Flowster Studio Portal).
Username (text box editor type) (type: string): the user that will access Horizon View. If querying with the logged in user and if this user has rights over the server, this field can be left empty.

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

Output (type: boolean): outputs the status of the operation (True if successful, otherwise False).

Execution: the activity outputs information about the deletion of the given Desktop Pool: