1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

vmware_vm_facts: Improve example and docs (#27898)

This fixes ansible/ansible-modules-extras#2475
This commit is contained in:
Dag Wieers 2017-08-09 15:41:30 +02:00 committed by jctanner
parent 9f26b853e8
commit 2af759e9f9

View file

@ -12,31 +12,41 @@ ANSIBLE_METADATA = {'metadata_version': '1.0',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = '''
DOCUMENTATION = r'''
---
module: vmware_vm_facts
short_description: Return basic facts pertaining to a vSphere virtual machine guest
description:
- Return basic facts pertaining to a vSphere virtual machine guest
version_added: 2.0
author: "Joseph Callen (@jcpowermac)"
- Return basic facts pertaining to a vSphere virtual machine guest.
version_added: '2.0'
author:
- Joseph Callen (@jcpowermac)
notes:
- Tested on vSphere 5.5
- Tested on vSphere 6.5
- Tested on vSphere 5.5 and vSphere 6.5
requirements:
- "python >= 2.6"
- python >= 2.6
- PyVmomi
extends_documentation_fragment: vmware.documentation
'''
EXAMPLES = '''
EXAMPLES = r'''
- name: Gather all registered virtual machines
local_action:
module: vmware_vm_facts
vmware_vm_facts:
hostname: esxi_or_vcenter_ip_or_hostname
username: username
password: password
delegate_to: localhost
register: vmfacts
- debug:
var: vmfacts.virtual_machines
'''
RETURN = r'''
virtual_machines:
description: dictionary of virtual machines and their facts
returned: success
type: dict
'''
try: