The orchestration of modern hyperconverged infrastructure requires a shift from manual, imperative management to declarative, automated workflows. The nutanix.ncp Ansible collection serves as the official mechanism for automating the Nutanix Cloud Platform (NCP), providing a structured framework to manage virtualized environments through code. By integrating with the Ansible ecosystem, Nutanix enables administrators and DevOps engineers to treat their infrastructure as software, ensuring consistency across deployments and reducing the operational overhead associated with manual configuration. This collection is engineered with simplicity as its core value, ensuring that it remains easy to use for general administrators while remaining easy to develop for those extending its capabilities. As the infrastructure evolves, the collection has transitioned toward a modern architectural foundation, specifically leveraging v4 APIs and SDKs to provide improved stability and performance, which is critical for large-scale enterprise deployments where API latency and reliability can impact the overall health of the cloud environment.
Technical Architecture and Versioning Evolution
The Nutanix Ansible collection has undergone significant iterative improvements to align with the evolving Nutanix Cloud Platform. The most recent iteration, version v2.5.0, represents a major update that introduces powerful new features and critical bug fixes. This version continues the strategic shift toward the v4 API and SDK framework.
The v4 API and SDK Transition
The decision to build the current collection on v4 APIs and SDKs is not merely a version increment but a fundamental change in how the collection interacts with the Nutanix infrastructure. The v4 layer provides enhanced performance and stability compared to its predecessors, ensuring that the automation scripts can handle more complex requests with fewer failures.
Version History and Key Features
The evolution from v2.4.0 to v2.5.0 highlights the focus on expanding resource support and refining existing modules.
| Version | Key Focus | Primary Enhancements |
|---|---|---|
| v2.4.0 | Stability & Resource Expansion | Introduction of ntnx_prism_host_inventory_v2 for gathering host data; removal of resource limit functionality from ntnx_projects due to API limitations. |
| v2.5.0 | API Expansion & Network Functions | Enhanced coverage of v4 APIs; introduction of Network Functions (Networking) for creating, updating, and deleting functions. |
The *_v2 Suffix Convention
To prevent breaking changes and to allow users to distinguish between legacy modules and those built on the v4 architecture, a version suffix system has been implemented. All resources and data sources specific to version 2.0.0 and later are marked with the _v2 suffix. This allows for a side-by-side existence of old and new modules during a migration period, ensuring that users can transition their automation playbooks incrementally without risking immediate system failure.
Installation and Environment Configuration
Deploying the Nutanix Ansible collection requires a precise sequence of installations to ensure the Python environment and the Ansible core are compatible with the module requirements.
Prerequisite Requirements
The fundamental requirement for utilizing this collection is a pre-installed instance of Ansible. If Ansible is not present on the host, it must be installed following the official Ansible installation guides. Furthermore, there is a strict dependency on the Ansible core version.
- Ansible Core Requirement: The collection requires
ansible-core>=2.16.0. - Explicit Installation: If
ansible-coreis not installed or if the installed version is below 2.16.0, it must be installed explicitly to ensure the collection functions correctly.
Standard Installation Procedure
For most users, the installation is performed via Ansible Galaxy, the public hub for Ansible content.
- Install the collection using the galaxy command:
ansible-galaxy collection install nutanix.ncp - Install the necessary Python dependencies. The host must have the dependencies listed in the
requirements.txtfile. These should be installed into the Python environment using pip:pip install -r ~/.ansible/collections/ansible_collections/nutanix/ncp/requirements.txt
Developer-Centric Installation and Setup
For engineers who wish to contribute to the collection or modify its behavior, a manual build process from the source code is available. This process involves cloning the official repository and building the collection locally.
- Clone the GitHub repository:
git clone https://github.com/nutanix/nutanix.ansible.git - Checkout the specific release version:
git checkout <release_version> -b <release_version> - Install the required Python dependencies:
pip install -r requirements.txt - Build the collection using the galaxy tool:
ansible-galaxy collection build
Functional Resource Support and Module Capabilities
The nutanix.ncp collection provides a wide array of modules designed to manage different facets of the Nutanix Cloud Platform.
Network Functions (Networking)
With the release of v2.5.0, the collection has expanded its capabilities into the networking domain. Using the v4 SDKs, administrators can now perform the following operations on network functions: - Create new network functions. - Update existing network function configurations. - Delete obsolete network functions.
Cluster Management and Inventory
The ntnx_prism_host_inventory_v2 module is a critical component for visibility into the physical and virtual layers of the cluster. It leverages v4 APIs to gather comprehensive host inventory data. This functionality is essential for auditing, capacity planning, and ensuring that host configurations are consistent across the environment.
Project and Resource Management
In previous versions, the ntnx_projects module included resource limit functionality. However, because this functionality was not supported by the underlying API, it was removed in version v2.4.0 to maintain factual alignment between the Ansible module and the actual API capabilities.
Database Support
The collection includes modules based on Nutanix Database Service (NDB). These modules have been specifically supported and tested against PostgreSQL-based databases, ensuring a stable path for automating database lifecycles. Furthermore, the apptiers option has been added to facilitate the support of multi-tier policies, allowing for more granular control over how database tiers are managed.
Lifecycle Management and Deprecation Path
Nutanix has established a clear timeline for the deprecation of legacy automation tools to force the adoption of more stable, modern APIs.
Legacy API Deprecation
Modules based on legacy APIs (v0.8, v1, v2, and v3) are slated for deprecation. This is a critical timeline for any organization relying on old Ansible scripts.
- Deprecation Date: Q4-CY2026.
- Impact: After this date, legacy modules will no longer be supported.
- Migration Path: Nutanix strongly encourages the migration of all scripts and applications to the v2 version of the modules, which are built on v4 APIs and SDKs.
The transition to v4-based modules is necessary to leverage the latest innovations and enhanced capabilities provided by the Nutanix platform. Users are advised to refer to the Legacy API Deprecation Announcement and the accompanying FAQs for detailed migration guidance.
Support Ecosystem and Governance
Because the nutanix.ncp collection is Red Hat Ansible Certified Content, users have multiple avenues for support depending on their licensing and deployment method.
Enterprise Support via Red Hat
Users who deploy the collection through the Ansible Automation Platform (AAP) are entitled to professional support. This is facilitated through the "Create issue" button located on the top right corner of the platform, allowing for direct ticket submission to Red Hat.
Community-Based Support
For users who obtain the collection via GitHub or Ansible Galaxy and do not have an AAP subscription, support is primarily community-driven. - Ansible Forum: This serves as the primary hub for community help and troubleshooting. - Open-Source Contributions: The community model encourages contributions directly to the open-source Nutanix Ansible Collections repository.
Advanced API/SDK Support Program
Nutanix has introduced a premium, developer-centric support program designed for organizations that require a deeper level of technical engagement. This program is tailored for those building complex custom applications on top of the Nutanix environment.
- Access to Technical Advisors: Participants get access to specialists in developer tools and Nutanix Ansible Collections.
- Custom Integration Support: The program provides guidance for unique development needs and complex integration queries.
- Access Point: Information regarding this program is available through the Nutanix Support Portal under Premium Add-On Support Programs.
Conclusion
The Nutanix Ansible collection represents a sophisticated bridge between the Nutanix Cloud Platform and the industry-standard automation framework of Ansible. By moving toward a v4 API architecture, Nutanix has ensured that the nutanix.ncp collection is not only performant but also scalable for the next generation of cloud infrastructure. The strategic implementation of the _v2 suffix and the clear deprecation roadmap for legacy APIs (targeting Q4-CY2026) provides a professional glide path for enterprises to modernize their automation without risking sudden operational failure. Whether through the community-supported model or the Advanced API/SDK Support Program, the ecosystem is designed to support both the casual user and the professional developer. The integration of specific capabilities such as multi-tier policy support for PostgreSQL databases and the expansion into network functions underscores the collection's role as a comprehensive tool for total cloud orchestration.