Create a Custom Role for Nerdio Manager in vCenter Server

Note

The feature is in Public Preview.

Summary

When you link Nerdio Manager to vCenter Server for AVD Hybrid on VMware vSphere, you don't need to use a vCenter account with full Administrator privileges. Instead, you can create a custom role in vCenter scoped to only the permissions Nerdio Manager needs to manage AVD Hybrid session hosts, and assign that role to the account Nerdio Manager uses to connect.

This article lists the exact permissions to include when building that role, and how to assign it. Both vCenter Single Sign-On accounts (for example, user@vsphere.local) and local vCenter accounts are supported.

Create the custom role in vCenter Server

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

  2. Select Menu > Administration.

  3. Under Access Control, select Roles.

  4. Select the Add role (+) icon.

  5. In the Role name field, enter a name for the role (for example, Nerdio Manager Connector).

  6. In the privilege tree, expand each category below and select the checkbox for each permission listed in the tables.

  7. Select OK to save the role.

Permissions to include

Global

Permission

Used for

Manage custom attributes 1

Defines the custom attribute Nerdio Manager uses to tag session host VMs (for example, host pool ID). Used the first time a session host is created, if the attribute doesn't exist yet

Set custom attribute

Writes the attribute value onto a session host VM

Virtual machine > Provisioning

Permission

Used for

Deploy template

Creates new session host VMs from your VM template

Customize guest

Applies guest OS customization (computer name, domain join preparation) during provisioning

Read customization specifications

Checked by vCenter when it applies guest OS customization to a new session host

Virtual machine > Edit Inventory

Permission

Used for

Create new

Checked by vCenter when it creates the new session host VM from the template

Create from existing

Registers a new session host VM in inventory during deploy-from-template

Remove

Removes a session host VM from inventory when it is deleted from a host pool

Virtual machine > Interaction

Permission

Used for

Power On

Powers on session host VMs

Power Off

Powers off session host VMs

Reset

Restarts session host VMs

Virtual machine > Change Configuration

Permission

Used for

Add or remove device

Replaces the network adapter of a session host during provisioning and when a host is re-imaged

Change CPU count

Sets the vCPU count during deployment and when resizing a session host

Change Memory

Sets the memory allocation during deployment and when resizing a session host

Resource

Permission

Used for

Assign virtual machine to resource pool

Places new session host VMs into the selected resource pool

Datastore

Permission

Used for

Allocate space

Provisions session host virtual disks on the target datastore

Network

Permission

Used for

Assign network 2

Assigns a network (portgroup) to a session host VM during provisioning

1 Works only when granted at the vCenter Server root object. It can't be scoped to a datacenter, cluster, or folder.

2 Must be granted on the network object itself (the portgroup or distributed portgroup), not only on the VM folder.

Both conditions are met automatically when you assign the role at the vCenter Server root object with propagation, as described below.

Note

If your datastores use storage policies (for example, vSAN) and provisioning fails with a storage policy permission error, also add VM storage policies > View VM storage policies to the role. If your VM templates are encrypted, the account also needs the vCenter privileges for cloning encrypted virtual machines (the Cryptographer privileges).

Assign the role to the connecting account

Creating the role only defines what it's allowed to do. It doesn't grant anyone access until you assign it to the account Nerdio Manager uses to connect.

We recommend assigning the role at the vCenter Server root object:

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

  2. Select Add Permission.

  3. Choose the account Nerdio Manager will use to connect, and the role you just created.

  4. Enable Propagate to children.

  5. Select OK.

Assigning the role at the root with propagation covers your datacenters, clusters, hosts, resource pools, folders, VMs, templates, networks, and datastores in one step.

Warning

Don't assign this role only at a datacenter or cluster. The Manage custom attributes permission only works when granted at the vCenter Server root object. If the role is assigned lower, the permission silently fails and session host provisioning returns permission errors. Also, a permission entry placed directly on a folder, datastore, or network can override the role that propagates from the root, so check those objects if provisioning fails with a permission error.

When the role is assigned, enter the account's user name and password when you link vSphere in Nerdio Manager.

For more information on vCenter roles and permissions, see Broadcom's Using Roles to Assign Privileges documentation.

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.