AVD Hybrid on VMware vSphere

Note

The feature is in Public Preview.

Nerdio Manager supports VMware vSphere on-premises infrastructure as a hybrid host type for AVD host pools, providing automated VM lifecycle and power management for session host VMs running on vSphere clusters. Session host VMs are managed through vCenter Server and connected to Azure via Azure Arc. This article provides an overview of prerequisites and walks you through the initial configuration steps required to set up the integration in vCenter Server and Nerdio Manager.

Prerequisites

System and environment requirements

The following minimum vSphere component versions are required for use with Nerdio Manager:

Component

Minimum version

vCenter Server

8.0 Update 3

ESXi

8.0

VMware Tools

The latest version available for your ESXi hosts, installed in the VM template

Network connectivity

Before configuring the vSphere integration in Nerdio Manager, ensure that the Nerdio instance has network connectivity to vCenter Server. This connectivity must be established over a secure network path such as a site-to-site VPN or Azure ExpressRoute. Direct public internet access to the vCenter Server endpoint is not supported. Confirm the following before proceeding:

  • A VPN or ExpressRoute connection is active and stable between the Azure-hosted Nerdio instance and the network segment hosting vCenter Server.

  • The Nerdio instance can reach vCenter Server on the required port (default: TCP 443).

  • Firewall rules permit inbound HTTPS traffic from the Nerdio instance to the vCenter Server endpoint.

  • The network that session host VMs connect to has outbound internet access. This is required for Azure Arc onboarding and AVD agent registration.

  • The session host network provides DHCP. Nerdio Manager configures the network adapter of each new session host to obtain its IP address from DHCP.

  • The session host network and your Active Directory domain controllers can reach each other in both directions.

Active Directory and Microsoft Entra ID
  • A Domain Controller (DC) must be deployed and synchronized with Microsoft Entra ID. vSphere session host VMs join this domain as part of the session host provisioning process.

  • vSphere host pools must use an Active Directory directory profile. Microsoft Entra join is not supported for vSphere session hosts.

  • A client secret for the App Registration is required as part of the configuration process outlined below. For guidance on generating a client secret, see the Add a client secret tab in the Add and manage application credentials in Microsoft Entra ID Microsoft documentation.

  • A Microsoft Entra ID App Registration is required for the Hybrid Client App configuration. Guidance on creating the App Registration is provided in Step 2: Configure the Hybrid Client App (App Registration) below.

VM templates

A VM template in vCenter Server is required as the source for session host provisioning. The template does not need to be generalized (sysprepped). During provisioning, Nerdio Manager clones a VM from the template and uses vSphere guest customization, which runs Sysprep on the new VM and applies an unattend.xml during the Windows specialize pass to set the VM computer name, join the VM to the domain, and execute the Azure Arc onboarding script. VMware Tools must be installed in the template. More details on this process are provided in the next document, AVD Hybrid on VMware vSphere: Create a VM template.

Warning

Do not generalize the VM with Sysprep before you create the template. A template that was already generalized can cause guest customization to fail.

vCenter Server service account

A vCenter Server account is required for Nerdio Manager to interact with the vCenter Server APIs. Both vCenter Single Sign-On accounts (for example, nerdio@vsphere.local) and accounts from an identity source configured in vCenter Server are supported. The account must be assigned one of the following roles at the vCenter Server root object, with propagation to child objects:

The account user name and password are entered in Nerdio Manager when linking vCenter Server in Step 1: Link vCenter Server below.

Role-based access control (RBAC) and permissions

Nerdio Manager roles

This procedure requires the Admin Nerdio role to carry out the tasks outlined below.

Azure built-in roles

The Arc resource group is the Azure resource group you select for Arc machines when you add a host. Nerdio Manager registers the session host VMs there.

Role

Assigned to

Scope

Purpose

Azure Connected Machine Onboarding

The service principal of the Hybrid Client App registration (see Step 2: Configure the Hybrid Client App (App Registration))

The Arc resource group. Assigning it at the subscription level also works.

Allows the Hybrid Client App to register the session host VMs as Azure Arc-connected machines during provisioning. You assign this role yourself. When you add a host, Nerdio Manager checks for it and shows an error if it is missing.

User Access Administrator or Owner

The user who adds the host, or the Nerdio Manager application identity (either one)

The Arc resource group, or a higher scope such as the subscription

Allows Nerdio Manager to assign the Reader role below.

Reader

The host pool's system managed identity

The Arc resource group

Nerdio Manager assigns this role automatically the first time you add a host. See System managed identity and role assignment.

Additional permissions

A vCenter Server account with the Administrator role, or a custom role with the permissions listed in Create a Custom Role for Nerdio Manager in vCenter Server, is required for Nerdio Manager to interact with the vCenter Server APIs.

Procedure

Create a vCenter Server service account

You can skip this procedure if you use an existing vCenter Server account or an account from an identity source configured in vCenter Server.

  1. Sign in to vCenter Server with the vSphere Client as an administrator.

  2. Select Menu > Administration.

  3. Under Single Sign On, select Users and Groups.

  4. In the Users area, select the vsphere.local domain (or your SSO domain).

  5. Select Add.

  6. Enter a Username and Password, and optionally a description, then select Add.

Note

Save the user name and password. Both are required when linking vCenter Server in Nerdio Manager.

Assign the Administrator role

By default, a new account has no permissions in vCenter Server. A permission must be added to grant access.

  1. In the vSphere Client, navigate to Hosts and Clusters and select the vCenter Server root object (the top-level vCenter Server, not a datacenter or cluster).

  2. In the Permissions area, select Add.

  3. Select the domain and search for your service account.

  4. In Role, select Administrator. To grant only the permissions Nerdio Manager needs, select the custom role you created instead.

  5. Select Propagate to children, then select OK.

The service account user name and password are used when linking vCenter Server in Step 1: Link vCenter Server below.

Configuration

Step 1: Link vCenter Server

In Nerdio Manager, navigate to Settings > Integrations > vSphere > vSphere Configuration and select Add to link a vCenter Server instance.

Enter the following information:

Field

Description

Name

A friendly display name for this vSphere configuration (max 256 characters)

Hostname / IP address

The hostname or IP address of the vCenter Server instance (e.g. vsphere.example.com) (max 512 characters)

Port

The vCenter Server API port (default: 443)

User name

The vCenter Server service account user name (max 256 characters)

Password

The password for the vCenter Server service account (max 256 characters)

After you enter the connection details, select Next. Nerdio Manager connects to the vCenter Server endpoint, retrieves its certificate, and shows the certificate details: common name, issuer, subject alternative names, serial number, signature algorithm, SHA-256 fingerprint, and validity dates.

  • If the certificate was issued by a trusted certificate authority, Nerdio Manager confirms this and you can select OK to continue.

  • If the certificate is self-signed, untrusted, expired, revoked, or doesn't match the hostname, Nerdio Manager shows a warning that lists the problem. Verify that the details match the vCenter Server instance you intend to connect to, select I trust this certificate and want to continue connecting to this endpoint, and then select OK. Select Decline to go back and change the connection details.

The same check runs when you edit an existing vCenter Server connection.

Note

The hostname or IP address and the port cannot be changed after the vSphere configuration is saved. To connect to a different vCenter Server, link a new vSphere configuration. You can link more than one vCenter Server instance.

Step 2: Configure the Hybrid Client App (App Registration)

The Hybrid Client App is shared by all AVD Hybrid host types. If a Hybrid Client App is already configured in Nerdio Manager (for example, for Nutanix host pools), skip to Required role assignments to confirm the role assignment on the Arc resource group used for vSphere session hosts.

  • Copy the Application (client) ID and generate a client secret. Both are required in the configuration fields below.

Next, navigate to Settings > Integrations > Hybrid Client App and select Configure.

The Hybrid Client App is a Microsoft Entra ID App Registration whose Service Principal is used to onboard vSphere session host VMs to Azure Arc. During VM provisioning, the onboarding script runs inside the guest OS and uses the Service Principal to register the VM as an Azure Arc-connected machine.

Enter the following information:

Field

Description

Name

A friendly display name (max 256 characters)

App ID

The Application (client) ID from the Entra ID App Registration

App Secret

A client secret for the App Registration (max 512 characters)

Required role assignments

The service principal associated with this app registration must have the Azure Connected Machine Onboarding role on the Arc resource group, which is the resource group you select for Arc machines when you add a host. You can also assign the role at the subscription level, which applies to every resource group in that subscription. Nerdio Manager does not assign this role for you. When you add a host, it checks for the role and shows an error if it is missing.

Via Azure portal
  1. Navigate to the Azure portal > Resource Group > Access Control (IAM).

  2. Select Add role assignment.

  3. Select Azure Connected Machine Onboarding.

  4. Assign it to the Service Principal of the App Registration.

Via Azure CLI
az role assignment create \
 --assignee "<SP_APP_ID>" \
 --role "Azure Connected Machine Onboarding" \
 --resource-group "<Arc_Resource_Group>"

Step 3: Create a hybrid host pool

  1. Switch back to Nerdio Manager and navigate to Host Pools.

  2. Select the Hybrid Host Pools area.

  3. Select New Host Pool and then Add vSphere host pool.

System managed identity and role assignment

When you create a vSphere host pool, Nerdio Manager creates a system managed identity for the host pool. The first time you add a host, Nerdio Manager assigns that identity the Reader role on the Arc resource group. You do not need to assign it yourself.

Note

To assign the Reader role, Nerdio Manager uses the permissions of the user who adds the host. If that fails, it uses the Nerdio Manager application identity. At least one of them needs a role that can assign roles, such as User Access Administrator or Owner, on the Arc resource group or a higher scope. If neither does, adding the host fails with an error. If you assign the Reader role to the host pool's system managed identity on the Arc resource group yourself before you add the first host, Nerdio Manager skips this step and neither permission is needed.

VM configuration parameters

When creating session hosts, the following parameters are configured. Session hosts are configured in the Add host to vSphere pool dialog (select the host pool, then New host) and, for dynamic host pools, in the VM Template step of the host pool wizard.

Parameter

Description

Constraints

Host count

Number of session hosts to add

Add host to vSphere pool dialog only. Minimum 1

Host name

Name or naming convention for session host VMs. Labeled Name in the host pool wizard

Prefix (up to 10 valid Windows computer name characters; a unique "-xxxx" suffix is appended), Pattern, or Exact (only when adding a single host)

Resource group

Azure resource group for Arc machines (the Arc resource group)

The Hybrid Client App service principal must have the Azure Connected Machine Onboarding role on this resource group

Location

Azure region for the Arc resource

Should match your Arc onboarding configuration

vSphere configuration

The linked vCenter Server instance

Must be configured in Settings

Datacenter

vSphere datacenter where the VM is created

From selected vSphere configuration

Folder

vSphere VM folder where the VM is placed

From selected datacenter

Resource pool

vSphere resource pool where the VM runs, grouped by cluster. A cluster's root resource pool is shown with "(Root)"

From selected datacenter

VM template

vSphere VM template used to create the VM

From selected datacenter

Total vCPUs

Number of virtual CPUs

1 - 64

RAM (GB)

RAM allocation in gigabytes

1 - 1024 GB

Assign users

Users to pre-assign to the new session hosts

Add host to vSphere pool dialog, personal host pools only. Users only (no groups); cannot exceed the number of hosts being added

Tags

Custom Azure tags to apply to the session host

Optional

Note

The OS disk size of new session hosts comes from the VM template. To change it, update the VM template in vCenter Server.

Procedures

The following articles guide you through additional setup and management of AVD Hybrid on VMware vSphere:

Was this article helpful?

0 out of 0 found this helpful
Have more questions? Submit a request

Comments (0 comments)

Article is closed for comments.