Each workflow has a specific purpose and requires certain inputs.

For the workflows in the vCAC60 folder, the administrator must bind the workflow to a pod and pool. See Bind vSphereWebClient Workflows to Specific Pods and Pools in vCenter Orchestrator. When a delegated administrator or end user runs the workflow, the workflow operates only on the designated pod and pool.

Add Managed Machines to Pool

Purpose (Available with Horizon vCenter Orchestrator plug-in 1.1) Allows a delegated administrator to add vCenter-managed machines to a manual desktop pool in View. Here, the vCenter instance that manages the machines has been added to View. For example, if you look in View Administrator, you can go to View Configuration > Servers > vCenter Servers, and find the instance in the list.
Inputs/parameters Pod, pool ID, list of virtual machines
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod.
Results The selected virtual machines are added to a manual desktop pool.

Add Unmanaged Machines to Pool

Purpose (Available with Horizon vCenter Orchestrator plug-in 1.1) Allows a delegated administrator to add unmanaged virtual machines to a manual desktop pool in View. The unmanaged machines are in fact managed by a vCenter instance, but the vCenter instance has not been added to View.
Note: This workflow is not for adding physical machines or non-vSphere virtual machines. To add those types of machines, see Adding Physical Machines and Non-vSphere Virtual Machines to Pools.
Inputs/parameters Pod, pool ID, list of virtual machines, guest credentials (see the Limitations row of this table)
Prerequisites See Prerequisites for Adding Unmanaged Machines to Pools.
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool, pod, and guest credentials.
Results The selected virtual machines are registered and added to a manual desktop pool.

If you attempt to add multiple machines by using this workflow but some of the machines are not added for some reason, the workflow will fail and error messages will be included in the log file, specifying why those machines were not added. Other machines will be added successfully.

Limitations
  • If you want to add a machine back to an unmanaged pool that you previously removed from the pool in View, you must wait for some time before adding the machine back to the pool.
  • Choose virtual machines only from vCenter Server instances that have not been added to View. All vCenter Server instances are listed, meaning that vCenter Server instances that have been added to View are not filtered out.
  • If all virtual machines from the vCenter Server instance are not getting displayed in the virtual machine folder, you can choose machines from individual host folders. This issue can occur when the number of virtual machines is very large.
  • After you run the Add Guest Credentials workflow and the Manage Delegated Administrator Configuration for Registration workflow, it can take some time for the guest credentials to be populated in the vCloud Automation Center 6.1 service catalog. You might also need to log out of vCloud Automation Center and log back in to see the credentials.
  • If you remove guest credentials, by running the Remove Guest Credential workflow, you must also run the Refresh Delegated Administrator Configuration workflow, in the Configuration/Delegated Admin Configuration folder.

    If you do not do so, when you run the Add Unmanaged Machines to Pool workflow, you might see the old guest credentials in the drop-down menu in the workflow. If you select these credentials and run the workflow, you get the error message: Can not find credential named TestCredentials Dynamic Script Module name :getGuestCredential#7)

Add User(s) to App Pool

Purpose Allows a delegated administrator to entitle users to an application pool.
Inputs/parameters Pod, pool ID, user names
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required. If you do bind the workflow to a pod, in vSphere Web Client, you see a drop-down list of pools and the users entitled to each pool.
Results Entitled users get direct access to specified applications.

Add User(s) to App Pools

Purpose Allows a delegated administrator to entitle users to multiple application pools.
Inputs/parameters Pod, pool IDs, user names
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to pools and a pod. For the vSphereWebClient folder, the administrator must bind this workflow to a pod. In vSphere Web Client, you see a drop-down list of pools and the users entitled to each pool.
Results Entitled users get direct access to the specified application.

Add User(s) to Desktop Pool

Purpose Allows a delegated administrator to entitle users to a desktop pool.
Inputs/parameters Pod, pool ID, user names
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required. If you do bind the workflow to a pod, in vSphere Web Client, you see a drop-down list of pools and the users entitled to each pool.
Results Users get entitled to the specified desktop pool. They can get a machine for floating pools or automatically assigned dedicated pools (subjected to availability). For other type of pools, users need to be assigned to the machine explicitly through the assignment workflows.

Application Entitlement

Purpose Allows a delegated administrator to entitle users to an application pool and to remove users' entitlements.
Inputs/parameters Pod, pool ID, users to entitle, and users to unentitle (selected from a default list)
Binding requirements For the vCAC60 and vSphereWebClient folders, the administrator must bind this workflow to a pool and pod.
Results Entitlements can be added and removed in the same workflow.

Assign User

Purpose Assigns a user to a specific machine in a desktop pool. An option is provided to entitle the user to a desktop pool as well.
Inputs/parameters Pod, pool ID, machine name, user name
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required.
Results The user is assigned to the specified machine. The existing assignment is removed and the existing session (if any) is logged off forcibly.

Desktop Allocation

Purpose Entitles the user to the specified desktop pool and, for dedicated-assignment pools, assigns a machine to the user (depending on availability). A new machine is provisioned for the user if the pool type is "specified naming."
Inputs/parameters Pod, pool ID, user name
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required.
Results
  • For floating desktop pools and session-based pools from RDS hosts, the user is entitled to the pool.
  • For automatically assigned dedicated pools, the user is entitled to the pool and assigned to an available machine (if any).
  • For dedicated pools that do not use an automatic naming pattern, a virtual machine is provisioned for the user with the name the administrator specifies.

Desktop Allocation for Users

Purpose (Available with Horizon vCenter Orchestrator plug-in 1.1) Entitles multiple users to desktops in floating-assignment pools or RDS desktop pools.

Entitles and assigns multiple users to machines for dedicated assignment pools (depending on availability).

New machines are provisioned for users if the pool type is "specified naming."

Inputs/parameters Pod, pool ID, user names, machine names (for specified naming pool)
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod.
Results
  • For floating desktop pools and session-based pools from RDS hosts, the users are entitled to the pool.
  • For automatically assigned dedicated pools, users are entitled to the pool and assigned to an available machine (if any).
  • For dedicated pools that do not use an automatic naming pattern, virtual machines are provisioned for users with the names the administrator specifies.
Limitations
  • Machines are provisioned line by line. If the workflow fails for one machine, the others will not be provisioned.
  • If you select a specified naming pool, to add a new line in the text box for adding machine names, so that you can add multiple names, press Ctrl+Enter. If you press only Enter, instead of adding a new line, the workflow is submitted.

Desktop Assignment

Purpose Allows a delegated administrator to assign a user to a specific virtual machine and, optionally, entitle the user to the machine, and allows a delegated administrator to also remove an assignment for a user from a specific virtual machine, all in the same workflow.
Inputs/parameters Pod, pool ID, machine name, user to assign, user to unassign
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required.
Results Desktop assignments can be added and removed in the same workflow.

Desktop Entitlement

Purpose Allows a delegated administrator to entitle users to a desktop pool and to remove users' entitlements.
Inputs/parameters Pod, pool ID, users to entitle, and users to unentitle (selected from a default list)
Binding requirements For the vCAC60 and vSphereWebClient folders, the administrator must bind this workflow to a pool and pod.
Results Entitlements can be added and removed in the same workflow.

Desktop Recycle

Purpose This de-provisioning workflow removes user assignment or entitlement from the specified virtual machine desktop. Depending on the pool policy, the virtual machine might be deleted and any persistent disks might be saved.
Inputs/parameters Pod, pool ID, user name
Scope Works for all types of pools.
Prerequisites Run the Add Pool Policy Configuration workflow before running this workflow.
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required. If you do bind the workflow to a pod, in vSphere Web Client, you see a drop-down list of pools and the users entitled to each pool.
Results For floating pools, user entitlement is removed. For other desktop pool types, user assignment is removed.

For dedicated linked-clone pools, the virtual machine is deleted and persistent disks are saved according to the settings used in the Add Pool Policy Configuration workflow.

For full-clone pools, if the virtual machine is deleted, the persistent disk is also deleted.

Limitations
  • Saving a persistent disk (sometimes called a UDD, or user data disk), works only for automated dedicated linked-clone desktop pools.
  • Deleting the virtual machine is not supported for floating pools or manual pools.

Desktop Refresh

Purpose Reverts a specific virtual machine to its base state.
Inputs/parameters Pod, pool ID, machine name
Scope Works only on automated View Composer linked-clone pools.
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required.
Results

For View Composer linked-clone virtual machines, a warning message is sent to the user if there is an active session, and the user is automatically logged out after a certain amount of time. A refresh operation then starts.

Register Machines to Pool

Purpose (Available with Horizon vCenter Orchestrator plug-in 1.1) Registers the supplied machine DNS names with a manual pool of unmanaged desktops in View. Use this workflow only for physical machines and non-vSphere virtual machines.
Note: As an alternative to running this workflow, you can use the Add Physical Machines to Pool workflow, available in the Workflows/Example folder. This workflow combines the actions of the Register Machines to Pool workflow and the PowerShell workflows mentioned in Run Workflows to Add Physical Machines as PowerShell Hosts. Before you run the Add Physical Machines to Pool workflow, you must perform the tasks described in Configure a Physical Machine for an Unmanaged Pool and Configure vCenter Orchestrator to Use Kerberos Authentication with Physical Machines. You must also satisfy the prerequisites listed in Prerequisites for Adding Unmanaged Machines to Pools.
Inputs/parameters Pod, pool ID, machine DNS names, guest OS
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod.
Results Provided machine names are registered with the specified unmanaged desktop pool in View.
Limitations
  • This workflow registers any of the DNS names that are provided without performing any kind of validation. The administrator must manually push the returned registry token to the registered machine.
  • To add a new line in the DNS Names text box, so that you can add multiple DNS names, press Ctrl+Enter. If you press only Enter, instead of adding a new line, the workflow is submitted.
  • To register a Windows Server 2008 R2 machine, you must first log in to View Administrator, select View Configuration > Global Settings > General, click Edit, and select the Enable Windows Server 2008 R2 desktops check box.

Remove Users from Application Pool

Purpose Removes multiple users' entitlements from an application pool.
Inputs/parameters Pod, pool ID, users (selected from a default list)
Binding requirements For the vCAC60 and vSphereWebClient folders, the administrator must bind this workflow to a pool and pod.
Results Specified users are no longer entitled to the specified application pool.

Remove Users from Desktop Pool

Purpose Removes multiple users' entitlements from a desktop pool.
Inputs/parameters Pod, pool ID, users (selected from a default list)
Binding requirements For the vCAC60 and vSphereWebClient folders, the administrator must bind this workflow to a pool and pod.
Results Specified users are no longer entitled to the specified desktop pool.

Self-Service Desktop Allocation

Purpose Allows end users to allocate a machine to themselves. A new machine gets provisioned only for "specified naming" desktop pools.
Inputs/parameters None
Scope Works only on automated pools.
Prerequisites/binding requirements
  • For the vCAC61 folder, the administrator must run the Manage Self Service Pool Configuration workflow to specify which pools are available for selection by end users.
  • For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. This workflow does not appear in the vSphereWebClient folder.
Results
  • For floating desktop pools and session-based pools from RDS hosts, the user is entitled to the pool.
  • For automatically assigned dedicated pools, the user is entitled to the pool and assigned to an available machine (if any).
  • For dedicated pools that do not use an automatic naming pattern, a virtual machine is provisioned for the user with the name the administrator specifies.

Self-Service Desktop Recycle

Purpose Allows end users to de-provision their own virtual machine from the specified pod and desktop pool. This workflow removes user entitlement and assignment.

Depending on the pool policy, the virtual machine might be deleted and any persistent disks might be saved.

Inputs/parameters None
Limitations
  • Saving a persistent disk (sometimes called a UDD, or user data disk), works only for automated dedicated linked-clone desktop pools.
  • Deleting the virtual machine is not supported for floating pools or manual pools.
Prerequisites/binding requirements
  • For the vCAC61 folder, the administrator must run the Manage Self Service Pool Configuration workflow to specify which pools are available for selection by end users.
  • For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. This workflow does not appear in the vSphereWebClient folder.
Results For floating pools, user entitlement is removed. For other desktop pool types, user assignment is removed.

For dedicated linked-clone pools, the virtual machine is deleted and persistent disks are saved according to the settings used in the Add Pool Policy Configuration workflow.

For full-clone pools, if the virtual machine is deleted, the persistent disk is also deleted.

Self-Service Desktop Refresh

Purpose Reverts end user's virtual machine in the specified desktop pool to a base state.
Inputs/parameters None
Scope Works only on automated dedicated View Composer linked-clone pools.
Prerequisites/binding requirements
  • For the vCAC61 folder, the administrator must run the Manage Self Service Pool Configuration workflow to specify which pools are available for selection by end users.
  • For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. This workflow does not appear in the vSphereWebClient folder.
Results

For View Composer linked-clone virtual machines, a warning message is sent to the user if there is an active session, and the user is automatically logged out after a certain amount of time. A refresh operation then starts.

Self-Service Release Application

Purpose Allows end users to remove their entitlement from the specified application pool.
Inputs/parameters None
Prerequisites/binding requirements
  • For the vCAC61 folder, the administrator must run the Manage Self Service Pool Configuration workflow to specify which pools are available for selection by end users.
  • For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. This workflow does not appear in the vSphereWebClient folder.

Self-Service Request Application

Purpose Allows end users to request an application for their own use. The user gets entitled to the specified application pool.
Inputs/parameters None
Prerequisites/binding requirements
  • For the vCAC61 folder, the administrator must run the Manage Self Service Pool Configuration workflow to specify which pools are available for selection by end users.
  • For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. This workflow does not appear in the vSphereWebClient folder.

Session Management

Purpose (Available with Horizon vCenter Orchestrator plug-in 1.1) Allows delegated administrators to disconnect, log off, reset, and send messages to active Horizon desktop sessions. Delegated administrators can perform these operations on user sessions as well.
Inputs/parameters Pod, pool ID, operation, message (for the Send Message operation), user name, and other options
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod.
Results The selected operation is performed on the specified session.
Limitations
  • Application sessions are not supported.
  • The reset operation is not supported for RDS pools and manual unmanaged desktop pools.
  • Multiple session selection is not supported when this workflow is executed from vSphere Web Client or the Orchestrator client.
  • The predefined list of users is not displayed when this workflow is executed from vCloud Automation Center 6.0.

Set Maintenance Mode

Purpose (Available with Horizon vCenter Orchestrator plug-in 1.1) Allows a delegated administrator to put machines in maintenance mode and remove machines from maintenance mode.
Inputs/parameters Pod, pool ID, operation, virtual machine
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod.
Results The selected machines are "entered into maintenance mode" or "exited from maintenance mode."
Limitations This workflow is not supported for RDS pools and manual unmanaged desktop pools.

Unassign User

Purpose Removes the assignment of a user from a virtual machine.
Inputs/parameters Pod, pool ID, machine name (as displayed in the View Administrator UI
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required.
Results The user's assignment is removed and entitlement to the pool remains unchanged. The user's session is logged off forcibly.

Update App Pool Display Name

Purpose Changes the display name of an application pool.
Inputs/parameters Pod, pool ID, new display name for pool
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required.
Results The display name is changed, but the pool ID remains the same.

Update Desktop Pool Display Name

Purpose Changes the display name of a desktop pool.
Inputs/parameters Pod, pool ID, new display name for pool
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required.
Results The display name is changed, but the pool ID remains the same.

Update Desktop Pool Min Size

Purpose Changes the minimum number of desktops that the pool can contain.
Scope Works only for automated floating and automated dedicated pools that use a naming pattern.
Inputs/parameters Pod, pool ID, number to use for the minimum pool size (an integer)
Results The minimum number of virtual machines in the pool changes.
Note: Consider whether your company's hardware resources are sufficient before increasing this number.
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required.

Update Desktop Pool Spare Size

Purpose Changes the number of spare machines in the pool that are available and powered on for new users.
Scope Works only for automated pools.
Inputs/parameters Pod, pool ID, number of spare machines to have ready (an integer)
Binding requirements For the vCAC60 folder, the administrator must bind this workflow to a pool and pod. For the vSphereWebClient folder, no binding is required.
Results Changes the number of spare virtual machines to keep ready and powered on for new users.
Note: Consider whether your company's hardware resources are sufficient before increasing this number.