Skip to content

Prepare Nutanix

For seamless integration of the Nutanix platform with the HyWorks Controller, follow the guidance below:

Supported Versions

Important

  • It is highly recommended to use Prism Central in deployments. Nutanix is moving toward managing through Prism Central and has officially announced that legacy APIs v0.8, v1, v2, and v3 will be deprecated in Q4 2026. Reference: https://download.nutanix.com/misc/LegacyAPI-EOLNotification.pdf

  • The Nutanix versions listed here are only applicable to HyWorks v4.0 or later. For compatibility with other versions of HyWorks and Nutanix, consult the documentation for those versions.

Provider Supported Versions
Nutanix Prism Central
Recommended		 PC 7.5, PC 7.3, PC 2024.2.0.3
Nutanix Prism Element
Not recommended		 AOS 7.0, AOS 6.10
For newer versions, use Prism Central.

Note

In the latest versions of Nutanix Prism Central, Recovery points can be used instead of Snapshots. HyWorks v4.0 has support for Recovery points with the latest Prism Centrals.

Compatibility Matrix

Nutanix AOS Prism Central Compatible HyWorks
AOS 7.5 PC 7.5 v4.0 or above
AOS 7.3 PC 7.3 v4.0 or above
AOS v7.0 PC 2024.3 v3.6-SP2 HF1.1 or above
AOS v6.10 PC 2024.2.0.3 v3.6-HF1.1 or above
Older versions Older versions Refer to the documentation of older versions of HyWorks

Additional Configuration Required for Nutanix API Usage

HyWorks Controller v4.0 requires correct configuration of the sub-type as Prism Central or Prism Element with compatible and recommended API versions.

Note

  • On selecting the sub-type, HyWorks by default sets the compatible and recommended API version, which can be changed only per the recommendations.

  • Upgrade handling: Previous versions of HyWorks did not have Nutanix sub-type and API configurations and thus, HyWorks will automatically set the sub-type and API versions, which can be configured as per recommendations.

Connector Sub-type
(Configured in HyWorks Controller)		 Connector Version Recommended API Version Available API Options
Prism Central Version > 7.0 (greater than v7.0) V4 V4
V3
Version < 7.0 (Lower version than v7.0) V3 V3
Prism Element Version > 7.0 (Greater than v7.0) Not recommended, no options available.
Use Prism Central instead.		 No options available.
Use Prism Central instead.
Version > 6.0 and < 7.0 (Greater than v6.0 and lower than v7.0) V2 V2
V1
Version > 6.0 (Lower than v6.0)
Check the Nutanix EOL information.		 V1 V1

Nutanix API Rate Limit Integration

HyWorks Controller v4.1-HF1 introduces API Rate Limit support for Nutanix connectors. This feature prevents VM cloning and provisioning operations from failing due to API rate limit violations.

  • Applicable to: Nutanix Prism Central v7.0 or above.

  • Configuration Changes: When adding or editing a Nutanix Connector configured with Prism Central v7.0 or later, two new options appear in the connector configuration form:

    UI Field Description
    API Rate Limit Numeric input field to configure the API request rate limit for this connector.
    Fetch Rate Limit Button that automatically retrieves the recommended rate limit based on the infrastructure size/category detected from the Nutanix cluster.

    • Fetch Rate Limit: Clicking Fetch Rate Limit queries the Nutanix cluster and automatically populates the API Rate Limit field with the recommended value based on the infrastructure size category.

      • The fetched value reflects the limit that Nutanix supports for the given cluster size (small, medium, or large deployments).

      • This value is set as the default maximum for that connector instance.

        Important

        The administrator can only decrease the value below the fetched default, but cannot increase it above the fetched default. This prevents over-committing the Nutanix cluster beyond its supported API capacity.

  • Impact and Benefits

    • Failures with bulk operations before v4.1-HF1 (without API Rate Limit):

      • When bulk VM operations (such as cloning 100 VMs) were initiated, HyWorks would issue a large number of concurrent API requests to the Nutanix cluster. If these exceeded the Nutanix API rate limit, operations would fail mid-execution.

    • Resolution with v4.1-HF1 and API Rate Limit:

      • With API Rate Limit integration, HyWorks Controller now throttles API requests to the Nutanix cluster in accordance with the configured limit. Bulk operations such as cloning 100 VMs complete successfully without triggering rate limit errors.

  • Prism Central VM Size vs API Rate Limit Table:

Supported Feature Matrix

Feature Sub Feature Sub Feature Nutanix
Prism Central Prism Element
VM Details OS Information - Yes Yes
Network Adapters/ IP Addresses - Yes Yes
Hostname - Yes Yes
Desktop pool with existing VMs Using Non-provisioned VMs - Yes Yes
Desktop VM Provisioning Clone Type: Linked/Full/Shadow - Clone (Shadow Clone) Clone (Shadow Clone)
Automatic Distribution of VMs as per load Best Host selection No No
Multi-Datastore and
Best Storage Selection based on size		 No No
Clone from Snapshot/ Recovery Point Feature Support Yes Limited
(Older version using Snapshot)
Create Snapshot from Management Console No No
Disk persistence Persistent Yes Yes
Non-persistent
(Create/ Delete VM Restorepoint on User Logoff)		 Yes Yes
Clone on different container Yes No
VM Profile (v3.6+) Deployment Location &
Hardware Specifications		 No No
Recompose Preserve Network/ MAC Address Yes Yes
Graceful/ Selective Recompose Yes Yes
Override server defaults of VM distribution No No
SHD Provisioning Automatic Deployment of Session Teams Yes Yes
Capacity planning (Automatic deployment and power management) Multi-session or shared hosted desktops Yes Yes
Dedicated/ Single-session Desktop
[v3.6-SP2]		 Yes Yes
Schedule Action support Yes Yes
Batch Processing of Nutanix Tasks Bulk operations e.g., clone, delete, power actions to be done in a batch Yes No
Desktop Power Operations - - Yes Yes
Desktop Access Mechanisms Remote Desktop - Yes Yes
Console Connect - No No
HyLabs support Scheduled Provisioning and Delivery - Yes Yes
HyLabs (Additional Features) Create/ Delete Resource Pools - Yes Yes
Virtual IP Adding an IP Address to a network adapter - Yes Yes

OS Support on Providers

OS Support on Providers:

Feature Sub Feature Supported on providers
OS Support on Provider Windows Desktops: Windows 11,10 All connectors
Windows Server 2025/2022/2019/2016 All connectors
Linux Desktops: Ubuntu / Xubuntu 24/22 All connectors
Linux Desktops: RHEL 9.4 All connectors

Important

Linux (Ubuntu/Xubuntu 24/22 and RHEL 9.4) is supported on HPE Morpheus Software - HVM Hypervisor. However, some issues during provisioning in HyWorks have been identified and are being tracked with the HPE technical team.

Feature Comparison - Provider

Click here to view the Supported Feature Matrix Comparison between all Accops-supported Hypervisors.

Install Nutanix Guest Tools

  • It is not mandatory to install Nutanix Guest tools on VMs that will be delivered as virtual desktops, but they can be installed per Nutanix Guest Tools requirements and recommendations.

  • Shutdown Behavior with Nutanix Guest Tools: Nutanix uses ACPI to perform shutdown and restart operations on a VM; this is similar for VMs with and without Nutanix Guest Tools installed.

  • Shutdown inconsistency can cause issues during the following operations:

    • Recompose

    • Restore to the restore point after the user logs out in case of a non-persistent pool.

    • VM deletion

Prerequisites

  1. The supported version of Nutanix Prism Central or Prism Element has already been installed and configured. Port 9440, used for connecting Nutanix servers, must be accessible.

  2. A user account with the necessary privileges on Nutanix servers. The user must be able to read all VM information, create and delete resource pools, and create and delete virtual machines.

    If the configured user lacks sufficient privileges, retrieving desktop details might fail, which could impact power operations and provisioning.