Fix Ansible documentation in part of example formatting. Part 1 (#332)

* Fix Ansible documentation in part of example formatting

* Fix

plugins/modules/cloud/ovirt/ovirt_affinity_label_facts.py

@@ -58,36 +58,47 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all affinity labels, which names start with C(label):
-- ovirt_affinity_label_info:
+- name: Gather information about all affinity labels, which names start with label
+  ovirt_affinity_label_info:
     name: label*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_affinity_labels }}"
 
-# Gather information about all affinity labels, which are assigned to VMs
-# which names start with C(postgres):
-- ovirt_affinity_label_info:
+- name: >
+    Gather information about all affinity labels, which are assigned to VMs
+    which names start with postgres
+  ovirt_affinity_label_info:
     vm: postgres*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_affinity_labels }}"
 
-# Gather information about all affinity labels, which are assigned to hosts
-# which names start with C(west):
-- ovirt_affinity_label_info:
+- name: >
+    Gather information about all affinity labels, which are assigned to hosts
+    which names start with west
+  ovirt_affinity_label_info:
     host: west*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_affinity_labels }}"
 
-# Gather information about all affinity labels, which are assigned to hosts
-# which names start with C(west) or VMs which names start with C(postgres):
-- ovirt_affinity_label_info:
+- name: >
+    Gather information about all affinity labels, which are assigned to hosts
+    which names start with west or VMs which names start with postgres
+  ovirt_affinity_label_info:
     host: west*
     vm: postgres*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_affinity_labels }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_api_facts.py

@@ -33,10 +33,12 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information oVirt API:
-- ovirt_api_info:
+- name: Gather information oVirt API
+  ovirt_api_info:
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_api }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_cluster_facts.py

@@ -54,12 +54,14 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all clusters which names start with C<production>:
-- ovirt_cluster_info:
+- name: Gather information about all clusters which names start with production
+  ovirt_cluster_info:
     pattern:
       name: 'production*'
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_clusters }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_datacenter_facts.py

@@ -38,11 +38,13 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all data centers which names start with C(production):
-- ovirt_datacenter_info:
+- name: Gather information about all data centers which names start with production
+  ovirt_datacenter_info:
     pattern: name=production*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_datacenters }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_disk_facts.py

@@ -54,11 +54,13 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all Disks which names start with C(centos)
-- ovirt_disk_info:
+- name: Gather information about all Disks which names start with centos
+  ovirt_disk_info:
     pattern: name=centos*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_disks }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_external_provider_facts.py

@@ -57,12 +57,14 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all image external providers named C<glance>:
-- ovirt_external_provider_info:
+- name: Gather information about all image external providers named glance
+  ovirt_external_provider_info:
     type: os_image
     name: glance
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_external_providers }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_group_facts.py

@@ -53,11 +53,13 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all groups which names start with C(admin):
-- ovirt_group_info:
+- name: Gather information about all groups which names start with admin
+  ovirt_group_info:
     pattern: name=admin*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_groups }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_host_facts.py

@@ -50,19 +50,23 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all hosts which names start with C(host) and
-# belong to data center C(west):
-- ovirt_host_info:
+- name: Gather information about all hosts which names start with host and belong to data center west
+  ovirt_host_info:
     pattern: name=host* and datacenter=west
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_hosts }}"
-# All hosts with cluster version 4.2:
-- ovirt_host_info:
+
+- name: Gather information about all hosts with cluster version 4.2
+  ovirt_host_info:
     pattern: name=host*
     cluster_version: "4.2"
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_hosts }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_host_storage_facts.py

@@ -66,14 +66,16 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about HostStorages with specified target and address:
-- ovirt_host_storage_info:
+- name: Gather information about HostStorages with specified target and address
+  ovirt_host_storage_info:
     host: myhost
     iscsi:
       target: iqn.2016-08-09.domain-01:nickname
       address: 10.34.63.204
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_host_storages }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_network_facts.py

@@ -54,11 +54,13 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all networks which names start with C(vlan1):
-- ovirt_network_info:
+- name: Gather information about all networks which names start with vlan1
+  ovirt_network_info:
     pattern: name=vlan1*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_networks }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_nic_facts.py

@@ -56,12 +56,14 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all NICs which names start with C(eth) for VM named C(centos7):
-- ovirt_nic_info:
+- name: Gather information about all NICs which names start with eth for VM named centos7
+  ovirt_nic_info:
     vm: centos7
     name: eth*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_nics }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_permission_facts.py

@@ -64,12 +64,14 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all permissions of user with username C(john):
-- ovirt_permission_info:
+- name: Gather information about all permissions of user with username john
+  ovirt_permission_info:
     user_name: john
     authz_name: example.com-authz
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_permissions }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_quota_facts.py

@@ -56,12 +56,14 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about quota named C<myquota> in Default datacenter:
-- ovirt_quota_info:
+- name: Gather information about quota named C<myquota> in Default datacenter
+  ovirt_quota_info:
     data_center: Default
     name: myquota
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_quotas }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_scheduling_policy_facts.py

@@ -56,11 +56,13 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all scheduling policies with name InClusterUpgrade:
-- ovirt_scheduling_policy_info:
+- name: Gather information about all scheduling policies with name InClusterUpgrade
+  ovirt_scheduling_policy_info:
     name: InClusterUpgrade
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_scheduling_policies }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_snapshot_facts.py

@@ -44,12 +44,14 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all snapshots which description start with C(update) for VM named C(centos7):
-- ovirt_snapshot_info:
+- name: Gather information about all snapshots which description start with update for VM named centos7
+  ovirt_snapshot_info:
     vm: centos7
     description: update*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_snapshots }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_storage_domain_facts.py

@@ -54,12 +54,15 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all storage domains which names start with C(data) and
-# belong to data center C(west):
-- ovirt_storage_domain_info:
+- name: >
+    Gather information about all storage domains which names
+    start with data and belong to data center west
+  ovirt_storage_domain_info:
     pattern: name=data* and datacenter=west
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_storage_domains }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_storage_template_facts.py

@@ -61,12 +61,13 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all Templates which relate to a storage domain and
-# are unregistered:
-- ovirt_storage_template_info:
-    unregistered=True
+- name: Gather information about all templates which relate to a storage domain and are unregistered
+  ovirt_storage_template_info:
+    unregistered: yes
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_storage_templates }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_storage_vm_facts.py

@@ -61,12 +61,13 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all VMs which relate to a storage domain and
-# are unregistered:
-- ovirt_vms_info:
-    unregistered=True
+- name: Gather information about all VMs which relate to a storage domain and are unregistered
+  ovirt_vms_info:
+    unregistered: yes
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_storage_vms }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_tag_facts.py

@@ -58,25 +58,31 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all tags, which names start with C(tag):
-- ovirt_tag_info:
+- name: Gather information about all tags, which names start with tag
+  ovirt_tag_info:
     name: tag*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_tags }}"
 
-# Gather information about all tags, which are assigned to VM C(postgres):
-- ovirt_tag_info:
+- name: Gather information about all tags, which are assigned to VM postgres
+  ovirt_tag_info:
     vm: postgres
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_tags }}"
 
-# Gather information about all tags, which are assigned to host C(west):
-- ovirt_tag_info:
+- name: Gather information about all tags, which are assigned to host west
+  ovirt_tag_info:
     host: west
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_tags }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_template_facts.py

@@ -54,12 +54,13 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all templates which names start with C(centos) and
-# belongs to data center C(west):
-- ovirt_template_info:
+- name: Gather information about all templates which names start with centos and belongs to data center west
+  ovirt_template_info:
     pattern: name=centos* and datacenter=west
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_templates }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_user_facts.py

@@ -53,11 +53,13 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all users which first names start with C(john):
-- ovirt_user_info:
+- name: Gather information about all users which first names start with john
+  ovirt_user_info:
     pattern: name=john*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_users }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_vm_facts.py

@@ -73,20 +73,23 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all VMs which names start with C(centos) and
-# belong to cluster C(west):
-- ovirt_vm_info:
+- name: Gather information about all VMs which names start with centos and belong to cluster west
+  ovirt_vm_info:
     pattern: name=centos* and cluster=west
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_vms }}"
 
-# Gather info about next run configuration of virtual machine named myvm
-- ovirt_vm_info:
+- name: Gather info about next run configuration of virtual machine named myvm
+  ovirt_vm_info:
     pattern: name=myvm
     next_run: true
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_vms[0] }}"
 '''
 

plugins/modules/cloud/ovirt/ovirt_vmpool_facts.py

@@ -53,11 +53,13 @@ EXAMPLES = '''
 # Examples don't contain auth parameter for simplicity,
 # look at ovirt_auth module to see how to reuse authentication:
 
-# Gather information about all vm pools which names start with C(centos):
-- ovirt_vmpool_info:
+- name: Gather information about all vm pools which names start with centos
+  ovirt_vmpool_info:
     pattern: name=centos*
   register: result
-- debug:
+
+- name: Print gathered information
+  debug:
     msg: "{{ result.ovirt_vm_pools }}"
 '''