Skip to content

Prepare Nutanix

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

Supported Versions

Provider Supported Versions
Nutanix Prism Central
Recommended		 PC 7.6, 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.

Compatibility Matrix

Nutanix AOS Prism Central Compatible HyWorks
AOS 7.6 PC 7.6 v4.1 HF 2.1 or above
AOS 7.5 PC 7.5 v4.0 or above
(Recommended: v4.1-HF2.1)
AOS 7.3 PC 7.3 v4.0 or above
(Recommended: v4.1-HF2.1)
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.

Note

  • 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.

Important for Nutanix Configurations and Deployments

It is highly recommended to use the following configurations:

  • HyWorks Controller Version: v4.1-HF2.1 or later. This version includes fixes for the issues listed below:

    1. Cloning from a Recovery Point does not work correctly.

    2. Cloning from a Recovery Point and MAC preservation do not work together.

  • Prism Central 7.3 or later (Up to the currently supported version, v7.6).

  • APIv4 and APIv4.2 (Recently integrated with HyWorks v4.1-HF2.1).

Why the Latest Prism Central and Latest APIs:

  • Nutanix is transitioning to manage resources through Prism Central and has announced that the legacy APIs v0.8, v1, v2, and v3 will be deprecated in the fourth quarter (Q4) of 2026. For reference, visit: Nutanix End of Life Announcement Bulletin

Note

In Nutanix Prism Central 7.0 and above up to v7.6, use Recovery Points instead of Snapshots. HyWorks v4.0 supports Recovery Points with the latest Prism Central. See recommendations here.

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 Restore point 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

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, HyWorks has identified some provisioning issues and is tracking them with the HPE technical team.

Feature Comparison - Provider

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

Prerequisites

Nutanix Connector

  1. The supported version of Nutanix Prism Central or Prism Element has already been installed and configured. Port 9440, used to connect to 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 and create and delete resource pools and virtual machines.

Note

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

Nutanix Guest Tools Requirement

  • Installing Nutanix Guest Tools is not mandatory on VMs delivered as virtual desktops, but you can install it 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 for a non-persistent pool.

    • VM deletion

Configuring Nutanix Connector

Follow the detailed instructions provided in the Nutanix Configuration Section of the Connector Management document.

It is important to understand some very important configurations in Nutanix Connector.

Additional Configuration Required for Nutanix API Usage

Sub-Type and API-Type

HyWorks Controller v4.0 or later requires the Nutanix connector sub-type to be configured 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.3 (greater than or equal to v7.3 up to currently supported Prism Central versions 7.6) V4.0 and V4.2 V4.0 and V4.2
V3
Version > 7.0 and < (greater than v7.0 and lower than v7.3) V4
With a known issue of clone from recovery point.		 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 up to v7.6

  • Configuration Changes: When adding or editing a Nutanix Connector configured with Prism Central v7.0 or later (up to 7.6), 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 Nutanix supports for the given cluster size (small, medium, or large).

      • 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.

  • Prism Central VM Size vs API Rate Limit Table:

    • Refer to the Nutanix document (Section: Rate Limiting) to understand the relationship between Prism Central VM size and API rate limit support.

Important Nutanix Connector Migration Instructions

The following are the recommended HyWorks versions and configurations. If the deployment is not already using these and instead uses Prism Element with APIv2 or Prism Central with APIv3, you will need to migrate the connector. Do not change the configuration directly; instead, plan and migrate using the independent Nutanix Utility.

It is highly recommended to use the following configurations:

  • HyWorks Controller Version: v4.1-HF2.1 or later. This version includes fixes for the issues listed below:

    1. Cloning from a Recovery Point does not work correctly.

    2. Cloning from a Recovery Point and MAC preservation do not work together.

  • Prism Central 7.3 or later (Up to the currently supported version, v7.6).

  • APIv4 and APIv4.2 (Recently integrated with HyWorks v4.1-HF2.1).

Why the Latest Prism Central and Latest APIs:

  • Nutanix is transitioning to manage resources through Prism Central and has announced that the legacy APIs v0.8, v1, v2, and v3 will be deprecated in the fourth quarter (Q4) of 2026. For reference, visit: Nutanix End of Life Announcement Bulletin

Note

In Nutanix Prism Central 7.0 and above up to v7.6, use Recovery Points instead of Snapshots. HyWorks v4.0 supports Recovery Points with the latest Prism Central. See recommendations here.

Migration Candidates

Controller Version Connector Type Configured API Version Migration Strategy
Controller v4.0 or v4.1 1. Prism Central
2. v7.3 or above, up to the latest supported version 7.6		 APIv4 Only API-type should be changed to v4.0 and v4.2.
1. Upgrade to the latest HyWorks Controller with the latest Hotfix, e.g., v4.1-HF2.1.
2. Change Connector to Prism Central >= 7.3 and API to v4.0 and v4.2.
1. Prism Central
2. v7.3 or above, up to the latest supported version 7.6		 APIv3 Migration needed for: 1. Non-persistent Desktop Pools 2. Pools using clone from snapshot for provisioning or recompose.
1. Upgrade to the latest HyWorks Controller with the latest Hotfix, e.g., v4.1-HF2.1.
2. Use the migration tool to analyze the deployment and then migrate as per the suggested plan. 
2. Change Connector to Prism Central >= 7.3 and API to v4.0 and v4.2.
1. Prism Element
2. v7.3 or above, up to the latest supported version 7.6		 APIv2 Migration needed for: 1. Non-persistent Desktop Pools 2. Pools using clone from snapshot for provisioning or recompose.
1. Upgrade to the latest HyWorks Controller with the latest Hotfix, e.g., v4.1-HF2.1.
2. Use the migration tool to analyze the deployment and then migrate as per the suggested plan. 
3. Change  Connector Sub-type to Prism Central >= 7.3, API-type to v4.0 and v4.2, and Host Address to the Prism Central host address.
Controller v3.6-SP2 + HFx or lower 1. Prism Central
2. v7.3 or above, up to the latest supported version 7.6		 APIv3 in advance settings Migration needed for: 1. Non-persistent Desktop Pools 2. Pools using clone from snapshot for provisioning or recompose.
1. Upgrade to the latest HyWorks Controller with the latest hotfix, e.g., v4.1-HF2.1.
2. Use the migration tool to analyze the deployment and then migrate as per the suggested plan. 
3. Change Connector to Prism Central >= 7.3 and API to v4.0 and v4.2.
1. Prism Element
2. v7.3 or above, up to the latest supported version 7.6		 APIv2 in advance settings Migration needed for: 1. Non-persistent Desktop Pools 2. Pools using clone from snapshot for provisioning or recompose.
1. Upgrade to the latest HyWorks Controller with the latest hotfix, e.g., v4.1-HF2.1.
2. Correct out the connector configuration to Prism Element < 7.0. The upgrade does not correctly change the connector type.
3. Use the migration tool to analyze the deployment and then migrate as per the suggested plan. 
4. Change  Connector Sub-type to Prism Central >= 7.3, API-type to v4.0 and v4.2, and Host Address to the Prism Central host address.

Nutanix Utility

Nutanix Utility can be used for the following:

  1. Mock run and analysis of migration requirements.

  2. Running actual migration: Select the desktop pools to be migrated and run the migration.

The download link for the Nutanix Utility can be found here in the HyWorks v4.1-HF2.1 support article.

Nutanix Utility Admin Guide

Access the Nutanix Utility Admin Guide (v1.2.0) here for detailed step-by-step information on using the utility for migration.

  • Nutanix Utility v1.2.0: Automatically detects the Controller database configuration and uses it for any database operations.