Skip to content

Commit

Permalink
punctuation and grammar fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mikemorency committed Aug 6, 2024
1 parent 445bb35 commit 98c0d0c
Show file tree
Hide file tree
Showing 9 changed files with 30 additions and 30 deletions.
12 changes: 6 additions & 6 deletions plugins/doc_fragments/moid.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ class ModuleDocFragment(object):
options:
_terms:
description:
- The absolute folder path to the object you would like to lookup
- Folder paths always start with the datacenter name, and then the object type (host, vm, network, datastore)
- The absolute folder path to the object you would like to lookup.
- Folder paths always start with the datacenter name, and then the object type (host, vm, network, datastore).
- >-
If the object is in a sub folder, the sub folder path should be added after the object type
(for example /my_dc/vm/some/sub_folder/vm_name_to_lookup)
- Enter the object or folder names as seen in the VCenter GUI. Do not escape spaces or special characters
(for example /my_dc/vm/some/sub_folder/vm_name_to_lookup).
- Enter the object or folder names as seen in the VCenter GUI. Do not escape spaces or special characters.
required: True
type: string
vcenter_hostname:
Expand Down Expand Up @@ -68,8 +68,8 @@ class ModuleDocFragment(object):
type: boolean
object_type:
description:
- Should not be set by the user, it is set internally when using a specific lookup plugin
- Describes the type of object to lookup. Example, cluster, datacenter, datastore, etc
- Should not be set by the user, it is set internally when using a specific lookup plugin.
- Describes the type of object to lookup. Example, cluster, datacenter, datastore, etc.
default: 'cluster'
type: str
required: False
Expand Down
6 changes: 3 additions & 3 deletions plugins/lookup/cluster_moid.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
vcenter_password: "1234"
tasks:
# Add more tasks or lookups as needed, referencing the same connection_args variable
- name: lookup MoID of the object
- name: Lookup MoID of the object
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster', **connection_args) }}"
Expand All @@ -78,11 +78,11 @@
# Usage in Playbooks
#
#
# The lookup plugin can be used to simplify your playbook. Heres an example of how you might use it.
# The lookup plugin can be used to simplify your playbook. Here is an example of how you might use it.
#
# Without the lookup, this takes two modules which both run on the remote host. This can slow down execution
# and adds extra steps to the playbook:
- name: Retrieve details about a cluster named my_cluster
- name: Retrieve details about a cluster named 'my_cluster'
vmware.vmware_rest.vcenter_cluster_info:
names:
- my_cluster
Expand Down
6 changes: 3 additions & 3 deletions plugins/lookup/datacenter_moid.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
vcenter_password: "1234"
tasks:
# Add more tasks or lookups as needed, referencing the same connection_args variable
- name: lookup MoID of the object
- name: Lookup MoID of the object
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.datacenter_moid', '/my_dc', **connection_args) }}"
Expand All @@ -77,11 +77,11 @@
# Usage in Playbooks
#
#
# The lookup plugin can be used to simplify your playbook. Heres an example of how you might use it.
# The lookup plugin can be used to simplify your playbook. Here is an example of how you might use it.
#
# Without the lookup, this takes two modules which both run on the remote host. This can slow down execution
# and adds extra steps to the playbook:
- name: Retrieve details about a datacenter named my_dc
- name: Retrieve details about a datacenter named 'my_dc'
vmware.vmware_rest.vcenter_datacenter_info:
names:
- my_dc
Expand Down
6 changes: 3 additions & 3 deletions plugins/lookup/datastore_moid.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
vcenter_password: "1234"
tasks:
# Add more tasks or lookups as needed, referencing the same connection_args variable
- name: lookup MoID of the object
- name: Lookup MoID of the object
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/my_datastore', **connection_args) }}"
Expand Down Expand Up @@ -86,11 +86,11 @@
# Usage in Playbooks
#
#
# The lookup plugin can be used to simplify your playbook. Heres an example of how you might use it.
# The lookup plugin can be used to simplify your playbook. Here is an example of how you might use it.
#
# Without the lookup, this takes two modules which both run on the remote host. This can slow down execution
# and adds extra steps to the playbook:
- name: Retrieve details about a datastore named my_datastore
- name: Retrieve details about a datastore named 'my_datastore'
vmware.vmware_rest.vcenter_cluster_info:
names:
- my_datastore
Expand Down
6 changes: 3 additions & 3 deletions plugins/lookup/folder_moid.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
vcenter_password: "1234"
tasks:
# Add more tasks or lookups as needed, referencing the same connection_args variable
- name: lookup MoID of the object
- name: Lookup MoID of the object
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/path/to/my_folder', **connection_args) }}"
Expand All @@ -81,11 +81,11 @@
# Usage in Playbooks
#
#
# The lookup plugin can be used to simplify your playbook. Heres an example of how you might use it.
# The lookup plugin can be used to simplify your playbook. Here is an example of how you might use it.
#
# Without the lookup, this takes two modules which both run on the remote host. This can slow down execution
# and adds extra steps to the playbook:
- name: Retrieve details about a folder named my_folder
- name: Retrieve details about a folder named 'my_folder'
vmware.vmware_rest.vcenter_cluster_info:
names:
- my_folder
Expand Down
6 changes: 3 additions & 3 deletions plugins/lookup/host_moid.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
vcenter_password: "1234"
tasks:
# Add more tasks or lookups as needed, referencing the same connection_args variable
- name: lookup MoID of the object
- name: Lookup MoID of the object
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.host_moid', '/my_dc/host/my_cluster/my_host', **connection_args) }}"
Expand Down Expand Up @@ -90,11 +90,11 @@
# Usage in Playbooks
#
#
# The lookup plugin can be used to simplify your playbook. Heres an example of how you might use it.
# The lookup plugin can be used to simplify your playbook. Here is an example of how you might use it.
#
# Without the lookup, this takes two modules which both run on the remote host. This can slow down execution
# and adds extra steps to the playbook:
- name: Retrieve details about an ESXI host named my_host
- name: Retrieve details about an ESXI host named 'my_host'
vmware.vmware_rest.vcenter_host_info:
names:
- my_host
Expand Down
6 changes: 3 additions & 3 deletions plugins/lookup/network_moid.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
vcenter_password: "1234"
tasks:
# Add more tasks or lookups as needed, referencing the same connection_args variable
- name: lookup MoID of the object
- name: Lookup MoID of the object
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/my_network', **connection_args) }}"
Expand Down Expand Up @@ -88,11 +88,11 @@
# Usage in Playbooks
#
#
# The lookup plugin can be used to simplify your playbook. Heres an example of how you might use it.
# The lookup plugin can be used to simplify your playbook. Here is an example of how you might use it.
#
# Without the lookup, this takes two modules which both run on the remote host. This can slow down execution
# and adds extra steps to the playbook:
- name: Retrieve details about the network named my_network
- name: Retrieve details about the network named 'my_network'
vmware.vmware_rest.vcenter_network_info:
names:
- my_network
Expand Down
6 changes: 3 additions & 3 deletions plugins/lookup/resource_pool_moid.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
vcenter_password: "1234"
tasks:
# Add more tasks or lookups as needed, referencing the same connection_args variable
- name: lookup MoID of the object
- name: Lookup MoID of the object
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources/my_pool', **connection_args) }}"
Expand All @@ -79,11 +79,11 @@
# Usage in Playbooks
#
#
# The lookup plugin can be used to simplify your playbook. Heres an example of how you might use it.
# The lookup plugin can be used to simplify your playbook. Here is an example of how you might use it.
#
# Without the lookup, this takes two modules which both run on the remote host. This can slow down execution
# and adds extra steps to the playbook:
- name: Retrieve details about a resource pool named my_pool
- name: Retrieve details about a resource pool named 'my_pool'
vmware.vmware_rest.vcenter_resource_pool_info:
names:
- my_pool
Expand Down
6 changes: 3 additions & 3 deletions plugins/lookup/vm_moid.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
vcenter_password: "1234"
tasks:
# Add more tasks or lookups as needed, referencing the same connection_args variable
- name: lookup MoID of the object
- name: Lookup MoID of the object
ansible.builtin.debug:
msg: "{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/vm/my_cluster/my_vm', **connection_args) }}"
Expand Down Expand Up @@ -84,11 +84,11 @@
# Usage in Playbooks
#
#
# The lookup plugin can be used to simplify your playbook. Heres an example of how you might use it.
# The lookup plugin can be used to simplify your playbook. Here is an example of how you might use it.
#
# Without the lookup, this takes two modules which both run on the remote host. This can slow down execution
# and adds extra steps to the playbook:
- name: Look up the VM called my_vm in the inventory
- name: Look up the VM called 'my_vm' in the inventory
vmware.vmware_rest.vcenter_vm_info:
filter_names:
- my_vm
Expand Down

0 comments on commit 98c0d0c

Please sign in to comment.