Skip to content

Commit e31dd3c

Browse files
author
nina.loser
committed
linter, element vm_names ist documented!?
1 parent 0ea091b commit e31dd3c

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

plugins/modules/vmware_vm_info.py

+12-13
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
from __future__ import absolute_import, division, print_function
1111
__metaclass__ = type
1212

13-
import re
14-
1513
DOCUMENTATION = r'''
1614
---
1715
module: vmware_vm_info
@@ -40,7 +38,7 @@
4038
folder:
4139
description:
4240
- Specify a folder location of VMs to gather information from.
43-
- Can't be used if V(cluster) is set.
41+
- Can't be used if O(cluster) is set.
4442
- 'Examples:'
4543
- ' folder: /ha-datacenter/vm'
4644
- ' folder: ha-datacenter/vm'
@@ -52,18 +50,18 @@
5250
- ' folder: folder1/datacenter1/vm'
5351
- ' folder: /folder1/datacenter1/vm/folder2'
5452
type: str
55-
vm_name:
56-
description:
57-
- Name of the virtual machine to get related configurations information from.
58-
- Or if V(regex) is True, it will be used as an Filter for the Names of the virtual machines.
59-
- Can´t be used if V(cluster) or V(vm_names) is set.
60-
type: str
6153
vm_names:
6254
description:
6355
- List of the names of the virtual machines to get related configurations information from.
64-
- Can´t be used if V(regex) is set.
56+
- Can´t be used if O(regex) is set.
6557
type: list
6658
element: str
59+
vm_name:
60+
description:
61+
- Name of the virtual machine to get related configurations information from.
62+
- Or if O(regex) is True, it will be used as an Filter for the Names of the virtual machines.
63+
- Can´t be used if O(cluster) or O(vm_names) is set.
64+
type: str
6765
show_cluster:
6866
description:
6967
- Tags virtual machine's cluster is shown if set to V(true).
@@ -129,10 +127,10 @@
129127
type: bool
130128
regex:
131129
description:
132-
- If V(vm_name) is used as an Regex Filter.
133-
- For Metacharacters use in the V(vm_name) show Python RegEx
130+
- If O(vm_name) is used as an Regex Filter.
131+
- For Metacharacters use in the O(vm_name) show Python RegEx
134132
type: bool
135-
default: False
133+
default: false
136134
cluster:
137135
description:
138136
- Name of the cluster to gather information from VMs of this cluster.
@@ -331,6 +329,7 @@
331329
from ansible_collections.community.vmware.plugins.module_utils.vmware import PyVmomi, \
332330
get_all_objs, vmware_argument_spec, _get_vm_prop, get_parent_datacenter, find_vm_by_name, find_cluster_by_name
333331
from ansible_collections.community.vmware.plugins.module_utils.vmware_rest_client import VmwareRestClient
332+
import re
334333

335334

336335
class VmwareVmInfo(PyVmomi):

0 commit comments

Comments
 (0)