diff --git a/plugins/modules/ntnx_acps.py b/plugins/modules/ntnx_acps.py index 04f1f1f5..afd57b89 100644 --- a/plugins/modules/ntnx_acps.py +++ b/plugins/modules/ntnx_acps.py @@ -19,7 +19,9 @@ required: False type: str acp_uuid: - description: acp UUID + description: + - acp UUID + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str desc: description: The description of the association of a role to a user in a given context diff --git a/plugins/modules/ntnx_address_groups.py b/plugins/modules/ntnx_address_groups.py index 55b950c7..eee2ddc5 100644 --- a/plugins/modules/ntnx_address_groups.py +++ b/plugins/modules/ntnx_address_groups.py @@ -29,6 +29,7 @@ address_group_uuid: description: - uuid of the address group + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) - only required while updating or deleting required: false type: str diff --git a/plugins/modules/ntnx_floating_ips.py b/plugins/modules/ntnx_floating_ips.py index 826083bb..3986b73e 100644 --- a/plugins/modules/ntnx_floating_ips.py +++ b/plugins/modules/ntnx_floating_ips.py @@ -15,7 +15,9 @@ description: 'Create, Update, Delete floating_ips' options: fip_uuid: - description: floating_ip UUID + description: + - floating_ip UUID + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str external_subnet: description: A subnet with external connectivity diff --git a/plugins/modules/ntnx_image_placement_policy.py b/plugins/modules/ntnx_image_placement_policy.py index 087e7ea5..471d3c2e 100644 --- a/plugins/modules/ntnx_image_placement_policy.py +++ b/plugins/modules/ntnx_image_placement_policy.py @@ -20,9 +20,7 @@ - If C(state) is set to C(present) then the operation will be create the item. - if C(state) is set to C(present) and C(policy_uuid) is given then it will update that image placement policy. - if C(state) is set to C(present) then C(image_uuid) or one of C(name), C(image_categories), C(cluster_categories) needs to be set. - - >- - If C(state) is set to C(absent) and if the item exists, then - item is removed. + - If C(state) is set to C(absent) and if the item exists, then item is removed. choices: - present - absent @@ -41,8 +39,9 @@ type: str policy_uuid: description: - - image placement policy of existig uuid + - image placement policy of existing uuid - required only when updating or deleting + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str required: false desc: diff --git a/plugins/modules/ntnx_images.py b/plugins/modules/ntnx_images.py index 8733b9df..de98f2f6 100644 --- a/plugins/modules/ntnx_images.py +++ b/plugins/modules/ntnx_images.py @@ -21,9 +21,7 @@ - if C(state) is set to C(present) and C(image_uuid) is given then it will update that image. - if C(state) is set to C(present) then C(image_uuid), C(source_uri) and C(source_path) are mutually exclusive. - if C(state) is set to C(present) then C(image_uuid) or C(name) needs to be set. - - >- - If C(state) is set to C(absent) and if the item exists, then - item is removed. + - If C(state) is set to C(absent) and if the item exists, then item is removed. choices: - present - absent @@ -39,7 +37,9 @@ required: false type: str image_uuid: - description: Image uuid + description: + - Image uuid + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str required: false desc: diff --git a/plugins/modules/ntnx_ndb_clusters.py b/plugins/modules/ntnx_ndb_clusters.py index aa8b5565..24a3b6a4 100644 --- a/plugins/modules/ntnx_ndb_clusters.py +++ b/plugins/modules/ntnx_ndb_clusters.py @@ -21,7 +21,9 @@ - Update allowed. uuid: type: str - description: UUID of the cluster. + description: + - UUID of the cluster. + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) desc: type: str description: diff --git a/plugins/modules/ntnx_ndb_database_clones.py b/plugins/modules/ntnx_ndb_database_clones.py index d8ada705..18189411 100644 --- a/plugins/modules/ntnx_ndb_database_clones.py +++ b/plugins/modules/ntnx_ndb_database_clones.py @@ -16,6 +16,7 @@ uuid: description: - uuid of database clone for update and delete + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str name: description: diff --git a/plugins/modules/ntnx_ndb_database_snapshots.py b/plugins/modules/ntnx_ndb_database_snapshots.py index b4720f67..751ae1f8 100644 --- a/plugins/modules/ntnx_ndb_database_snapshots.py +++ b/plugins/modules/ntnx_ndb_database_snapshots.py @@ -21,6 +21,7 @@ snapshot_uuid: description: - snapshot uuid for delete or update + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str name: description: diff --git a/plugins/modules/ntnx_ndb_databases.py b/plugins/modules/ntnx_ndb_databases.py index 6a7d76cd..1c856016 100644 --- a/plugins/modules/ntnx_ndb_databases.py +++ b/plugins/modules/ntnx_ndb_databases.py @@ -20,6 +20,7 @@ db_uuid: description: - uuid for update or delete of database instance + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str name: description: diff --git a/plugins/modules/ntnx_ndb_db_server_vms.py b/plugins/modules/ntnx_ndb_db_server_vms.py index d8a57c32..adaf1470 100644 --- a/plugins/modules/ntnx_ndb_db_server_vms.py +++ b/plugins/modules/ntnx_ndb_db_server_vms.py @@ -27,6 +27,7 @@ uuid: description: - uuid of database server vm for updating or deleting vm + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str desc: description: diff --git a/plugins/modules/ntnx_ndb_maintenance_window.py b/plugins/modules/ntnx_ndb_maintenance_window.py index f90e8fb9..b8981627 100644 --- a/plugins/modules/ntnx_ndb_maintenance_window.py +++ b/plugins/modules/ntnx_ndb_maintenance_window.py @@ -20,7 +20,7 @@ uuid: description: - uuid of maintenance window - - should be used for update or delete + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str desc: description: diff --git a/plugins/modules/ntnx_ndb_profiles.py b/plugins/modules/ntnx_ndb_profiles.py index 3c342679..a617e043 100644 --- a/plugins/modules/ntnx_ndb_profiles.py +++ b/plugins/modules/ntnx_ndb_profiles.py @@ -17,11 +17,12 @@ - currently, compute, network, database parameters and software profiles are supported - only software profile supports versions operations - version related operations can be configured under "software" - - only software profile supports multi cluster availibility + - only software profile supports multi cluster availability options: profile_uuid: description: - uuid of profile for delete or update + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str name: description: diff --git a/plugins/modules/ntnx_ndb_slas.py b/plugins/modules/ntnx_ndb_slas.py index eb04fa92..d858bcc6 100644 --- a/plugins/modules/ntnx_ndb_slas.py +++ b/plugins/modules/ntnx_ndb_slas.py @@ -25,6 +25,7 @@ sla_uuid: description: - sla uuid + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str frequency: description: diff --git a/plugins/modules/ntnx_ndb_stretched_vlans.py b/plugins/modules/ntnx_ndb_stretched_vlans.py index bebead6d..a413a6df 100644 --- a/plugins/modules/ntnx_ndb_stretched_vlans.py +++ b/plugins/modules/ntnx_ndb_stretched_vlans.py @@ -17,6 +17,7 @@ stretched_vlan_uuid: description: - uuid for update or delete of stretched vlan + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str vlans: description: diff --git a/plugins/modules/ntnx_ndb_tags.py b/plugins/modules/ntnx_ndb_tags.py index 4c473805..bf145c4c 100644 --- a/plugins/modules/ntnx_ndb_tags.py +++ b/plugins/modules/ntnx_ndb_tags.py @@ -22,6 +22,7 @@ uuid: description: - uuid of tag for update and delete + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str desc: description: diff --git a/plugins/modules/ntnx_ndb_vlans.py b/plugins/modules/ntnx_ndb_vlans.py index bd978ce5..c77f65d4 100644 --- a/plugins/modules/ntnx_ndb_vlans.py +++ b/plugins/modules/ntnx_ndb_vlans.py @@ -19,6 +19,7 @@ vlan_uuid: description: - uuid for update or delete of vlan + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str name: description: diff --git a/plugins/modules/ntnx_projects.py b/plugins/modules/ntnx_projects.py index 67afb5d8..935917f8 100644 --- a/plugins/modules/ntnx_projects.py +++ b/plugins/modules/ntnx_projects.py @@ -27,8 +27,7 @@ project_uuid: description: - This field can be used for update and delete of project - - if C(project_uuid) and C(state)==present will update the project - - if C(project_uuid) and C(state)==absent will delete the project + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str required: false desc: diff --git a/plugins/modules/ntnx_protection_rules.py b/plugins/modules/ntnx_protection_rules.py index a27b7d6c..01c8b9af 100644 --- a/plugins/modules/ntnx_protection_rules.py +++ b/plugins/modules/ntnx_protection_rules.py @@ -17,6 +17,7 @@ description: - protection_rule uuid - required for update and delete + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str required: false start_time: diff --git a/plugins/modules/ntnx_recovery_plans.py b/plugins/modules/ntnx_recovery_plans.py index 777ce9f2..fc39156f 100644 --- a/plugins/modules/ntnx_recovery_plans.py +++ b/plugins/modules/ntnx_recovery_plans.py @@ -14,7 +14,9 @@ description: 'Create, Update, Delete Recovery Plan' options: plan_uuid: - description: recovery_plan uuid + description: + - recovery_plan uuid + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str required: false name: diff --git a/plugins/modules/ntnx_roles.py b/plugins/modules/ntnx_roles.py index 55d6a255..72315cae 100644 --- a/plugins/modules/ntnx_roles.py +++ b/plugins/modules/ntnx_roles.py @@ -30,6 +30,7 @@ description: - uuid of the role - only required while updating or deleting + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) required: false type: str desc: diff --git a/plugins/modules/ntnx_security_rules.py b/plugins/modules/ntnx_security_rules.py index 16124e56..0dc35051 100644 --- a/plugins/modules/ntnx_security_rules.py +++ b/plugins/modules/ntnx_security_rules.py @@ -62,7 +62,9 @@ required: false type: str security_rule_uuid: - description: security_rule UUID + description: + - security_rule UUID + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str allow_ipv6_traffic: description: Allow traffic from ipv6 diff --git a/plugins/modules/ntnx_service_groups.py b/plugins/modules/ntnx_service_groups.py index 14d01d45..8882494d 100644 --- a/plugins/modules/ntnx_service_groups.py +++ b/plugins/modules/ntnx_service_groups.py @@ -18,9 +18,7 @@ description: - Specify state of service_groups - If C(state) is set to C(present) then service_groups is created. - - >- - If C(state) is set to C(absent) and if the service_groups exists, then - service_groups is removed. + - If C(state) is set to C(absent) and if the service_groups exists, then service_groups is removed. choices: - present - absent @@ -36,7 +34,9 @@ required: False type: str service_group_uuid: - description: service_group UUID + description: + - service_group UUID + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str desc: description: service_groups description diff --git a/plugins/modules/ntnx_user_groups.py b/plugins/modules/ntnx_user_groups.py index a86f8d1d..641f4a2d 100644 --- a/plugins/modules/ntnx_user_groups.py +++ b/plugins/modules/ntnx_user_groups.py @@ -18,10 +18,7 @@ description: - Specify state - If C(state) is set to C(present) then the operation will be create the item. - - if C(state) is set to C(present) and C(user_group_uuid) is given then it will update that user_group. - - >- - If C(state) is set to C(absent) and if the item exists, then - item is removed. + - If C(state) is set to C(absent) and if the item exists, then item is removed. choices: - present - absent diff --git a/plugins/modules/ntnx_users.py b/plugins/modules/ntnx_users.py index 2c06d8ef..90708d62 100644 --- a/plugins/modules/ntnx_users.py +++ b/plugins/modules/ntnx_users.py @@ -18,10 +18,7 @@ description: - Specify state - If C(state) is set to C(present) then the operation will be create the item. - - if C(state) is set to C(present) and C(user_uuid) is given then it will update that user. - - >- - If C(state) is set to C(absent) and if the item exists, then - item is removed. + - If C(state) is set to C(absent) and if the item exists, then item is removed. choices: - present - absent diff --git a/plugins/modules/ntnx_vms.py b/plugins/modules/ntnx_vms.py index 7d1d329d..11ad3fa7 100644 --- a/plugins/modules/ntnx_vms.py +++ b/plugins/modules/ntnx_vms.py @@ -44,7 +44,9 @@ required: false type: str vm_uuid: - description: VM UUID + description: + - VM UUID + - will be used to update if C(state) is C(present) and to delete if C(state) is C(absent) type: str remove_categories: description: