Nutanix Ansible

Official Nutanix Ansible Collection

Requirements

To run any Nutanix Ansible module, the host must have the Python dependencies listed in requirements.txt Once the collection is installed, install these dependencies into your Python environment using pip: pip install -r ~/.ansible/collections/ansible_collections/nutanix/ncp/requirements.txt This collection requires ansible-core>=2.16.0. This should be installed explicitly if ansible-core version is not installed previously or is below the specified version.

About

Nutanix ansible collection nutanix.ncp is the official Nutanix ansible collection to automate Nutanix Cloud Platform (ncp).

It is designed keeping simplicity as the core value. Hence it is

1. Easy to use
2. Easy to develop

Checkout this blog for getting started with nutanix ansible module.

NOTE: The latest version of the Nutanix Ansible collection is v2.4.0.

Introducing Nutanix Ansible Collection Version v2.4.0

We are excited to announce the release of Nutanix Ansible Collection v2.4.0 — a major update that brings powerful new features and enhancements for automating your Nutanix infrastructure.

What's New in v2.4.0

• Built on v4 APIs/SDKs
  This release is built on the latest Nutanix v4 APIs and SDKs, providing improved performance, stability, and alignment with the newest platform capabilities.

• New Resource Support

  • Key Management Server (Security): Manage and configure external Key Management Servers for securing workloads.
  • Security Technical Implementation Guide controls details (Security): View compliance with technical security controls.
  • SSL Certification (Cluster Management): Add and manage SSL certificates for secure cluster communications.
  • Cluster Profile (Cluster Management): Define and manage cluster configuration profiles for consistent deployments.
  • Associate/Disassociate Cluster from Cluster Profile (Cluster Management): Link or unlink clusters to profiles for streamlined management.
  • Associate/Disassociate Categories to Cluster (Cluster Management): Assign or remove custom categories to clusters.
  • Storage Policies (Data Policies): Create and manage storage policy rules to optimize resource allocation.
  • End User License Agreement (Licensing): Accept or view the EULA for cluster usage and compliance.
  • ntnx_prism_vm_inventory_v2 (VMM): Collect and report detailed VM inventory using the v4 APIs.
  • ntnx_prism_host_inventory_v2 (Cluster Management): Gather host inventory data with enhanced v2 module functionality using v4 APIs.

• Major Improvements

  • Logger (All): Add logger based on flag to enable debug logs.
  • Internal code enhancement (ntnx_vms_cd_rom_iso_v2): Add internal code enhancement for ntnx_vms_cd_rom_iso_v2 module
  • Provide sysprep or cloud-init (ntnx_vms): Add functionality to provide sysprep or cloud-init to module ntnx_vms via a variable instead of a file
  • Remove resource limit (ntnx_projects): Remove resource limit functionality from ntnx_projects as not supported by API

• Bug Fixes and Stability Improvements

  • Setting script_path fails in module ncp.ntnx_vms #835
  • Ansible Inventory Plugin is missing project filter #869
  • Remove Default Values in module ntnx_lcm_config_v2 #879
  • Not able to disable apc_config in module ntnx_vms_v2 #872
  • Inventory Plugin Category Limitation #846

• Breaking change

  • Remove resource limit (ntnx_projects): Remove resource limit functionality from ntnx_projects as not supported by API

---

Upgrade now to take advantage of these powerful features and streamline your Nutanix automation workflows!

Important Notice

Upcoming Deprecation of Legacy Nutanix Ansible Modules. Starting with the Nutanix Ansible Collection release planned for Q4-CY2026, legacy modules which are based on v0.8,v1,v2 and v3 APIs will be deprecated and no longer supported. For more information, visit Legacy API Deprecation Announcement Legacy API Deprecation - FAQs Nutanix strongly encourages you to migrate your scripts and applications to the latest v2 version of the Nutanix Ansible modules, which are built on our v4 APIs/SDKs. By adopting the latest v2 version based on v4 APIs and SDKs, our users can leverage the enhanced capabilities and latest innovations from Nutanix. We understand that this transition may require some effort, and we are committed to supporting you throughout the process. Please refer to our documentation and support channels for guidance and assistance. Version Suffix: To easily distinguish resources and data sources specific to version 2.0.0 and later, they are marked with the *_v2 suffix.

Support

As Red Hat Ansible Certified Content, this collection is entitled to support through the Ansible Automation Platform (AAP) using the Create issue button on the top right corner. If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there may community help available on the Ansible Forum.

Update!! We now have a brand new developer-centric Support Program designed for organizations that require a deeper level of developer support to manage their Nutanix environment and build applications quickly and efficiently. As part of this new Advanced API/SDK Support Program, you will get access to trusted technical advisors who specialize in developer tools including Nutanix Ansible Collections and receive support for your unique development needs and custom integration queries. Visit our Support Portal - Premium Add-On Support Programs to learn more about this program.<br /><br /> Customers not taking advantage of the Advanced API/SDK Support Program will continue to receive the support through our standard, community-supported model. This community model also provides support for contributions to the open-source Nutanix Ansible Collections repository.Visit Nutanix Portal KB for more details.

Version compatibility

Ansible

This collection requires ansible-core>=2.16.0. This should be installed explicitly if ansible-core version is not installed previously or is below the specified version.

Python

This collection requires Python 3.10 or greater

Releases

| Ansible Version | AOS Version | PC version | Other software versions | Supported | | :--- | :--- | :--- | :--- | :--- | | 2.4.0 | 7.5 | pc7.5 or later| | yes | | 2.3.0 | 7.3, 7.3.1 | pc7.3, pc7.3.1 or later| | yes | | 2.2.0 | 7.0.1, 7.0, 7.3 | pc2024.3, pc2024.3.1, pc7.3 or later| | yes | | 2.1.1 | 7.0.1, 7.0 | pc2024.3, pc2024.3.1 or later| | yes | | 2.1.0 | 7.0.1, 7.0 | pc2024.3, pc2024.3.1 or later| | yes | | 2.0.0 | 7.0 | pc2024.3 or later | nke v2.8, foundation v5.7, ndb v2.7| yes | | 1.9.2 | | pc2024.1 | | yes | | 1.9.1 | | pc2023.1.0.2, pc2023.3 | ndb v2.5.1.1, nke v2.8.0, foundation v5.2 | yes | | 1.9.0 | | pc2023.1, pc.2023.1.0.1 | ndb v2.5.0.2, nke v2.6.0, nke v2.7.0, nke v2.8.0 | no | | 1.8.0 | | pc2022.6 | ndb v2.5.0, ndb v2.5.1 | no | | 1.7.0 | | pc2022.6, pc2022.4, pc2022.1.0.2 | | no | | 1.6.0 | | | nke v2.3.0, nke v2.4.0, nke v2.5.0 | no | | 1.5.0 | | pc2022.6, pc2022.4.0.2, pc2022.1.0.2 | | no | | 1.4.0 | | pc2022.4, pc2022.1.0.2, pc2021.9.0.4 | | no | | 1.3.0 | | pc2022.4, pc2022.1.0.2, pc2021.9.0.4 | | no | | 1.2.0 | | pc2022.4, pc2022.1.0.2, pc.2021.9.0.5 | | no | | 1.1.0 | | pc2022.1.0.2, pc.2021.9.0.5, pc.2021.8.0.1 | foundation v5.2, foundation v5.1.1, foundation central v1.3, foundation central v1.2 | no |

SDK-PC-PE Compatibility

| SDK | PC | PE | | :--- | :--- | :--- | | v4.2, v4.1, v4.0 | pc7.5 | 7.5 | | v4.1, v4.0 | pc7.3, pc7.3.1 | 7.3, 7.3.1 | | v4.0 | pc2024.3.1, pc2024.3 | 7.0.1, 7.0 |

Notes:

1. Static routes module (ntnx_static_routes) is supported for PC versions >= pc.2022.1

2. Adding cluster references in projects module (ntnx_projects) is supported for PC versions >= pc.2022.1

3. For Users and User Groups modules (ntnx_users and ntnx_user_groups), adding Identity Provider (IdP) & Organizational Unit (OU) based users/groups are supported for PC versions >= pc.2022.1

4. ntnx_security_rules - The apptier option in target group has been removed. New option called apptiers has been added to support multi tier policy.

5. Currently NDB based modules are supported and tested against postgres based databases.

Examples:

1. Prism Central

2. Foundation

3. Foundation Central

4. Karbon

5. NDB

Installing the collection

Prerequisite

Ansible should be pre-installed. If not, please follow official ansible install guide .

Installation can be done as per usage us