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.

Sign up for GitHub

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 improvements #21

Merged
merged 3 commits into from
May 21, 2024
Merged

Doc improvements #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
974a552
Doc improvements
Andersson007 May 21, 2024
3fbbde8
add fragment
Andersson007 May 21, 2024
725d16b
Fix
Andersson007 May 21, 2024
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
2 changes: 2 additions & 0 deletions changelogs/fragments/21-doc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
trivial:
- modules documentation - add check_mode support attribute
6 changes: 5 additions & 1 deletion plugins/modules/appliance_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@
type: list
elements: str
default: all
attributes:
check_mode:
description: The check_mode support.
support: full
extends_documentation_fragment:
- vmware.vmware.vmware_rest_client.documentation

Expand Down Expand Up @@ -309,7 +313,7 @@ def main():
)
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True
supports_check_mode=True,
)

vmware_appliance_mgr = VmwareApplianceInfo(module)
Expand Down
4 changes: 4 additions & 0 deletions plugins/modules/guest_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@
description:
- The name of the guest virtual machine to obtain info from.
type: str
attributes:
check_mode:
description: The check_mode support.
support: full
extends_documentation_fragment:
- vmware.vmware.vmware_rest_client.documentation

Expand Down
6 changes: 5 additions & 1 deletion plugins/modules/license_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
- Fetch vCenter, ESXi server license keys.
author:
- Ansible Cloud Team (@ansible-collections)
attributes:
check_mode:
description: The check_mode support.
support: full
extends_documentation_fragment:
- vmware.vmware.vmware.vcenter_documentation
'''
Expand All @@ -29,7 +33,7 @@

RETURN = r'''
licenses:
description: list of license keys
description: List of license keys.
returned: always
type: list
sample:
Expand Down
8 changes: 6 additions & 2 deletions plugins/modules/vm_list_group_by_clusters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@
description:
- If I(true) gather detailed information about virtual machines.
type: bool
attributes:
check_mode:
description: The check_mode support.
support: full
extends_documentation_fragment:
- vmware.vmware.vmware_rest_client.documentation

Expand All @@ -40,7 +44,7 @@
RETURN = r'''
vm_list_group_by_clusters:
description:
- Dictionary of vm list by folders and clusters
- Dictionary of vm list by folders and clusters.
returned: On success
type: dict
sample: {
Expand Down Expand Up @@ -182,7 +186,7 @@ def main():
)
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True
supports_check_mode=True,
)

vmware_vm_list_group_by_clusters_mgr = VmwareVMList(module)
Expand Down
Loading