mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
VMware: correct documentation for datacenter (#38718)
This fixes documentation related to datacenter in vmware_guest_find module. Fixes: #38290 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
parent
bed5f7317d
commit
2367130ba3
1 changed files with 17 additions and 17 deletions
|
@ -28,22 +28,21 @@ requirements:
|
|||
- PyVmomi
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name of the VM to work with.
|
||||
- This is required if uuid is not supplied.
|
||||
description:
|
||||
- Name of the VM to work with.
|
||||
- This is required if C(uuid) parameter is not supplied.
|
||||
uuid:
|
||||
description:
|
||||
- UUID of the instance to manage if known, this is VMware's BIOS UUID.
|
||||
- This is required if name is not supplied.
|
||||
description:
|
||||
- UUID of the instance to manage if known, this is VMware's BIOS UUID.
|
||||
- This is required if C(name) parameter is not supplied.
|
||||
datacenter:
|
||||
description:
|
||||
- Destination datacenter for the find operation.
|
||||
- Deprecated in 2.5, will be removed in 2.9 release.
|
||||
required: True
|
||||
description:
|
||||
- Destination datacenter for the find operation.
|
||||
- Deprecated in 2.5, will be removed in 2.9 release.
|
||||
extends_documentation_fragment: vmware.documentation
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r'''
|
||||
- name: Find Guest's Folder using name
|
||||
vmware_guest_find:
|
||||
hostname: 192.168.1.209
|
||||
|
@ -68,6 +67,9 @@ folders:
|
|||
description: List of folders for user specified virtual machine
|
||||
returned: on success
|
||||
type: list
|
||||
sample: [
|
||||
'/DC0/vm',
|
||||
]
|
||||
"""
|
||||
|
||||
|
||||
|
@ -75,9 +77,7 @@ from ansible.module_utils.basic import AnsibleModule
|
|||
from ansible.module_utils._text import to_native
|
||||
from ansible.module_utils.vmware import PyVmomi, get_all_objs, vmware_argument_spec
|
||||
|
||||
|
||||
try:
|
||||
import pyVmomi
|
||||
from pyVmomi import vim
|
||||
except ImportError:
|
||||
pass
|
||||
|
@ -86,8 +86,6 @@ except ImportError:
|
|||
class PyVmomiHelper(PyVmomi):
|
||||
def __init__(self, module):
|
||||
super(PyVmomiHelper, self).__init__(module)
|
||||
self.datacenter = None
|
||||
self.folders = None
|
||||
self.name = self.params['name']
|
||||
self.uuid = self.params['uuid']
|
||||
|
||||
|
@ -112,11 +110,13 @@ def main():
|
|||
argument_spec.update(
|
||||
name=dict(type='str'),
|
||||
uuid=dict(type='str'),
|
||||
datacenter=dict(removed_in_version=2.9, type='str', required=True)
|
||||
datacenter=dict(removed_in_version=2.9, type='str')
|
||||
)
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec,
|
||||
required_one_of=[['name', 'uuid']])
|
||||
required_one_of=[['name', 'uuid']],
|
||||
mutually_exclusive=[['name', 'uuid']],
|
||||
)
|
||||
|
||||
pyv = PyVmomiHelper(module)
|
||||
# Check if the VM exists before continuing
|
||||
|
|
Loading…
Reference in a new issue