ovirt: minor typo fixes in documentation (#44345)

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

lib/ansible/modules/cloud/ovirt/ovirt_auth.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
@@ -154,9 +139,9 @@ EXAMPLES = '''
 #   OVIRT_URL = https://fqdn/ovirt-engine/api
 #   OVIRT_USERNAME = admin@internal
 #   OVIRT_PASSWORD = the_password
-# He can login the oVirt using environment variable instead of variables
+# User can login the oVirt using environment variable instead of variables
 # in yaml file.
-# This is mainly usefull when using Ansible Tower or AWX, as it will work
+# This is mainly useful when using Ansible Tower or AWX, as it will work
 # for Red Hat Virtualization creadentials type.
   - name: Obtain SSO token
     ovirt_auth:

lib/ansible/modules/cloud/ovirt/ovirt_cluster.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
@@ -39,7 +24,7 @@ options:
         required: true
     state:
         description:
-            - "Should the cluster be present or absent"
+            - "Should the cluster be present or absent."
         choices: ['present', 'absent']
         default: present
     data_center:
@@ -78,22 +63,22 @@ options:
                outweighs its CPU cost."
     ksm_numa:
         description:
-            - "If I(True) enables KSM C(ksm) for best berformance inside NUMA nodes."
+            - "If I(True) enables KSM C(ksm) for best performance inside NUMA nodes."
     ha_reservation:
         description:
-            - "If I(True) enable the oVirt/RHV to monitor cluster capacity for highly
+            - "If I(True) enables the oVirt/RHV to monitor cluster capacity for highly
                available virtual machines."
     trusted_service:
         description:
-            - "If (True) enable integration with an OpenAttestation server."
+            - "If I(True) enables integration with an OpenAttestation server."
     vm_reason:
         description:
-            - "If I(True) enable an optional reason field when a virtual machine
+            - "If I(True) enables an optional reason field when a virtual machine
                is shut down from the Manager, allowing the administrator to
                provide an explanation for the maintenance."
     host_reason:
         description:
-            - "If I(True) enable an optional reason field when a host is placed
+            - "If I(True) enables an optional reason field when a host is placed
                into maintenance mode from the Manager, allowing the administrator
                to provide an explanation for the maintenance."
     memory_policy:
@@ -207,7 +192,7 @@ options:
     switch_type:
         description:
             - "Type of switch to be used by all networks in given cluster.
-               Either I(legacy) which is using linux brigde or I(ovs) using
+               Either I(legacy) which is using linux bridge or I(ovs) using
                Open vSwitch."
         choices: ['legacy', 'ovs']
     compatibility_version:

lib/ansible/modules/cloud/ovirt/ovirt_datacenter.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
@@ -39,7 +24,7 @@ options:
         required: true
     state:
         description:
-            - "Should the data center be present or absent"
+            - "Should the data center be present or absent."
         choices: ['present', 'absent']
         default: present
     description:

lib/ansible/modules/cloud/ovirt/ovirt_datacenter_facts.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],

lib/ansible/modules/cloud/ovirt/ovirt_disk.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],

lib/ansible/modules/cloud/ovirt/ovirt_host_pm.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
@@ -67,7 +52,7 @@ options:
             - "Additional information about options can be found at U(https://github.com/ClusterLabs/fence-agents/blob/master/doc/FenceAgentAPI.md)."
     encrypt_options:
         description:
-            - "If (true) options will be encrypted when send to agent."
+            - "If I(true) options will be encrypted when send to agent."
         aliases: ['encrypt']
     order:
         description:

lib/ansible/modules/cloud/ovirt/ovirt_host_storage_facts.py

@@ -2,23 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2017 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
-
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
@@ -69,7 +53,7 @@ EXAMPLES = '''
 
 RETURN = '''
 ovirt_host_storages:
-    description: "List of dictionaries describing the HostStorage. HostStorage attribtues are mapped to dictionary keys,
+    description: "List of dictionaries describing the HostStorage. HostStorage attributes are mapped to dictionary keys,
                   all HostStorage attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/host_storage."
     returned: On success.
     type: list

lib/ansible/modules/cloud/ovirt/ovirt_hosts.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
@@ -95,7 +80,7 @@ options:
             - "Modifying kernel boot parameters settings can lead to a host boot failure.
                Please consult the product documentation before doing any changes."
             - "Kernel boot parameters changes require host deploy and restart. The host needs
-               to be I(reinstalled) suceesfully and then to be I(rebooted) for kernel boot parameters
+               to be I(reinstalled) successfully and then to be I(rebooted) for kernel boot parameters
                to be applied."
     hosted_engine:
         description:

lib/ansible/modules/cloud/ovirt/ovirt_hosts_facts.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],

lib/ansible/modules/cloud/ovirt/ovirt_mac_pools.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
@@ -47,7 +32,7 @@ options:
         default: present
     allow_duplicates:
         description:
-            - "If (true) allow a MAC address to be used multiple times in a pool."
+            - "If I(true) allow a MAC address to be used multiple times in a pool."
             - "Default value is set by oVirt/RHV engine to I(false)."
     ranges:
         description:

lib/ansible/modules/cloud/ovirt/ovirt_quotas.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
@@ -64,14 +49,14 @@ options:
     clusters:
         description:
             - "List of dictionary of cluster limits, which is valid to specific cluster."
-            - "If cluster isn't spefied it's valid to all clusters in system:"
+            - "If cluster isn't specified it's valid to all clusters in system:"
             - "C(cluster) - Name of the cluster."
             - "C(memory) - Memory limit (in GiB)."
             - "C(cpu) - CPU limit."
     storages:
         description:
             - "List of dictionary of storage limits, which is valid to specific storage."
-            - "If storage isn't spefied it's valid to all storages in system:"
+            - "If storage isn't specified it's valid to all storages in system:"
             - "C(storage) - Name of the storage."
             - "C(size) - Size limit (in GiB)."
 extends_documentation_fragment: ovirt

lib/ansible/modules/cloud/ovirt/ovirt_snapshots_facts.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
@@ -46,7 +31,7 @@ options:
             - "Description of the snapshot, can be used as glob expression."
     snapshot_id:
         description:
-            - "Id of the snaphost we want to retrieve facts about."
+            - "Id of the snapshot we want to retrieve facts about."
 extends_documentation_fragment: ovirt_facts
 '''
 

lib/ansible/modules/cloud/ovirt/ovirt_storage_connections.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2017 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
@@ -81,7 +66,7 @@ options:
             - "Virtual File System type."
     force:
         description:
-            - "This parameter is releven only when updating a connection."
+            - "This parameter is relevant only when updating a connection."
             - "If I(true) the storage domain don't have to be in I(MAINTENANCE)
                state, so the storage connection is updated."
 extends_documentation_fragment: ovirt

lib/ansible/modules/cloud/ovirt/ovirt_storage_domains.py

@@ -115,7 +115,7 @@ options:
         description:
             - "Dictionary with values for fibre channel storage type:"
             - "C(lun_id) - LUN id."
-            - "C(override_luns) - If I(True) FCP storage domain luns will be overridden before adding."
+            - "C(override_luns) - If I(True) FCP storage domain LUNs will be overridden before adding."
             - "Note that these parameters are not idempotent."
     wipe_after_delete:
         description:
@@ -127,11 +127,11 @@ options:
         version_added: "2.5"
     critical_space_action_blocker:
         description:
-            - "Inidcates the minimal free space the storage domain should contain in percentages."
+            - "Indicates the minimal free space the storage domain should contain in percentages."
         version_added: "2.5"
     warning_low_space:
         description:
-            - "Inidcates the minimum percentage of a free space in a storage domain to present a warning."
+            - "Indicates the minimum percentage of a free space in a storage domain to present a warning."
         version_added: "2.5"
     destroy:
         description:

lib/ansible/modules/cloud/ovirt/ovirt_templates.py

@@ -2,22 +2,7 @@
 # -*- coding: utf-8 -*-
 #
 # Copyright (c) 2016 Red Hat, Inc.
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-#
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
@@ -69,7 +54,7 @@ options:
             - "Mapper which maps an external virtual NIC profile to one that exists in the engine when C(state) is registered.
                vnic_profile is described by the following dictionary:"
             - "C(source_network_name): The network name of the source network."
-            - "C(source_profile_name): The prfile name related to the source network."
+            - "C(source_profile_name): The profile name related to the source network."
             - "C(target_profile_id): The id of the target profile id to be mapped to in the engine."
         version_added: "2.5"
     cluster_mappings:

lib/ansible/modules/cloud/ovirt/ovirt_vms.py

@@ -52,7 +52,7 @@ options:
             - "Mapper which maps an external virtual NIC profile to one that exists in the engine when C(state) is registered.
                vnic_profile is described by the following dictionary:"
             - "C(source_network_name): The network name of the source network."
-            - "C(source_profile_name): The prfile name related to the source network."
+            - "C(source_profile_name): The profile name related to the source network."
             - "C(target_profile_id): The id of the target profile id to be mapped to in the engine."
         version_added: "2.5"
     cluster_mappings:
@@ -324,8 +324,8 @@ options:
     disks:
         description:
             - List of disks, which should be attached to Virtual Machine. Disk is described by following dictionary.
-            - C(name) - Name of the disk. Either C(name) or C(id) is reuqired.
+            - C(name) - Name of the disk. Either C(name) or C(id) is required.
-            - C(id) - ID of the disk. Either C(name) or C(id) is reuqired.
+            - C(id) - ID of the disk. Either C(name) or C(id) is required.
             - C(interface) - Interface of the disk, either I(virtio) or I(IDE), default is I(virtio).
             - C(bootable) - I(True) if the disk should be bootable, default is non bootable.
             - C(activate) - I(True) if the disk should be activated, default is activated.
@@ -366,7 +366,7 @@ options:
             - C(nic_on_boot) - If I(True) network interface will be set to start on boot.
     cloud_init_nics:
         description:
-            - List of dictionaries representing network interafaces to be setup by cloud init.
+            - List of dictionaries representing network interfaces to be setup by cloud init.
             - This option is used, when user needs to setup more network interfaces via cloud init.
             - If one network interface is enough, user should use C(cloud_init) I(nic_*) parameters. C(cloud_init) I(nic_*) parameters
               are merged with C(cloud_init_nics) parameters.