Skip to content

Commit

Permalink
Issue 1660 part 4
Browse files Browse the repository at this point in the history
  • Loading branch information
mariolenz committed Mar 10, 2023
1 parent a49559d commit 2cf2bfc
Show file tree
Hide file tree
Showing 23 changed files with 91 additions and 91 deletions.
8 changes: 4 additions & 4 deletions plugins/doc_fragments/vmware.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ class ModuleDocFragment(object):
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_HOST) will be used instead.
- This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
type: str
required: False
required: false
proxy_port:
description:
- Port of the HTTP proxy that will receive all HTTPS requests and relay them.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_PORT) will be used instead.
type: int
required: False
required: false
'''

# This doc fragment is specific to vcenter modules like vcenter_license
Expand Down Expand Up @@ -113,11 +113,11 @@ class ModuleDocFragment(object):
- The format is a hostname or a IP.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_HOST) will be used instead.
type: str
required: False
required: false
proxy_port:
description:
- Port of the HTTP proxy that will receive all HTTPS requests and relay them.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_PORT) will be used instead.
type: int
required: False
required: false
'''
4 changes: 2 additions & 2 deletions plugins/doc_fragments/vmware_rest_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ class ModuleDocFragment(object):
- The format is a hostname or a IP.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_HOST) will be used instead.
type: str
required: False
required: false
proxy_port:
description:
- Port of the HTTP proxy that will receive all HTTPS requests and relay them.
- If the value is not specified in the task, the value of environment variable C(VMWARE_PROXY_PORT) will be used instead.
type: int
required: False
required: false
'''
8 changes: 4 additions & 4 deletions plugins/modules/vcenter_domain_user_group_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
- The I(search_string) is a string to be specified searching.
- Specify the domain user or group name to be searched.
type: str
required: True
required: true
belongs_to_group:
description:
- If a group existing, returned contains only users or groups that directly belong to the specified group.
Expand All @@ -39,17 +39,17 @@
description:
- If I(exact_match) is C(True), it indicates the I(search_string) passed should match a user or group name exactly.
type: bool
default: False
default: false
find_users:
description:
- If I(find_users) is C(True), domain users will be included in the result.
type: bool
default: True
default: true
find_groups:
description:
- If I(find_groups) is C(True), domain groups will be included in the result.
type: bool
default: True
default: true
extends_documentation_fragment:
- community.vmware.vmware.documentation
'''
Expand Down
6 changes: 3 additions & 3 deletions plugins/modules/vcenter_extension.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@
extension_key:
description:
- The extension key of the extension to install or uninstall.
required: True
required: true
type: str
version:
description:
- The version of the extension you are installing or uninstalling.
required: True
required: true
type: str
name:
description:
Expand Down Expand Up @@ -65,7 +65,7 @@
visible:
description:
- Show the extension in solution manager inside vCenter.
default: True
default: true
type: bool
state:
description:
Expand Down
8 changes: 4 additions & 4 deletions plugins/modules/vcenter_folder.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,23 @@
datacenter:
description:
- Name of the datacenter.
required: True
required: true
aliases: ['datacenter_name']
type: str
folder_name:
description:
- Name of folder to be managed.
- This is case sensitive parameter.
- Folder name should be under 80 characters. This is a VMware restriction.
required: True
required: true
type: str
parent_folder:
description:
- Name of the parent folder under which new folder needs to be created.
- This is case sensitive parameter.
- "If user wants to create a folder under '/DC0/vm/vm_folder', this value will be 'vm_folder'."
- "If user wants to create a folder under '/DC0/vm/folder1/folder2', this value will be 'folder1/folder2'."
required: False
required: false
type: str
folder_type:
description:
Expand All @@ -53,7 +53,7 @@
- This option is ignored, if C(parent_folder) is set.
default: vm
type: str
required: False
required: false
choices: [ datastore, host, network, vm ]
state:
description:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/vcenter_standard_key_provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
name:
description: Name of the Key Provider to be added, reconfigured or removed from vCenter.
type: str
required: True
required: true
mark_default:
description:
- Set specified Key Provider with name C(name) as the default Key Provider.
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/vmware_category.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
category_name:
description:
- The name of category to manage.
required: True
required: true
type: str
category_description:
description:
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_cfg_backup.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
esxi_hostname:
description:
- Name of ESXi server. This is required only if authentication against a vCenter is done.
required: False
required: false
type: str
dest:
description:
Expand All @@ -44,7 +44,7 @@
- If C(loaded), the backup file in I(src) will be loaded to the ESXi host rewriting the hosts settings.
choices: [saved, absent, loaded]
type: str
required: True
required: true
extends_documentation_fragment:
- community.vmware.vmware.documentation
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/vmware_cluster_drs.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
- Whether DRS Behavior overrides for individual virtual machines are enabled.
- If set to C(True), overrides C(drs_default_vm_behavior).
type: bool
default: True
default: true
drs_default_vm_behavior:
description:
- Specifies the cluster-wide default DRS behavior for virtual machines.
Expand Down Expand Up @@ -72,7 +72,7 @@
- In addition to real-time metrics, DRS will respond to forecasted metrics provided by vRealize Operations Manager.
- You must also configure Predictive DRS in a version of vRealize Operations that supports this feature.
type: bool
default: False
default: false
extends_documentation_fragment:
- community.vmware.vmware.documentation
'''
Expand Down
6 changes: 3 additions & 3 deletions plugins/modules/vmware_cluster_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,19 @@
description:
- Datacenter to search for cluster/s.
- This parameter is required, if C(cluster_name) is not supplied.
required: False
required: false
type: str
cluster_name:
description:
- Name of the cluster.
- If set, information of this cluster will be returned.
- This parameter is required, if C(datacenter) is not supplied.
required: False
required: false
type: str
show_tag:
description:
- Tags related to cluster are shown if set to C(True).
default: False
default: false
type: bool
schema:
description:
Expand Down
20 changes: 10 additions & 10 deletions plugins/modules/vmware_content_deploy_ovf_template.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,43 +25,43 @@
description:
- The level of logging desired in this module.
type: str
required: False
required: false
default: 'normal'
choices: [ 'debug', 'info', 'normal' ]
template:
description:
- The name of OVF template from which VM to be deployed.
type: str
required: True
required: true
aliases: ['ovf', 'ovf_template', 'template_src']
library:
description:
- The name of the content library from where the template resides.
type: str
required: False
required: false
aliases: ['content_library', 'content_library_src']
name:
description:
- The name of the VM to be deployed.
type: str
required: True
required: true
aliases: ['vm_name']
datacenter:
description:
- Name of the datacenter, where VM to be deployed.
type: str
required: True
required: true
datastore:
description:
- Name of the datastore to store deployed VM and disk.
type: str
required: False
required: false
datastore_cluster:
description:
- Name of the datastore cluster housing a datastore to store deployed VM and disk.
- If datastore is not specified, the recommended datastore from this cluster will be used.
type: str
required: False
required: false
folder:
description:
- Name of the folder in datacenter in which to place deployed VM.
Expand All @@ -71,17 +71,17 @@
description:
- Name of the ESX Host in datacenter in which to place deployed VM. The host has to be a member of the cluster that contains the resource pool.
type: str
required: False
required: false
resource_pool:
description:
- Name of the resourcepool in datacenter in which to place deployed VM.
type: str
required: False
required: false
cluster:
description:
- Name of the cluster in datacenter in which to place deployed VM.
type: str
required: False
required: false
storage_provisioning:
description:
- Default storage provisioning type to use for all sections of type vmw:StorageSection in the OVF descriptor.
Expand Down
34 changes: 17 additions & 17 deletions plugins/modules/vmware_content_deploy_template.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,46 +29,46 @@
description:
- The level of logging desired in this module.
type: str
required: False
required: false
default: 'normal'
choices: [ 'debug', 'info', 'normal' ]
template:
description:
- The name of template from which VM to be deployed.
type: str
required: True
required: true
aliases: ['template_src']
library:
description:
- The name of the content library from where the template resides.
type: str
required: False
required: false
aliases: ['content_library', 'content_library_src']
name:
description:
- The name of the VM to be deployed.
type: str
required: True
required: true
aliases: ['vm_name']
datacenter:
description:
- Name of the datacenter, where VM to be deployed.
type: str
required: True
required: true
datastore:
description:
- Name of the datastore to store deployed VM and disk.
- Required if I(datastore_cluster) is not provided.
type: str
required: False
required: false
datastore_cluster:
description:
- Name of the datastore cluster to store deployed VM and disk.
- Please make sure Storage DRS is active for recommended datastore from the given datastore cluster.
- If Storage DRS is not enabled, datastore with largest free storage space is selected.
- Required if I(datastore) is not provided.
type: str
required: False
description:
- Name of the datastore cluster to store deployed VM and disk.
- Please make sure Storage DRS is active for recommended datastore from the given datastore cluster.
- If Storage DRS is not enabled, datastore with largest free storage space is selected.
- Required if I(datastore) is not provided.
type: str
required: false
folder:
description:
- Name of the folder in datacenter in which to place deployed VM.
Expand All @@ -81,21 +81,21 @@
- Required with I(resource_pool) to find resource pool details. This will be used as additional
information when there are resource pools with same name.
type: str
required: False
required: false
resource_pool:
description:
- Name of the resource pool in datacenter in which to place deployed VM.
- Required if I(cluster) is not specified.
- For default or non-unique resource pool names, specify I(host) and I(cluster).
- C(Resources) is the default name of resource pool.
type: str
required: False
required: false
cluster:
description:
- Name of the cluster in datacenter in which to place deployed VM.
- Required if I(resource_pool) is not specified.
type: str
required: False
required: false
state:
description:
- The state of Virtual Machine deployed from template in content library.
Expand All @@ -104,7 +104,7 @@
- If set to C(poweredon) and VM does not exists, then VM is created with powered on state.
- If set to C(poweredon) and VM exists, no action is taken.
type: str
required: False
required: false
default: 'present'
choices: [ 'present', 'poweredon' ]
extends_documentation_fragment:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/vmware_content_library_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
description:
- content library id for which details needs to be fetched.
type: str
required: False
required: false
extends_documentation_fragment:
- community.vmware.vmware_rest_client.documentation
Expand Down
Loading

0 comments on commit 2cf2bfc

Please sign in to comment.