From 6e321e5a4371e3b7c4338158f52228c082d6a5ad Mon Sep 17 00:00:00 2001 From: abhinavbansal29 Date: Wed, 25 Dec 2024 00:05:20 +0530 Subject: [PATCH 1/9] Changes in Readme file --- README.md | 181 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 181 insertions(+) diff --git a/README.md b/README.md index 76b92b3a..67a34ab5 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,23 @@ It is designed keeping simplicity as the core value. Hence it is Checkout this [blog](https://www.nutanix.dev/2022/08/05/getting-started-with-the-nutanix-ansible-module/) for getting started with nutanix ansible module. +~> **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](https://portal.nutanix.com/page/documents/eol/list?type=announcement) +[Legacy API Deprecation - FAQs](https://portal.nutanix.com/page/documents/kbs/details?targetId=kA0VO0000005rgP0AQ) +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. + + ## Support Ansible Nutanix Provider leverages the community-supported model. See [Open Source Support](https://portal.nutanix.com/page/documents/kbs/details?targetId=kA07V000000LdWPSA0) for more information about its support policy. +-> **Note:** 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. +**Contributions to open-source Nutanix Ansible Collections repository will continue to leverage a community-supported model. Visit https://portal.nutanix.com/kb/13424 for more details. + + # Version compatibility ## Ansible @@ -22,6 +35,13 @@ This collection requires ansible-core>=2.15.0 ## Python This collection requires Python 3.9 or greater +## Releases + +| Ansible Version | Software releases | Supported Software Versions | AOS | +| --- | --- | --- | --- | +| 2.0 | pc release | pc2024.3 | 7.0 | +| 1.9.2 | + ## Prism Central > For the 1.1.0 release of the ansible plugin it will have N-2 compatibility with the Prism Central APIs. This release was tested against Prism Central versions pc2022.1.0.2, pc.2021.9.0.5 and pc.2021.8.0.1. @@ -251,6 +271,167 @@ ansible-playbook examples/iaas/iaas.yml | ntnx_ndb_slas | Create, update and delete sla | | ntnx_ndb_slas_info | Get slas info | +## Resources + + +| 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 | + +## Data Sources + +| 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_permissions_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_operations_info_v2 | +| - | 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 | + + ## Inventory Plugins | Name | Description | From 1caa623e4a543af23d32c464760bf593afa96ed7 Mon Sep 17 00:00:00 2001 From: abhinavbansal29 Date: Wed, 1 Jan 2025 23:11:57 +0530 Subject: [PATCH 2/9] Added Version matrix --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 67a34ab5..1dd8fed0 100644 --- a/README.md +++ b/README.md @@ -37,10 +37,20 @@ This collection requires Python 3.9 or greater ## Releases -| Ansible Version | Software releases | Supported Software Versions | AOS | -| --- | --- | --- | --- | -| 2.0 | pc release | pc2024.3 | 7.0 | -| 1.9.2 | +| Ansible Version | AOS Version | PC version | Other software versions | +| :--- | :--- | :--- | :--- | +| 2.0 | 7.0 | pc2024.3 or later | ndb v2.5.1.1, nke v2.8 | +| 1.9.2 | | pc2024.1 | | +| 1.9.1 | | pc2023.1.0.2, pc2023.3 | ndb v2.5.1.1, nke v2.8.0, foundation v5.2 | +| 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 | +| 1.8.0 | | pc2022.6 | ndb v2.5.0, ndb v2.5.1 | +| 1.7.0 | | pc2022.6, pc2022.4, pc2022.1.0.2 | | +| 1.6.0 | | | nke v2.3.0, nke v2.4.0, nke v2.5.0 | +| 1.5.0 | | pc2022.6, pc2022.4.0.2, pc2022.1.0.2 | | +| 1.4.0 | | pc2022.4, pc2022.1.0.2, pc2021.9.0.4 | | +| 1.3.0 | | pc2022.4, pc2022.1.0.2, pc2021.9.0.4 | | +| 1.2.0 | | pc2022.4, pc2022.1.0.2, pc.2021.9.0.5 | | +| 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 | ## Prism Central > For the 1.1.0 release of the ansible plugin it will have N-2 compatibility with the Prism Central APIs. This release was tested against Prism Central versions pc2022.1.0.2, pc.2021.9.0.5 and pc.2021.8.0.1. From 91b1353ae9d249a642b3005792091bb3f498b57d Mon Sep 17 00:00:00 2001 From: abhinavbansal29 Date: Tue, 7 Jan 2025 15:50:32 +0530 Subject: [PATCH 3/9] Changes in Readme file, added Support and some links --- README.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 1dd8fed0..3e29ad4e 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,9 @@ We understand that this transition may require some effort, and we are committed ## Support -Ansible Nutanix Provider leverages the community-supported model. See [Open Source Support](https://portal.nutanix.com/page/documents/kbs/details?targetId=kA07V000000LdWPSA0) for more information about its support policy. - -> **Note:** 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. +[Visit our Support Portal - Premium Add-On Support Programs](https://www.nutanix.com/support-services/product-support/premium-support-programs) to learn more about this program.

**Contributions to open-source Nutanix Ansible Collections repository will continue to leverage a community-supported model. Visit https://portal.nutanix.com/kb/13424 for more details. @@ -37,20 +35,20 @@ This collection requires Python 3.9 or greater ## Releases -| Ansible Version | AOS Version | PC version | Other software versions | -| :--- | :--- | :--- | :--- | -| 2.0 | 7.0 | pc2024.3 or later | ndb v2.5.1.1, nke v2.8 | -| 1.9.2 | | pc2024.1 | | -| 1.9.1 | | pc2023.1.0.2, pc2023.3 | ndb v2.5.1.1, nke v2.8.0, foundation v5.2 | -| 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 | -| 1.8.0 | | pc2022.6 | ndb v2.5.0, ndb v2.5.1 | -| 1.7.0 | | pc2022.6, pc2022.4, pc2022.1.0.2 | | -| 1.6.0 | | | nke v2.3.0, nke v2.4.0, nke v2.5.0 | -| 1.5.0 | | pc2022.6, pc2022.4.0.2, pc2022.1.0.2 | | -| 1.4.0 | | pc2022.4, pc2022.1.0.2, pc2021.9.0.4 | | -| 1.3.0 | | pc2022.4, pc2022.1.0.2, pc2021.9.0.4 | | -| 1.2.0 | | pc2022.4, pc2022.1.0.2, pc.2021.9.0.5 | | -| 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 | +| Ansible Version | AOS Version | PC version | Other software versions | Supported | +| :--- | :--- | :--- | :--- | :--- | +| 2.0 | 7.0 | pc2024.3 or later | ndb v2.5.1.1, 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 | ## Prism Central > For the 1.1.0 release of the ansible plugin it will have N-2 compatibility with the Prism Central APIs. This release was tested against Prism Central versions pc2022.1.0.2, pc.2021.9.0.5 and pc.2021.8.0.1. From bde2d5be1b878d194a32c36699a7c85d65b7c7d2 Mon Sep 17 00:00:00 2001 From: abhinavbansal29 Date: Tue, 7 Jan 2025 19:59:23 +0530 Subject: [PATCH 4/9] Fixes in Readme --- README.md | 68 +++++++++++-------------------------------------------- 1 file changed, 13 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 3e29ad4e..bab1628f 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,9 @@ This collection requires Python 3.9 or greater | Ansible Version | AOS Version | PC version | Other software versions | Supported | | :--- | :--- | :--- | :--- | :--- | -| 2.0 | 7.0 | pc2024.3 or later | ndb v2.5.1.1, nke v2.8 foundation v5.7 ndb v2.7| yes | +| 2.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.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 | @@ -50,28 +50,6 @@ This collection requires Python 3.9 or greater | 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 | -## Prism Central -> For the 1.1.0 release of the ansible plugin it will have N-2 compatibility with the Prism Central APIs. This release was tested against Prism Central versions pc2022.1.0.2, pc.2021.9.0.5 and pc.2021.8.0.1. - -> For the 1.2.0 release of the ansible plugin it will have N-2 compatibility with the Prism Central APIs. This release was tested against Prism Central versions pc.2022.4, pc2022.1.0.2 and pc.2021.9.0.5. - -> For the 1.3.0 release of the ansible plugin it will have N-2 compatibility with the Prism Central APIs. This release was tested against Prism Central versions pc.2022.4, pc2022.1.0.2 and pc.2021.9.0.4. - -> For the 1.4.0 release of the ansible plugin it will have N-2 compatibility with the Prism Central APIs. This release was tested against Prism Central versions pc.2022.4, pc2022.1.0.2 and pc.2021.9.0.4. - -> For the 1.5.0 release of the ansible plugin it will have N-2 compatibility with the Prism Central APIs. This release was tested against Prism Central versions pc.2022.6, pc.2022.4.0.2 and pc2022.1.0.2. - -> For the 1.7.0 release of the ansible plugin it will have N-2 compatibility with the Prism Central APIs. This release was tested against Prism Central versions pc.2022.6, pc.2022.4 and pc2022.1.0.2. - -> For the 1.8.0 release of the ansible plugin it will have N compatibility with the Prism Central APIs. This release was tested against Prism Central version pc.2022.6 . - -> For the 1.9.0 release of the ansible plugin it will have N-1 compatibility with the Prism Central APIs. This release was tested against Prism Central version pc.2023.1 and pc.2023.1.0.1 . - -> For the 1.9.1 release of the ansible plugin it will have N-1 compatibility with the Prism Central APIs. This release was tested against Prism Central version pc.2023.3 and pc.2023.1.0.2 . - -> For the 1.9.2 release of the ansible plugin it will have N-1 compatibility with the Prism Central APIs. This release was sanity tested against Prism Central version pc.2024.1 . - - ### Notes: 1. Static routes module (ntnx_static_routes) is supported for PC versions >= pc.2022.1 @@ -81,41 +59,18 @@ This collection requires Python 3.9 or greater 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. -Prism Central based examples: https://github.com/nutanix/nutanix.ansible/tree/main/examples/ - -## Foundation -> For the 1.1.0 release of the ansible plugin, it will have N-1 compatibility with the Foundation. This release was tested against Foundation versions v5.2 and v5.1.1 +5. Currently NDB based modules are supported and tested against postgres based databases. -> For the 1.9.1 release of the ansible plugin, it was tested against versions v5.2 +### Examples: +1. Prism Central: https://github.com/nutanix/nutanix.ansible/tree/main/examples/ -Foundation based examples : https://github.com/nutanix/nutanix.ansible/tree/main/examples/foundation +2. Foundation: https://github.com/nutanix/nutanix.ansible/tree/main/examples/foundation -## Foundation Central -> For the 1.1.0 release of the ansible plugin, it will have N-1 compatibility with the Foundation Central . This release was tested against Foundation Central versions v1.3 and v1.2 +3. Foundation Central: https://github.com/nutanix/nutanix.ansible/tree/main/examples/fc -Foundation Central based examples : https://github.com/nutanix/nutanix.ansible/tree/main/examples/fc +4. Karbon: https://github.com/nutanix/nutanix.ansible/tree/main/examples/karbon -## Karbon -> For the 1.6.0 release of the ansible plugin, it will have N-2 compatibility with the Karbon. This release was tested against Karbon versions v2.3.0, v2.4.0 and v2.5.0 - -> For the 1.9.0 release of the ansible plugin, it was tested against Karbon versions v2.6.0, v2.7.0 and v2.8.0 - -> For the 1.9.1 release of the ansible plugin, it was tested against Karbon version v2.8.0 - -Karbon based examples : https://github.com/nutanix/nutanix.ansible/tree/main/examples/karbon - -## Nutanix Database Service (ERA) - -> For the 1.8.0 release of the ansible plugin, it will have N-1 compatibility with the Nutanix Database Service (ERA). This release was tested against NDB versions v2.5.0 and v2.5.1 - -> For the 1.9.0 release of the ansible plugin, it was tested against NDB versions v2.5.0.2 - -> For the 1.9.1 release of the ansible plugin, it was tested against NDB versions v2.5.1.1 - -NDB based examples : https://github.com/nutanix/nutanix.ansible/tree/main/examples/ndb - -### Notes: -1. Currently NDB based modules are supported and tested against postgres based databases. +5. NDB: https://github.com/nutanix/nutanix.ansible/tree/main/examples/ndb # Installing the collection **Prerequisite** @@ -281,6 +236,7 @@ ansible-playbook examples/iaas/iaas.yml ## Resources +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 | | :--- | :--- | @@ -374,6 +330,8 @@ ansible-playbook examples/iaas/iaas.yml ## Data Sources +Note: v1 are based on legacy APIs (v0.8,v1,v2 and v3 APIs) and v2 are based on prism central v4 APIs. + | v1 datasources | v2 datasources | | :--- | :--- | | ntnx_acps_info | ntnx_authorization_policies_info_v2 | @@ -432,7 +390,7 @@ ansible-playbook examples/iaas/iaas.yml | - | ntnx_directory_services_info_v2 | | - | ntnx_saml_identity_providers_info_v2 | | - | ntnx_operations_info_v2 | -| - | ntnx_hosts_info_v2 | +| ntnx_hosts_info | ntnx_hosts_info_v2 | | - | ntnx_recovery_points_info_v2 | | - | ntnx_vm_recovery_point_info_v2 | | - | ntnx_gpus_info_v2 | From 5d365f1079b4d2cff2d9ba75d42e32a6df31ae90 Mon Sep 17 00:00:00 2001 From: abhinavbansal29 Date: Tue, 7 Jan 2025 20:12:34 +0530 Subject: [PATCH 5/9] Changes in Readme --- README.md | 109 ++---------------------------------------------------- 1 file changed, 4 insertions(+), 105 deletions(-) diff --git a/README.md b/README.md index bab1628f..c45cd88e 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,8 @@ It is designed keeping simplicity as the core value. Hence it is Checkout this [blog](https://www.nutanix.dev/2022/08/05/getting-started-with-the-nutanix-ansible-module/) for getting started with nutanix ansible module. -~> **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 +### 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](https://portal.nutanix.com/page/documents/eol/list?type=announcement) [Legacy API Deprecation - FAQs](https://portal.nutanix.com/page/documents/kbs/details?targetId=kA0VO0000005rgP0AQ) 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. @@ -19,7 +20,7 @@ We understand that this transition may require some effort, and we are committed ## Support --> **Note:** Update!! +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](https://www.nutanix.com/support-services/product-support/premium-support-programs) to learn more about this program.

**Contributions to open-source Nutanix Ansible Collections repository will continue to leverage a community-supported model. Visit https://portal.nutanix.com/kb/13424 for more details. @@ -134,110 +135,10 @@ ansible-playbook examples/iaas/iaas.yml # Included Content -## Modules - -| Name | Description | -| --- | --- | -| ntnx_acps | Create, Update, Delete acp. | -| ntnx_acps_info | Get acp info. | -| ntnx_address_groups | Create, Update, Delete Nutanix address groups. | -| ntnx_address_groups_info | Get address groups info. | -| ntnx_categories | Create, Update, Delete categories | -| ntnx_categories_info | Get categories info. | -| ntnx_clusters_info | Get cluster info. | -| ntnx_floating_ips | Create or delete a Floating Ip. | -| ntnx_floating_ips_info | List existing Floating_Ips. | -| ntnx_hosts_info | Get host info. | -| ntnx_images | Create, update or delete a image. | -| ntnx_images_info | List existing images. | -| ntnx_image_placement_policy | Create, update or delete a image placement policy. | -| ntnx_image_placement_policies_info | List existing image placement policies. | -| ntnx_karbon_clusters | Create, Delete k8s clusters | -| ntnx_karbon_clusters_info | Get clusters info. | -| ntnx_karbon_clusters_node_pools | Update node pools of kubernetes cluster | -| ntnx_karbon_registries | Create, Delete a karbon private registry entry | -| ntnx_karbon_registries_info | Get karbon private registry registry info. | -| ntnx_pbrs | Create or delete a PBR. | -| ntnx_pbrs_info | List existing PBRs. | -| ntnx_permissions_info | List permissions info | -| ntnx_projects | create, update and delete pc projects | -| ntnx_projects_info | Get projects info. | -| ntnx_protection_rules | create, update and delete pc protection rules | -| ntnx_protection_rules_info | Get pc protection rules info. | -| ntnx_recovery_plans | create, update and delete pc recovery plans | -| ntnx_recovery_plans_info | Get pc recovery plans info. | -| ntnx_recovery_plan_jobs | create and perform action on pc recovery plans | -| ntnx_recovery_plan_jobs_info | Get pc recovery plan jobs info. | -| ntnx_roles | Create, Update, Delete Nutanix roles | -| ntnx_roles_info | Get roles info. | -| ntnx_security_rules | Create, update or delete a Security Rule. | -| ntnx_security_rules_info | List existing Security Rules. | -| ntnx_service_groups | Create, Update, Delete service_group | -| ntnx_service_groups_info | Get service groups info. | -| ntnx_static_routes | Update static routes of a vpc. | -| ntnx_static_routes_info | List existing static routes of a vpc. | -| ntnx_subnets | Create or delete a Subnet. | -| ntnx_subnets_info | List existing Subnets. | -| ntnx_user_groups | Create, Delete user_groups. | -| ntnx_user_groups_info | Get user groups info. | -| ntnx_users | Create, Delete users | -| ntnx_users_info | Get users info. | -| ntnx_vms | Create or delete a VM. | -| ntnx_vms_clone | Clone VM. | -| ntnx_vms_ova | Create OVA image from VM. | -| ntnx_vms_info | List existing VMs. | -| ntnx_vpcs | Create or delete a VPC. | -| ntnx_vpcs_info | List existing VPCs. | -| ntnx_foundation | Image nodes and create new cluster. | -| ntnx_foundation_aos_packages_info | List the AOS packages uploaded to Foundation. | -| ntnx_foundation_bmc_ipmi_config | Configure IPMI IP address on BMC of nodes. | -| ntnx_foundation_discover_nodes_info | List the nodes discovered by Foundation. | -| ntnx_foundation_hypervisor_images_info | List the hypervisor images uploaded to Foundation. | -| ntnx_foundation_image_upload | Upload hypervisor or AOS image to Foundation VM. | -| ntnx_foundation_node_network_info | Get node network information discovered by Foundation. | -| ntnx_foundation_central | Create a cluster out of nodes registered with Foundation Central. | -| ntnx_foundation_central_api_keys | Create a new api key which will be used by remote nodes to authenticate with Foundation Central. | -| ntnx_foundation_central_api_keys_info | List all the api keys created in Foundation Central. | -| ntnx_foundation_central_imaged_clusters_info | List all the clusters created using Foundation Central. | -| ntnx_foundation_central_imaged_nodes_info | List all the nodes registered with Foundation Central. | -| ntnx_ndb_databases_info | Get ndb database instance info | -| ntnx_ndb_clones_info | Get ndb database clones info. | -| ntnx_ndb_time_machines_info | Get ndb time machines info. | -| ntnx_ndb_profiles_info | Get ndb profiles info. | -| ntnx_ndb_db_servers_info | Get ndb database server vms info. | -| ntnx_ndb_databases | Create, update and delete database instances. | -| ntnx_ndb_register_database | Register database instance. | -| ntnx_ndb_db_server_vms | Create, update and delete database server vms. | -| ntnx_ndb_clusters_info | Get clusters info. | -| ntnx_ndb_clusters | Create, update and delete clusters in NDB | -| ntnx_ndb_snapshots_info | Get snapshots info | -| ntnx_ndb_vlans | Create, update and delete vlans | -| ntnx_ndb_vlans_info | Get vlans info in NDB | -| ntnx_ndb_stretched_vlans | Get stretched vlans inf in NDB | -| ntnx_ndb_time_machine_clusters | Manage clusters in NDB time machines | -| ntnx_ndb_tags | Create, update and delete tags | -| ntnx_ndb_tags_info | Get tags info | -| ntnx_ndb_database_clones | Create, update and delete database clones | -| ntnx_ndb_database_snapshots | Create, update and delete database snapshots | -| ntnx_ndb_database_clone_refresh | Perform database clone refresh | -| ntnx_ndb_authorize_db_server_vms | authorize database server vms with time machines | -| ntnx_ndb_profiles | create, update and delete all kind of profiles | -| ntnx_ndb_database_log_catchup | perform log catchup | -| ntnx_ndb_database_restore | perform database restore | -| ntnx_ndb_database_scale | perform database scaling | -| ntnx_ndb_linked_databases | Add and remove linked databases of database instance | -| ntnx_ndb_replicate_database_snapshots | replicate snapshots accross clusters in time machines | -| ntnx_ndb_register_db_server_vm | register database server vm | -| ntnx_ndb_maintenance_tasks | Add and remove maintenance tasks in window | -| ntnx_ndb_maintenance_window | Create, update and delete maintenance window | -| ntnx_ndb_maintenance_windows_info | Get maintenance window info | -| ntnx_ndb_slas | Create, update and delete sla | -| ntnx_ndb_slas_info | Get slas info | +Note: v1 are based on legacy APIs (v0.8,v1,v2 and v3 APIs) and v2 are based on prism central v4 APIs. ## Resources -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 | @@ -330,8 +231,6 @@ Note: v1 are based on legacy APIs (v0.8,v1,v2 and v3 APIs) and v2 are based on p ## Data Sources -Note: v1 are based on legacy APIs (v0.8,v1,v2 and v3 APIs) and v2 are based on prism central v4 APIs. - | v1 datasources | v2 datasources | | :--- | :--- | | ntnx_acps_info | ntnx_authorization_policies_info_v2 | From ce94dc6d57ab92d1c06a1b599c9f5dbb0d5a030a Mon Sep 17 00:00:00 2001 From: abhinavbansal29 Date: Tue, 7 Jan 2025 20:31:57 +0530 Subject: [PATCH 6/9] Minor fix in Readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c45cd88e..6a57e38e 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ We understand that this transition may require some effort, and we are committed 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](https://www.nutanix.com/support-services/product-support/premium-support-programs) to learn more about this program.

-**Contributions to open-source Nutanix Ansible Collections repository will continue to leverage a community-supported model. Visit https://portal.nutanix.com/kb/13424 for more details. +Contributions to open-source Nutanix Ansible Collections repository will continue to leverage a community-supported model. Visit https://portal.nutanix.com/kb/13424 for more details. # Version compatibility From 74a9f25ad6d3c4e2893b235222f18296ee9f6ba6 Mon Sep 17 00:00:00 2001 From: abhinavbansal29 Date: Tue, 7 Jan 2025 20:32:46 +0530 Subject: [PATCH 7/9] Minor fix in Readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6a57e38e..6ab5f1b7 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ It is designed keeping simplicity as the core value. Hence it is Checkout this [blog](https://www.nutanix.dev/2022/08/05/getting-started-with-the-nutanix-ansible-module/) for getting started with nutanix ansible module. -### Important Notice +## 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](https://portal.nutanix.com/page/documents/eol/list?type=announcement) [Legacy API Deprecation - FAQs](https://portal.nutanix.com/page/documents/kbs/details?targetId=kA0VO0000005rgP0AQ) From cc8cb6c1b0fd5618b3e79b02038b722b4da31e8c Mon Sep 17 00:00:00 2001 From: abhinavbansal29 Date: Tue, 7 Jan 2025 21:23:17 +0530 Subject: [PATCH 8/9] Changes version to 2.0.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1fa9668c..3524546d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ It is designed keeping simplicity as the core value. Hence it is Checkout this [blog](https://www.nutanix.dev/2022/08/05/getting-started-with-the-nutanix-ansible-module/) for getting started with nutanix ansible module. -NOTE: The latest version of the Nutanix Ansible collection is [v2.0](https://github.com/nutanix/nutanix.ansible/releases/tag/v2.0). +NOTE: The latest version of the Nutanix Ansible collection is [v2.0.0](https://github.com/nutanix/nutanix.ansible/releases/tag/v2.0.0). ## 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 @@ -39,7 +39,7 @@ This collection requires Python 3.9 or greater | Ansible Version | AOS Version | PC version | Other software versions | Supported | | :--- | :--- | :--- | :--- | :--- | -| 2.0 | 7.0 | pc2024.3 or later | nke v2.8, foundation v5.7, ndb v2.7| 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 | From 40e5dea50a489a95b37421a5b6bfcf72ecaef345 Mon Sep 17 00:00:00 2001 From: abhinavbansal29 Date: Tue, 7 Jan 2025 21:35:04 +0530 Subject: [PATCH 9/9] Added 1 more message --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 3524546d..67e23e04 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,13 @@ Checkout this [blog](https://www.nutanix.dev/2022/08/05/getting-started-with-the NOTE: The latest version of the Nutanix Ansible collection is [v2.0.0](https://github.com/nutanix/nutanix.ansible/releases/tag/v2.0.0). +### Introducing Nutanix Ansible Collection Version 2.0.0 +We're excited to announce the release of Nutanix Ansible Collection Version 2.0.0! This major update brings significant improvements to your infrastructure management experience: + +- Built on the latest v4 APIs/SDKs: Leveraging the power of Nutanix v4 APIs/SDKs, this version offers enhanced functionality and better integration with the latest Nutanix features. +- Expanded Resource Coverage: Discover new resources and data sources, enabling you to model and manage a broader spectrum of Nutanix infrastructure components within your Ansible configurations. +- Version Suffix: To easily distinguish resources and data sources specific to version 2.0.0, they are marked with the *_v2 suffix. + ## 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](https://portal.nutanix.com/page/documents/eol/list?type=announcement)