Skip to content

Commit

Permalink
Adding statement in description to clarify that V4 modules uses PC V4…
Browse files Browse the repository at this point in the history
… APIs based SDKs (#548)

* Adding statement in description to clarify that V4 modules uses PC V4 APIs based SDKs

* Black fix
  • Loading branch information
george-ghawali authored Dec 23, 2024
1 parent 5158f7b commit 23496fe
Show file tree
Hide file tree
Showing 91 changed files with 143 additions and 35 deletions.
1 change: 1 addition & 0 deletions plugins/modules/ntnx_address_groups_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
description:
- Fetch specific address group info using external ID
- Fetch list of multiple address groups info if external ID is not provided with optional filters
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
6 changes: 4 additions & 2 deletions plugins/modules/ntnx_address_groups_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
DOCUMENTATION = r"""
---
module: ntnx_address_groups_v2
short_description: "Create, Update, Delete address groups"
short_description: Create, Update, Delete address groups
version_added: 2.0.0
description: "Create, Update, Delete address groups"
description:
- Create, Update, Delete address groups
- This module uses PC v4 APIs based SDKs
options:
state:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_authorization_policies_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
- It will fetch specific authorization policy if external ID is provided
- It will fetch multiple authorization policies if external ID is not provided
- Use filters to fetch specific authorization policies
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
7 changes: 4 additions & 3 deletions plugins/modules/ntnx_authorization_policies_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
short_description: Manage Nutanix PC IAM authorization policies
description:
- This module allows you to create, update, and delete authorization policies in Nutanix PC.
- This module uses PC v4 APIs based SDKs
version_added: "2.0.0"
options:
state:
Expand Down Expand Up @@ -425,9 +426,9 @@ def delete_authorization_policy(module, result):

result["changed"] = True
if resp is None:
result["msg"] = (
"Authorization policy with ext_id: {} deleted successfully".format(ext_id)
)
result[
"msg"
] = "Authorization policy with ext_id: {} deleted successfully".format(ext_id)
else:
result["response"] = strip_internal_attributes(resp.to_dict())

Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_categories_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
module: ntnx_categories_info_v2
short_description: Nutanix PC categories info module
version_added: 2.0.0
description: 'Get categories info'
description:
- Get categories info
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_categories_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
version_added: "2.0.0"
description:
- This module allows you to create, update, and delete categories in Nutanix Prism Central.
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_clusters_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- This module retrieves information about Nutanix clusters from PC.
- Fetch particular cluster info using external ID
- Fetch multiple clusters info with/without using filters, limit, etc.
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_clusters_nodes_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
short_description: Add or Remove nodes from cluster using Nutanix PC
description:
- This module allows you to manage Nutanix cluster nodes.
- This module uses PC v4 APIs based SDKs
version_added: "2.0.0"
options:
node_params:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_clusters_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
short_description: Manage Nutanix clusters in Prism Central
description:
- This module allows you to create, update, and destroy Nutanix clusters using Prism Central.
- This module uses PC v4 APIs based SDKs
version_added: "2.0.0"
options:
state:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_directory_services_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
description:
- This module is used to fetch directory services.
- Fetch a directory service using ext_id or multiple directory services.
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_directory_services_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
version_added: "2.0.0"
description:
- This module is used to create, update and delete directory services in Nutanix PC.
- This module uses PC v4 APIs based SDKs
options:
state:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_discover_unconfigured_nodes_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
short_description: Discover unconfigured nodes from Nutanix Prism Central
description:
- Discover unconfigured nodes from Nutanix Prism Central.
- This module uses PC v4 APIs based SDKs
version_added: "2.0.0"
options:
address_type:
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_floating_ips_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
module: ntnx_floating_ips_info_v2
short_description: floating_ip info module
version_added: 2.0.0
description: 'Get floating_ips info'
description:
- Get floating_ips info
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_floating_ips_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- Create, Update, Delete floating_ips
- For floating IP create and delete, module will return tasks status in response after operation.
- For floating IP update, module will return floating IP info if C(wait) is true, else task status.
- This module uses PC v4 APIs based SDKs
options:
state:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_gpus_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
short_description: Fetches GPU(s) information attached to VM in a Nutanix prism central.
description:
- This module fetches GPU(s) information attached to a virtual machine in a Nutanix Prism Central.
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_gpus_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
short_description: Module to attach/detach GPUs to/from VMs in Nutanix prism central.
description:
- This module allows you to attach or detach GPUs to or from virtual machines in Nutanix Prism Central.
- This module uses PC v4 APIs based SDKs
options:
state:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_hosts_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- This module retrieves information about Nutanix hosts from PC.
- Fetch particular host info using external ID.
- Fetch multiple hosts info with/without using filters, limit, etc.
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_image_placement_policies_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
- Pradeepsingh Bhati (@bhati-pradeep)
description:
- This module fetches information about Nutanix PC image placement policies.
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_image_placement_policies_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
description:
- This module allows you to create, update, and delete image placement policies in Nutanix Prism Central.
- This module allows you to suspend and resume image placement policies in Nutanix Prism Central.
- This module uses PC v4 APIs based SDKs
version_added: "2.0.0"
author:
- Pradeepsingh Bhati (@bhati-pradeep)
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_images_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
description:
- This module fetches information about Nutanix images.
- The module can fetch information about all images or a specific image.
- This module uses PC v4 APIs based SDKs
version_added: "2.0.0"
author:
- Pradeepsingh Bhati (@bhati-pradeep)
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_images_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
short_description: Manage Nutanix Prism Central images.
description:
- This module allows you to create, update, and delete images in Nutanix.
- This module uses PC v4 APIs based SDKs
version_added: "2.0.0"
author:
- Pradeepsingh Bhati (@bhati-pradeep)
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_nodes_network_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
short_description: Get netowrk information for uncofigured cluster nodes
description:
- This module allows you to Get netowrk information for uncofigured cluster nodes.
- This module uses PC v4 APIs based SDKs
version_added: "2.0.0"
options:
cluster_ext_id:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_operations_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
description:
- This module is used to get operations info
- It can be used to get all operations info or specific permission info using external id
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_pbrs_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- Fetch a single or list of all routing policies
- if ext_id is provided, it will return the routing policy info
- if ext_id is not provided, it will return the list of all routing policies
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_pbrs_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
module: ntnx_pbrs_v2
short_description: Module for create, update and delete of Policy based routing.
version_added: 2.0.0
description: "Create, Update, Delete Routing Policies"
description:
- Create, Update, Delete Routing Policies
- This module uses PC v4 APIs based SDKs
options:
state:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_pc_registration_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
description:
- Registers a domain manager (Prism Central) instance to other entities like PE and PC
- Unregisteration of a domain manager (Prism Central) instance is not supported
- This module uses PC v4 APIs based SDKs
options:
wait:
description: Wait for the operation to complete.
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_recovery_point_replicate_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
version_added: 2.0.0
description:
- Replicate recovery points using external ID
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_recovery_point_restore_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
module: ntnx_recovery_point_restore_v2
short_description: Restore recovery points, Creates a clone of the VM/VG from the selected recovery point
version_added: 2.0.0
description: "Restore recovery points using external ID"
description:
- Restore recovery points using external ID
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_recovery_points_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
description:
- Fetch specific recovery point info using external ID
- Fetch list of multiple recovery points info if external ID is not provided with optional filters
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
16 changes: 9 additions & 7 deletions plugins/modules/ntnx_recovery_points_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
module: ntnx_recovery_points_v2
short_description: Create, Update, Delete recovery points
version_added: 2.0.0
description: Create, Update Expiry Date, Delete recovery points
description:
- Create, Update Expiry Date, Delete recovery points
- This module uses PC v4 APIs based SDKs
options:
state:
description:
Expand Down Expand Up @@ -389,9 +391,9 @@ def update_expiry_date_recovery_point(module, result):
new_expiration_time = module.params.get("expiration_time")

if new_expiration_time is None:
result["error"] = (
"Expiration time is required for updating recovery point and other fields can't be updated."
)
result[
"error"
] = "Expiration time is required for updating recovery point and other fields can't be updated."
module.fail_json(msg="Expiration time is required", **result)

if int(old_expiration_time.timestamp()) == int(
Expand All @@ -413,9 +415,9 @@ def update_expiry_date_recovery_point(module, result):
elif not check_recovery_point_idempotency_without_expiration(
old_spec.to_dict(), update_spec.to_dict()
):
result["warning"] = (
"Only Expiration time Updation is allowed. Can't update other fields."
)
result[
"warning"
] = "Only Expiration time Updation is allowed. Can't update other fields."

expirationTimeSpec = data_protection_sdk.ExpirationTimeSpec()
expirationTimeSpec.expiration_time = new_expiration_time
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_roles_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
module: ntnx_roles_info_v2
short_description: Get roles info
version_added: 2.0.0
description: Get roles info using roles external ID or list all roles
description:
- Get roles info using roles external ID or list all roles
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_roles_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
short_description: Create, update, and delete roles.
description:
- This module allows you to create, update, and delete roles.
- This module uses PC v4 APIs based SDKs
version_added: "2.0.0"
options:
state:
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_route_tables_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
module: ntnx_route_tables_info_v2
short_description: Route tables info module
version_added: 2.0.0
description: This module fetches route tables information
description:
- This module fetches route tables information
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_routes_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
module: ntnx_routes_info_v2
short_description: Routes info module
version_added: 2.0.0
description: This module fetches routes information
description:
- This module fetches routes information
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_routes_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@
module: ntnx_routes_v2
short_description: Module to create, update, and delete routes in route table in VPC
version_added: 2.0.0
description: "Create, Update, Delete routes in route table in VPC"
description:
- Create, Update, Delete routes in route table in VPC
- This module uses PC v4 APIs based SDKs
options:
state:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_saml_identity_providers_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- Fetch a single or list of multiple identity providers
- if external id is provided, it will return the identity provider info
- if external id is not provided, it will return multiple identity providers
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_saml_identity_providers_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
module: ntnx_saml_identity_providers_v2
short_description: Manage SAML identity providers in Nutanix PC
version_added: "2.0.0"
description: "Create, Update, Delete SAML identity providers in Nutanix PC"
description:
- Create, Update, Delete SAML identity providers in Nutanix PC
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/ntnx_security_rules_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
description:
- Fetch list of multiple network security policies info.
- Fetch specific network security policy info by ext_id.
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_security_rules_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
description:
- This module allows you to create, update, and delete network security policies in Nutanix Prism Central.
- During update, the rules provided under C(rules) will replace existing rules.
- This module uses PC v4 APIs based SDKs
options:
wait:
description:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_service_groups_info_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
description:
- This module is used to get service groups info.
- It can be used to get all service groups or a particular service group using ext_id.
- This module uses PC v4 APIs based SDKs
options:
ext_id:
description:
Expand Down
Loading

0 comments on commit 23496fe

Please sign in to comment.