Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc's fix for uuid description #437

Merged
merged 1 commit into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_acps.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_address_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_floating_ips.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 3 additions & 4 deletions plugins/modules/ntnx_image_placement_policy.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions plugins/modules/ntnx_images.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_ndb_clusters.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_ndb_database_clones.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_ndb_database_snapshots.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_ndb_databases.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_ndb_db_server_vms.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/ntnx_ndb_maintenance_window.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 2 additions & 1 deletion plugins/modules/ntnx_ndb_profiles.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_ndb_slas.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_ndb_stretched_vlans.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_ndb_tags.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_ndb_vlans.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 1 addition & 2 deletions plugins/modules/ntnx_projects.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_protection_rules.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_recovery_plans.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/ntnx_roles.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_security_rules.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions plugins/modules/ntnx_service_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
5 changes: 1 addition & 4 deletions plugins/modules/ntnx_user_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 1 addition & 4 deletions plugins/modules/ntnx_users.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion plugins/modules/ntnx_vms.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading