Adding fix for multiple modules names in docs (#540)

* Adding fix for multiple modules names in docs * Adding docs examples&return for network info V2 module * Minor doc fixes --------- Co-authored-by: bhati-pradeep <[email protected]>
nutanix · Dec 16, 2024 · 7676e48 · 7676e48
1 parent f3d47c4
commit 7676e48
Show file tree

Hide file tree

Showing 87 changed files with 317 additions and 226 deletions.
diff --git a/plugins/modules/ntnx_address_groups_info_v2.py b/plugins/modules/ntnx_address_groups_info_v2.py
@@ -31,7 +31,7 @@
 """
 EXAMPLES = r"""
 - name: Fetch address groups using external id
-  ntnx_address_groups_info_v2:
+  nutanix.ncp.ntnx_address_groups_info_v2:
     state: present
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
@@ -40,7 +40,7 @@
   register: result
 
 - name: List all address groups
-  ntnx_address_groups_info_v2:
+  nutanix.ncp.ntnx_address_groups_info_v2:
     state: present
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"

diff --git a/plugins/modules/ntnx_address_groups_v2.py b/plugins/modules/ntnx_address_groups_v2.py
@@ -78,7 +78,7 @@
 
 EXAMPLES = r"""
 - name: Create address group
-  ntnx_address_groups_v2:
+  nutanix.ncp.ntnx_address_groups_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
@@ -92,7 +92,7 @@
         prefix_length: 32
 
 - name: delete address group
-  ntnx_address_groups_v2:
+  nutanix.ncp.ntnx_address_groups_v2:
     state: present
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"

diff --git a/plugins/modules/ntnx_authorization_policies_info_v2.py b/plugins/modules/ntnx_authorization_policies_info_v2.py
@@ -33,7 +33,7 @@
 """
 EXAMPLES = r"""
 - name: Get 10 auth policies
-  ntnx_authorization_policies_info_v2:
+  nutanix.ncp.ntnx_authorization_policies_info_v2:
     nutanix_host: "{{ nutanix_host }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
@@ -42,7 +42,7 @@
   ignore_errors: true
 
 - name: Get specific auth policy
-  ntnx_authorization_policies_info_v2:
+  nutanix.ncp.ntnx_authorization_policies_info_v2:
     nutanix_host: "{{ nutanix_host }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
@@ -51,7 +51,7 @@
   ignore_errors: true
 
 - name: Fetch using filters
-  ntnx_authorization_policies_info_v2:
+  nutanix.ncp.ntnx_authorization_policies_info_v2:
     nutanix_host: "{{ nutanix_host }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"

diff --git a/plugins/modules/ntnx_categories_info_v2.py b/plugins/modules/ntnx_categories_info_v2.py
@@ -33,13 +33,13 @@
 """
 EXAMPLES = r"""
 - name: list all categories
-  ntnx_categories_info_v2:
+  nutanix.ncp.ntnx_categories_info_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
 
 - name: List all categories with keyname & expand associations
-  ntnx_categories_info_v2:
+  nutanix.ncp.ntnx_categories_info_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>

diff --git a/plugins/modules/ntnx_categories_v2.py b/plugins/modules/ntnx_categories_v2.py
@@ -59,7 +59,7 @@
 
 EXAMPLES = r"""
 - name: Create category key & value
-  ntnx_categories_v2:
+  nutanix.ncp.ntnx_categories_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
@@ -68,7 +68,7 @@
     description: "ansible test"
 
 - name: Update category value and description
-  ntnx_categories_v2:
+  nutanix.ncp.ntnx_categories_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
@@ -78,7 +78,7 @@
     description: "ansible test New value"
 
 - name: Delete created category key value pair
-  ntnx_categories_v2:
+  nutanix.ncp.ntnx_categories_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>

diff --git a/plugins/modules/ntnx_clusters_info_v2.py b/plugins/modules/ntnx_clusters_info_v2.py
@@ -33,22 +33,22 @@
 
 EXAMPLES = r"""
 - name: fetch cluster info using external ID
-  ntnx_clusters_info_v2:
+  nutanix.ncp.ntnx_clusters_info_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
     ext_id: 00061de6-4a87-6b06-185b-ac1f6b6f97e2
   register: result
 
 - name: fetch all clusters info
-  ntnx_clusters_info_v2:
+  nutanix.ncp.ntnx_clusters_info_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
   register: result
 
 - name: fetch all clusters info with filter
-  ntnx_clusters_info_v2:
+  nutanix.ncp.ntnx_clusters_info_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>

diff --git a/plugins/modules/ntnx_clusters_nodes_v2.py b/plugins/modules/ntnx_clusters_nodes_v2.py
@@ -471,7 +471,7 @@
 
 EXAMPLES = r"""
 - name: Expand cluster
-  ntnx_clusters_nodes_v2:
+  nutanix.ncp.ntnx_clusters_nodes_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
@@ -523,7 +523,7 @@
   register: result
 
 - name: Remove node from cluster
-  ntnx_clusters_nodes_v2:
+  nutanix.ncp.ntnx_clusters_nodes_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>

diff --git a/plugins/modules/ntnx_clusters_v2.py b/plugins/modules/ntnx_clusters_v2.py
@@ -753,7 +753,7 @@
 
 EXAMPLES = r"""
 - name: Create cluster
-  ntnx_clusters_v2:
+  nutanix.ncp.ntnx_clusters_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
@@ -771,7 +771,7 @@
         domain_awareness_level: "DISK"
 
 - name: Create cluster with network configuration
-  ntnx_clusters_v2:
+  nutanix.ncp.ntnx_clusters_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
@@ -803,7 +803,7 @@
     timeout: 1800
 
 - name: Update cluster
-  ntnx_clusters_v2:
+  nutanix.ncp.ntnx_clusters_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
@@ -822,7 +822,7 @@
         domain_awareness_level: "DISK"
 
 - name: Destroy cluster
-  ntnx_clusters_v2:
+  nutanix.ncp.ntnx_clusters_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>

diff --git a/plugins/modules/ntnx_directory_services_info_v2.py b/plugins/modules/ntnx_directory_services_info_v2.py
@@ -34,15 +34,15 @@
 """
 EXAMPLES = r"""
 - name: List all directory services
-  ntnx_directory_services_info_v2:
+  nutanix.ncp.ntnx_directory_services_info_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
     validate_certs: false
   register: result
 
 - name: Fetch directory service by ext_id
-  ntnx_directory_services_info_v2:
+  nutanix.ncp.ntnx_directory_services_info_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
@@ -51,7 +51,7 @@
   register: result
 
 - name: List all directory services with filter
-  ntnx_directory_services_info_v2:
+  nutanix.ncp.ntnx_directory_services_info_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"

diff --git a/plugins/modules/ntnx_directory_services_v2.py b/plugins/modules/ntnx_directory_services_v2.py
@@ -145,7 +145,7 @@
 
 EXAMPLES = r"""
 - name: Create ACTIVE_DIRECTORY service
-  ntnx_directory_services_v2:
+  nutanix.ncp.ntnx_directory_services_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
@@ -161,7 +161,7 @@
   register: result
 
 - name: Update ACTIVE_DIRECTORY service
-  ntnx_directory_services_v2:
+  nutanix.ncp.ntnx_directory_services_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
@@ -180,7 +180,7 @@
   register: result
 
 - name: Delete ACTIVE_DIRECTORY service
-  ntnx_directory_services_v2:
+  nutanix.ncp.ntnx_directory_services_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"

diff --git a/plugins/modules/ntnx_discover_unconfigured_nodes_v2.py b/plugins/modules/ntnx_discover_unconfigured_nodes_v2.py
@@ -91,7 +91,7 @@
 
 EXAMPLES = r"""
 - name: Discover unconfigured node
-  ntnx_discover_unconfigured_nodes_v2:
+  nutanix.ncp.ntnx_discover_unconfigured_nodes_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>

diff --git a/plugins/modules/ntnx_floating_ips_info_v2.py b/plugins/modules/ntnx_floating_ips_info_v2.py
@@ -32,14 +32,14 @@
 """
 EXAMPLES = r"""
 - name: List Floating_ips
-  ntnx_floating_ips_info_v2:
+  nutanix.ncp.ntnx_floating_ips_info_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
     validate_certs: false
 
 - name: Get floating_ips using ext_id
-  ntnx_floating_ips_info_v2:
+  nutanix.ncp.ntnx_floating_ips_info_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"

diff --git a/plugins/modules/ntnx_floating_ips_v2.py b/plugins/modules/ntnx_floating_ips_v2.py
@@ -144,7 +144,7 @@
 
 EXAMPLES = r"""
 - name: Create floating ip using private IP in VPC
-  ntnx_floating_ips_v2:
+  nutanix.ncp.ntnx_floating_ips_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
@@ -160,7 +160,7 @@
         vpc_reference: "33dba56c-f123-4ec6-8b38-901e1cf716c2"
 
 - name: Delete floating IP
-  ntnx_floating_ips_v2:
+  nutanix.ncp.ntnx_floating_ips_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
@@ -169,7 +169,7 @@
     ext_id: "33dba56c-f123-4ec6-8b38-901e1cf716c2"
 
 - name: Create floating ip with external subnet and vm nic reference
-  ntnx_floating_ips_v2:
+  nutanix.ncp.ntnx_floating_ips_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"

diff --git a/plugins/modules/ntnx_gpus_info_v2.py b/plugins/modules/ntnx_gpus_info_v2.py
@@ -37,7 +37,7 @@
 
 EXAMPLES = r"""
 - name: Fetch GPU information by GPU external ID and VM external ID
-  ntnx_gpus_info_v2:
+  nutanix.ncp.ntnx_gpus_info_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
@@ -47,7 +47,7 @@
   register: result
 
 - name: Fetch all GPUs attached to a VM
-  ntnx_gpus_info_v2:
+  nutanix.ncp.ntnx_gpus_info_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
@@ -56,7 +56,7 @@
   register: result
 
 - name: Fetch all GPUs attached to a VM using filter
-  ntnx_gpus_info_v2:
+  nutanix.ncp.ntnx_gpus_info_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"

diff --git a/plugins/modules/ntnx_gpus_v2.py b/plugins/modules/ntnx_gpus_v2.py
@@ -68,7 +68,7 @@
 
 EXAMPLES = r"""
 - name: Attach GPU to VM
-  ntnx_gpus_v2:
+  nutanix.ncp.ntnx_gpus_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
@@ -81,7 +81,7 @@
     vendor: NVIDIA
 
 - name: Detach GPU from VM
-  ntnx_gpus_v2:
+  nutanix.ncp.ntnx_gpus_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"

diff --git a/plugins/modules/ntnx_hosts_info_v2.py b/plugins/modules/ntnx_hosts_info_v2.py
@@ -37,30 +37,30 @@
 
 EXAMPLES = r"""
 - name: Get host by external ID
-  ntnx_hosts_info_v2:
+  nutanix.ncp.ntnx_hosts_info_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
     ext_id: af49a0bb-b3d7-41c0-b9c2-f4ca0e8763e9
   register: result
 
 - name: Get hosts by cluster external ID
-  ntnx_hosts_info_v2:
+  nutanix.ncp.ntnx_hosts_info_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
     cluster_ext_id: 3a5b8c0e-1d7b-4c1d-9c3e-6f6e4d5b7a8c
   register: result
 
 - name: List all hosts
-  ntnx_hosts_info_v2:
+  nutanix.ncp.ntnx_hosts_info_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>
   register: result
 
 - name: List all hosts with filter
-  ntnx_hosts_info_v2:
+  nutanix.ncp.ntnx_hosts_info_v2:
     nutanix_host: <pc_ip>
     nutanix_username: <user>
     nutanix_password: <pass>

diff --git a/plugins/modules/ntnx_image_placement_policies_info_v2.py b/plugins/modules/ntnx_image_placement_policies_info_v2.py
@@ -28,15 +28,15 @@
 
 EXAMPLES = r"""
 - name: Get image placement policy by ID
-  ntnx_image_placement_policies_info_v2:
+  nutanix.ncp.ntnx_image_placement_policies_info_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"
     validate_certs: false
     ext_id: "policy-12345"
 
 - name: Get all image placement policies
-  ntnx_image_placement_policies_info_v2:
+  nutanix.ncp.ntnx_image_placement_policies_info_v2:
     nutanix_host: "{{ ip }}"
     nutanix_username: "{{ username }}"
     nutanix_password: "{{ password }}"