Official nutanix ansible collection
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
- Easy to use
- Easy to develop
Checkout this blog for getting started with nutanix ansible module.
NOTE: The latest version of the Nutanix Ansible collection is v2.2.0.
We are excited to announce the release of Nutanix Ansible Collection v2.2.0 — a major update that brings powerful new features and enhancements for automating your Nutanix infrastructure.
-
Built on v4.1 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
- Objects: Automate Nutanix Objects (S3-compatible storage) management for scalable storage use cases.
- Service Accounts: Manage service accounts and their associated roles and permissions directly through Ansible.
-
Bug Fixes and Stability Improvements
Multiple bugs have been resolved to improve the reliability and user experience across modules.
Upgrade now to take advantage of these powerful features and streamline your Nutanix automation workflows!
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.
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.
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 https://portal.nutanix.com/kb/13424 for more details.
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.
This collection requires Python 3.10 or greater
| Ansible Version | AOS Version | PC version | Other software versions | Supported |
|---|---|---|---|---|
| 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 |
|---|---|---|
| v4.1, v4.0 | pc7.3 | 7.3 |
| v4.0 | pc2024.3.1, pc2024.3 | 7.0.1, 7.0 |
-
Static routes module (ntnx_static_routes) is supported for PC versions >= pc.2022.1
-
Adding cluster references in projects module (ntnx_projects) is supported for PC versions >= pc.2022.1
-
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
-
ntnx_security_rules - The
apptieroption in target group has been removed. New option calledapptiershas been added to support multi tier policy. -
Currently NDB based modules are supported and tested against postgres based databases.
-
Prism Central: https://github.com/nutanix/nutanix.ansible/tree/main/examples/
-
Foundation: https://github.com/nutanix/nutanix.ansible/tree/main/examples/foundation
-
Foundation Central: https://github.com/nutanix/nutanix.ansible/tree/main/examples/fc
-
Karbon: https://github.com/nutanix/nutanix.ansible/tree/main/examples/karbon
-
NDB: https://github.com/nutanix/nutanix.ansible/tree/main/examples/ndb
Prerequisite
Ansible should be pre-installed. If not, please follow official ansible install guide .
Installation can be done as per usage using below methods:
Published at : https://galaxy.ansible.com/ui/repo/published/nutanix/ncp/
Installation:
ansible-galaxy collection install nutanix.ncp
Install requirements from repository if dependencies are missing in environment (Ref: #600):
pip install -r requirements.txt
For Developers, please follow this install guide for setting up dev environment.
1. Clone the GitHub repository to a local directory
git clone https://github.com/nutanix/nutanix.ansible.git
2. Git checkout release version
git checkout <release_version> -b <release_version>
3. Install requirements
pip install -r requirements.txt
3. Build the collection
ansible-galaxy collection build
4. Install the collection
ansible-galaxy collection install nutanix-ncp-<version>.tar.gz
Note Add --force option for rebuilding or reinstalling to overwrite existing data
You can either call modules by their Fully Qualified Collection Namespace (FQCN), such as nutanix.ncp.ntnx_vms, or you can call modules by their short name if you list the nutanix.ncp collection in the playbook's collections: keyword
For example, the playbook for iaas.yml is as follows:
---
- name: IaaS Provisioning
hosts: localhost
gather_facts: false
collections:
- nutanix.ncp
module_defaults:
group/nutanix.ncp.ntnx:
nutanix_host: <pc_ip>
nutanix_username: <user>
nutanix_password: <pass>
validate_certs: true
tasks:
- include_role:
name: external_subnet
- include_role:
name: vpc
- include_role:
name: overlay_subnet
- include_role:
name: vm
- include_role:
name: fipTo run this playbook, use ansible-playbook command as follows:
ansible-playbook <playbook_name>
ansible-playbook examples/iaas/iaas.yml
Note: v1 are based on legacy APIs (v0.8,v1,v2 and v3 APIs) and v2 are based on prism central v4 APIs.
| v1 Resources | v2 Resources |
|---|---|
| ntnx_acps | ntnx_authorization_policies_v2 |
| ntnx_address_groups | ntnx_address_groups_v2 |
| ntnx_categories | ntnx_categories_v2 |
| ntnx_floating_ips | ntnx_floating_ips_v2 |
| ntnx_images | ntnx_images_v2 |
| ntnx_image_placement_policy | ntnx_image_placement_policies_v2 |
| ntnx_pbrs | ntnx_pbrs_v2 |
| ntnx_projects | - |
| ntnx_protection_rules | - |
| ntnx_recovery_plans | - |
| ntnx_recovery_plan_jobs | - |
| ntnx_roles | ntnx_roles_v2 |
| ntnx_security_rules | ntnx_security_rules_v2 |
| ntnx_service_groups | ntnx_service_groups_v2 |
| ntnx_static_routes | ntnx_routes_v2 |
| ntnx_subnets | ntnx_subnets_v2 |
| ntnx_users | ntnx_users_v2 |
| ntnx_user_groups | ntnx_user_groups_v2 |
| ntnx_vms_ova | - |
| ntnx_vms_clone | ntnx_vms_clone_v2 |
| ntnx_vms | ntnx_vms_v2 |
| ntnx_vpcs | ntnx_vpcs_v2 |
| ntnx_foundation_bmc_ipmi_config | - |
| ntnx_foundation_image_upload | - |
| ntnx_foundation | - |
| ntnx_foundation_central | - |
| ntnx_foundation_central_api_keys | - |
| ntnx_karbon_clusters | - |
| ntnx_karbon_clusters_node_pools | - |
| ntnx_karbon_registries | - |
| ntnx_ndb_databases | - |
| ntnx_ndb_register_database | - |
| ntnx_ndb_db_server_vms | - |
| ntnx_ndb_clusters | - |
| ntnx_ndb_vlans | - |
| ntnx_ndb_stretched_vlans | - |
| ntnx_ndb_time_machine_clusters | - |
| ntnx_ndb_tags | - |
| ntnx_ndb_database_clones | - |
| ntnx_ndb_database_snapshots | - |
| ntnx_ndb_database_clone_refresh | - |
| ntnx_ndb_authorize_db_server_vms | - |
| ntnx_ndb_profiles | - |
| ntnx_ndb_database_log_catchup | - |
| ntnx_ndb_database_restore | - |
| ntnx_ndb_database_scale | - |
| ntnx_ndb_linked_databases | - |
| ntnx_ndb_replicate_database_snapshots | - |
| ntnx_ndb_register_db_server_vm | - |
| ntnx_ndb_maintenance_tasks | - |
| ntnx_ndb_maintenance_window | - |
| ntnx_ndb_slas | - |
| - | ntnx_vms_ngt_v2 |
| - | ntnx_vms_ngt_update_v2 |
| - | ntnx_vms_ngt_upgrade_v2 |
| - | ntnx_vms_ngt_insert_iso_v2 |
| - | ntnx_vms_disks_v2 |
| - | ntnx_vms_categories_v2 |
| - | ntnx_vms_nics_v2 |
| - | ntnx_vms_nics_ip_v2 |
| - | ntnx_vms_nics_migrate_v2 |
| - | ntnx_vms_cd_rom_v2 |
| - | ntnx_vms_cd_rom_iso_v2 |
| - | ntnx_vms_stage_guest_customization_v2 |
| - | ntnx_vms_serial_port_v2 |
| - | ntnx_templates_deploy_v2 |
| - | ntnx_templates_guest_os_v2 |
| - | ntnx_templates_v2 |
| - | ntnx_templates_version_v2 |
| - | ntnx_vms_power_actions_v2 |
| - | ntnx_volume_groups_v2 |
| - | ntnx_volume_groups_disks_v2 |
| - | ntnx_volume_groups_vms_v2 |
| - | ntnx_volume_groups_iscsi_clients_v2 |
| - | ntnx_directory_services_v2 |
| - | ntnx_saml_identity_providers_v2 |
| - | ntnx_clusters_v2 |
| - | ntnx_recovery_points_v2 |
| - | ntnx_recovery_point_restore_v2 |
| - | ntnx_vm_revert_v2 |
| - | ntnx_recovery_point_replicate_v2 |
| - | ntnx_gpus_v2 |
| - | ntnx_clusters_nodes_v2 |
| - | ntnx_pc_registration_v2 |
| - | ntnx_discover_unconfigured_nodes_v2 |
| - | ntnx_storage_containers_stats_v2 |
| - | ntnx_storage_containers_v2 |
| - | ntnx_pc_unregistration_v2 |
| - | ntnx_pc_backup_target_v2 |
| - | ntnx_pc_deploy_v2 |
| - | ntnx_pc_restore_v2 |
| - | ntnx_pc_restore_source_v2 |
| - | ntnx_protection_policies_v2 |
| - | ntnx_promote_protected_resources_v2 |
| - | ntnx_restore_protected_resources_v2 |
| - | ntnx_volume_groups_categories_v2 |
| - | ntnx_lcm_config_v2 |
| - | ntnx_lcm_inventory_v2 |
| - | ntnx_lcm_prechecks_v2 |
| - | ntnx_lcm_upgrades_v2 |
| - | ntnx_users_api_key_v2 |
| - | ntnx_users_revoke_api_key_v2 |
| - | ntnx_object_stores_v2 |
| - | ntnx_object_stores_certificate_v2 |
| v1 datasources | v2 datasources |
|---|---|
| ntnx_acps_info | ntnx_authorization_policies_info_v2 |
| ntnx_address_groups_info | ntnx_address_groups_info_v2 |
| ntnx_categories_info | ntnx_categories_info_v2 |
| ntnx_clusters_info | ntnx_clusters_info_v2 |
| ntnx_floating_ips_info | ntnx_floating_ips_info_v2 |
| ntnx_images_info | ntnx_images_info_v2 |
| ntnx_image_placement_policies_info | ntnx_image_placement_policies_info_v2 |
| ntnx_pbrs_info | ntnx_pbrs_info_v2 |
| ntnx_permissions_info | ntnx_operations_info_v2 |
| ntnx_projects_info | - |
| ntnx_protection_rules_info | - |
| ntnx_recovery_plans_info | - |
| ntnx_recovery_plan_jobs_info | - |
| ntnx_roles_info | ntnx_roles_info_v2 |
| ntnx_security_rules_info | ntnx_security_rules_info_v2 |
| ntnx_service_groups_info | ntnx_service_groups_info_v2 |
| ntnx_static_routes_info | ntnx_routes_info_v2 |
| ntnx_subnets_info | ntnx_subnets_info_v2 |
| ntnx_user_groups_info | ntnx_user_groups_info_v2 |
| ntnx_users_info | ntnx_users_info_v2 |
| ntnx_vms_info | ntnx_vms_info_v2 |
| ntnx_vpcs_info | ntnx_vpcs_info_v2 |
| ntnx_foundation_aos_packages_info | - |
| ntnx_foundation_discover_nodes_info | - |
| ntnx_foundation_hypervisor_images_info | - |
| ntnx_foundation_node_network_info | - |
| ntnx_foundation_central_imaged_nodes_info | - |
| ntnx_foundation_central_imaged_clusters_info | - |
| ntnx_foundation_central_api_keys_info | - |
| ntnx_karbon_clusters_info | - |
| ntnx_karbon_registries_info | - |
| ntnx_ndb_databases_info | - |
| ntnx_ndb_clones_info | - |
| ntnx_ndb_time_machines_info | - |
| ntnx_ndb_profiles_info | - |
| ntnx_ndb_db_servers_info | - |
| ntnx_ndb_slas_info | - |
| ntnx_ndb_clusters_info | - |
| ntnx_ndb_snapshots_info | - |
| ntnx_ndb_vlans_info | - |
| ntnx_ndb_tags_info | - |
| ntnx_ndb_maintenance_windows_info | - |
| - | ntnx_vms_ngt_info_v2 |
| - | ntnx_vms_disks_info_v2 |
| - | ntnx_vms_nics_info_v2 |
| - | ntnx_vms_cd_rom_info_v2 |
| - | ntnx_vms_serial_port_info_v2 |
| - | ntnx_templates_info_v2 |
| - | ntnx_templates_versions_info_v2 |
| - | ntnx_route_tables_info_v2 |
| - | ntnx_volume_groups_info_v2 |
| - | ntnx_volume_groups_disks_info_v2 |
| - | ntnx_volume_groups_iscsi_clients_info_v2 |
| - | ntnx_directory_services_info_v2 |
| - | ntnx_saml_identity_providers_info_v2 |
| ntnx_hosts_info | ntnx_hosts_info_v2 |
| - | ntnx_recovery_points_info_v2 |
| - | ntnx_vm_recovery_point_info_v2 |
| - | ntnx_gpus_info_v2 |
| - | ntnx_nodes_network_info_v2 |
| - | ntnx_storage_containers_info_v2 |
| - | ntnx_pc_backup_target_info_v2 |
| - | ntnx_pc_config_info_v2 |
| - | ntnx_pc_restore_source_info_v2 |
| - | ntnx_pc_restorable_domain_managers_info_v2 |
| - | ntnx_pc_restore_points_info_v2 |
| - | ntnx_protection_policies_info_v2 |
| - | ntnx_protected_resources_info_v2 |
| - | ntnx_lcm_config_info_v2 |
| - | ntnx_lcm_entities_info_v2 |
| - | ntnx_lcm_status_info_v2 |
| - | ntnx_users_api_key_info_v2 |
| - | ntnx_object_stores_info_v2 |
| - | ntnx_object_stores_certificate_info_v2 |
| Name | Description |
|---|---|
| ntnx_prism_vm_inventory | Nutanix VMs inventory source |
ansible-doc nutanix.ncp.<module_name>
We glady welcome contributions from the community. From updating the documentation to adding more functions for Ansible, all ideas are welcome. Thank you in advance for all of your issues, pull requests, and comments!
To conduct integration tests for a specific Ansible module such as the ntnx_vms module, the following step-by-step procedures can be followed:
- Ensure you are in the installed collection directory where the module is located. For example:
/Users/mac.user1/.ansible/collections/ansible_collections/nutanix/ncp
-
Navigate to the
tests/integration/targetsdirectory within the collection. -
Define the necessary variables within the feature-specific var files, such as
tests/integration/targets/prepare_env/vars/main.yml,tests/integration/targets/prepare_foundation_env/vars/main.yml,tests/integration/targets/prepare_ndb_env/tasks/prepare_env.yml, etc.
Note: For Karbon and FC tests, use the PC vars exclusively, as these features rely on pc setup. Not all variables are mandatory; define only the required variables for the particular feature to be tested.
- Run the test setup playbook for the specific feature you intend to test to create entities in setup:
- For PC, NDB, and Foundation tests, execute the relevant commands:
ansible-playbook prepare_env/tasks/prepare_env.yml ansible-playbook prepare_ndb_env/tasks/prepare_env.yml ansible-playbook prepare_foundation_env/tasks/prepare_foundation_env.yml
- For PC, NDB, and Foundation tests, execute the relevant commands:
-
Conduct integration tests for all modules using:
ansible-test integration
-
To perform integration tests for a specific module:
ansible-test integration module_test_name
Replace
module_test_namewith test directory name under tests/integration/targets.
- After completing the integration tests, perform a cleanup specific to the tested feature:
- For PC tests, execute the command:
ansible-playbook prepare_env/tasks/clean_up.yml
- For Foundation tests, execute the command:
ansible-playbook prepare_foundation_env/tasks/clean_up.yml
- For PC tests, execute the command:
By following these steps, you can perform comprehensive integration testing for the specified Ansible module and ensure a clean testing environment afterward. Define only the necessary variables for the specific feature you intend to test.
Refer to examples/iaas for full implementation
---
- name: IaaS Provisioning
hosts: localhost
gather_facts: false
collections:
- nutanix.ncp
vars:
nutanix_host: <pc_ip>
nutanix_username: <user>
nutanix_password: <pass>
validate_certs: true
tasks:
- name: Inputs for external subnets task
include_tasks: external_subnet.yml
with_items:
- { name: Ext-Nat, vlan_id: 102, ip: 10.44.3.192, prefix: 27, gip: 10.44.3.193, sip: 10.44.3.198, eip: 10.44.3.207, eNat: True }
- name: Inputs for vpcs task
include_tasks: vpc.yml
with_items:
- { name: Prod, subnet_name: Ext-Nat}
- { name: Dev, subnet_name: Ext-Nat}
- name: Inputs for overlay subnets
include_tasks: overlay_subnet.yml
with_items:
- { name: Prod-SubnetA, vpc_name: Prod , nip: 10.1.1.0, prefix: 24, gip: 10.1.1.1, sip: 10.1.1.2, eip: 10.1.1.5,
domain_name: "calm.nutanix.com", dns_servers : ["8.8.8.8","8.8.8.4"], domain_search: ["calm.nutanix.com","eng.nutanix.com"] }
- { name: Prod-SubnetB, vpc_name: Prod , nip: 10.1.2.0, prefix: 24, gip: 10.1.2.1, sip: 10.1.2.2, eip: 10.1.2.5,
domain_name: "calm.nutanix.com", dns_servers : ["8.8.8.8","8.8.8.4"], domain_search: ["calm.nutanix.com","eng.nutanix.com"] }
- { name: Dev-SubnetA, vpc_name: Dev , nip: 10.1.1.0, prefix: 24, gip: 10.1.1.1, sip: 10.1.1.2, eip: 10.1.1.5,
domain_name: "calm.nutanix.com", dns_servers : ["8.8.8.8","8.8.8.4"], domain_search: ["calm.nutanix.com","eng.nutanix.com"] }
- { name: Dev-SubnetB, vpc_name: Dev , nip: 10.1.2.0, prefix: 24, gip: 10.1.2.1, sip: 10.1.2.2, eip: 10.1.2.5,
domain_name: "calm.nutanix.com", dns_servers : ["8.8.8.8","8.8.8.4"], domain_search: ["calm.nutanix.com","eng.nutanix.com"] }
- name: Inputs for vm task
include_tasks: vm.yml
with_items:
- {name: "Prod-Wordpress-App", desc: "Prod-Wordpress-App", is_connected: True , subnet_name: Prod-SubnetA, image_name: "wordpress-appserver", private_ip: ""}
- {name: "Prod-Wordpress-DB", desc: "Prod-Wordpress-DB", is_connected: True , subnet_name: Prod-SubnetB, image_name: "wordpress-db", private_ip: 10.1.2.5}
- {name: "Dev-Wordpress-App", desc: "Dev-Wordpress-App", is_connected: True , subnet_name: Dev-SubnetA, image_name: "wordpress-appserver", private_ip: ""}
- {name: "Dev-Wordpress-DB", desc: "Dev-Wordpress-DB", is_connected: True , subnet_name: Dev-SubnetB, image_name: "wordpress-db",private_ip: 10.1.2.5}
- name: Inputs for Floating IP task
include_tasks: fip.yml
with_items:
- {vm_name: "Prod-Wordpress-App"}
- {vm_name: "Dev-Wordpress-App"}
