IT Automation Activities
Last updated Jun 11, 2024

Add Virtual Machine to Host Pool



Adds an existing Azure virtual machine to the specified host pool.

Note: The status of the virtual machine to be added to the host pool needs to be Running.

This activity runs a PowerShell script that does the following actions:

Project compatibility

Windows - Legacy | Windows | Cross-platform


  • DisplayName - The display name of the activity.
Execution Options
  • Timeout - Specifies the amount of time (in seconds) to wait for the activity to run before an error is thrown. If not set, the activity runs until completion. Taken into consideration when WaitForCompletion is set to True. This field supports only integer and Int32 variables.
  • WaitForCompletion - If set to True, the activity waits to complete before moving to the next activity. This field only supports boolean values (True, False). The default value is True.
  • HostPool - The host pool on which the operation is performed. This field supports only WVDHostPool variables.
  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
  • DomainOrganizationalUnit - The distinguished name of the organizational unit the virtual machine will join. For example, 'OU=MyUnit,DC=mydomain,DC=com'.
  • DomainToJoin - The full domain name of the Active Directory Domain to which the session host virtual machine will be joined. For example, '' or ''.
  • DomainUsername - The user principal name (UPN) of an Active Directory user that has permissions to join the virtual machine to the domain. For example, ''. If DomainToJoin is not set, the virtual machine will be joined to the domain matching the suffix of the UPN.
  • DomainUserPassword - The password for the provided username as a SecureString.
  • SessionHost - The details of the resulted session host. This field supports only WVDSessionHost variables.
Virtual Machine
  • Name - The name of the Azure virtual machine to add to the host pool.
  • ResourceGroupName - The name of the resource group to which the virtual machine belongs.
  • Description
  • Project compatibility
  • Configuration

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.