mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
VMware: add new module vmware_host_dns_facts (#35708)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
parent
e3b6b40d88
commit
e9e8151c6d
3 changed files with 231 additions and 0 deletions
137
lib/ansible/modules/cloud/vmware/vmware_host_dns_facts.py
Normal file
137
lib/ansible/modules/cloud/vmware/vmware_host_dns_facts.py
Normal file
|
@ -0,0 +1,137 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright: (c) 2018, Abhijeet Kasurde <akasurde@redhat.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {
|
||||
'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'
|
||||
}
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: vmware_host_dns_facts
|
||||
short_description: Gathers facts about an ESXi host's DNS configuration information
|
||||
description:
|
||||
- This module can be used to gather facts about an ESXi host's DNS configuration information when ESXi hostname or Cluster name is given.
|
||||
- All parameters and VMware object names are case sensitive.
|
||||
version_added: '2.5'
|
||||
author:
|
||||
- Abhijeet Kasurde (@akasurde)
|
||||
notes:
|
||||
- Tested on vSphere 6.5
|
||||
requirements:
|
||||
- python >= 2.6
|
||||
- PyVmomi
|
||||
options:
|
||||
cluster_name:
|
||||
description:
|
||||
- Name of the cluster from which the ESXi host belong to.
|
||||
- If C(esxi_hostname) is not given, this parameter is required.
|
||||
esxi_hostname:
|
||||
description:
|
||||
- ESXi hostname to gather facts from.
|
||||
- If C(cluster_name) is not given, this parameter is required.
|
||||
extends_documentation_fragment: vmware.documentation
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Gather DNS facts about all ESXi Host in given Cluster
|
||||
vmware_host_dns_facts:
|
||||
hostname: '{{ vcenter_hostname }}'
|
||||
username: '{{ vcenter_username }}'
|
||||
password: '{{ vcenter_password }}'
|
||||
cluster_name: cluster_name
|
||||
|
||||
- name: Gather DNS facts about ESXi Host
|
||||
vmware_host_dns_facts:
|
||||
hostname: '{{ vcenter_hostname }}'
|
||||
username: '{{ vcenter_username }}'
|
||||
password: '{{ vcenter_password }}'
|
||||
esxi_hostname: '{{ esxi_hostname }}'
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
drs_rule_facts:
|
||||
description: metadata about DNS config from given cluster / host system
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {
|
||||
"DC0_C0_H0": {
|
||||
"dhcp": true,
|
||||
"domain_name": "localdomain",
|
||||
"host_name": "localhost",
|
||||
"ip_address": [
|
||||
"8.8.8.8"
|
||||
],
|
||||
"search_doamin": [
|
||||
"localdomain"
|
||||
],
|
||||
"virtual_nic_device": "vmk0"
|
||||
}
|
||||
}
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.vmware import vmware_argument_spec, PyVmomi
|
||||
|
||||
|
||||
class VmwareDnsFactsManager(PyVmomi):
|
||||
def __init__(self, module):
|
||||
super(VmwareDnsFactsManager, self).__init__(module)
|
||||
cluster_name = self.params.get('cluster_name', None)
|
||||
esxi_host_name = self.params.get('esxi_hostname', None)
|
||||
self.hosts = []
|
||||
if cluster_name:
|
||||
cluster_obj = self.find_cluster_by_name(cluster_name=cluster_name)
|
||||
if cluster_obj:
|
||||
self.hosts = [host for host in cluster_obj.host]
|
||||
else:
|
||||
module.fail_json(changed=False, msg="Cluster '%s' not found" % cluster_name)
|
||||
elif esxi_host_name:
|
||||
esxi_host_obj = self.find_hostsystem_by_name(host_name=esxi_host_name)
|
||||
if esxi_host_obj:
|
||||
self.hosts = [esxi_host_obj]
|
||||
else:
|
||||
module.fail_json(changed=False, msg="ESXi '%s' not found" % esxi_host_name)
|
||||
|
||||
def gather_dns_facts(self):
|
||||
hosts_facts = {}
|
||||
for host in self.hosts:
|
||||
host_facts = {}
|
||||
dns_config = host.config.network.dnsConfig
|
||||
host_facts['dhcp'] = dns_config.dhcp
|
||||
host_facts['virtual_nic_device'] = dns_config.virtualNicDevice
|
||||
host_facts['host_name'] = dns_config.hostName
|
||||
host_facts['domain_name'] = dns_config.domainName
|
||||
host_facts['ip_address'] = [ip for ip in dns_config.address]
|
||||
host_facts['search_doamin'] = [domain for domain in dns_config.searchDomain]
|
||||
hosts_facts[host.name] = host_facts
|
||||
return hosts_facts
|
||||
|
||||
|
||||
def main():
|
||||
argument_spec = vmware_argument_spec()
|
||||
argument_spec.update(
|
||||
cluster_name=dict(type='str', required=False),
|
||||
esxi_hostname=dict(type='str', required=False),
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_spec,
|
||||
required_one_of=[
|
||||
['cluster_name', 'esxi_hostname'],
|
||||
]
|
||||
)
|
||||
|
||||
vmware_dns_config = VmwareDnsFactsManager(module)
|
||||
module.exit_json(changed=False, hosts_dns_facts=vmware_dns_config.gather_dns_facts())
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
3
test/integration/targets/vmware_host_dns_facts/aliases
Normal file
3
test/integration/targets/vmware_host_dns_facts/aliases
Normal file
|
@ -0,0 +1,3 @@
|
|||
posix/ci/cloud/group4/vcenter
|
||||
cloud/vcenter
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
# Test code for the vmware_host_dns_facts module.
|
||||
# Copyright: (c) 2018, Abhijeet Kasurde <akasurde@redhat.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
- name: make sure pyvmomi is installed
|
||||
pip:
|
||||
name: pyvmomi
|
||||
state: latest
|
||||
when: "{{ ansible_user_id == 'root' }}"
|
||||
|
||||
- name: store the vcenter container ip
|
||||
set_fact:
|
||||
vcsim: "{{ lookup('env', 'vcenter_host') }}"
|
||||
|
||||
- debug: var=vcsim
|
||||
|
||||
- name: Wait for Flask controller to come up online
|
||||
wait_for:
|
||||
host: "{{ vcsim }}"
|
||||
port: 5000
|
||||
state: started
|
||||
|
||||
- name: kill vcsim
|
||||
uri:
|
||||
url: http://{{ vcsim }}:5000/killall
|
||||
|
||||
- name: start vcsim
|
||||
uri:
|
||||
url: http://{{ vcsim }}:5000/spawn?cluster=2
|
||||
register: vcsim_instance
|
||||
|
||||
- debug:
|
||||
var: vcsim_instance
|
||||
|
||||
- name: Wait for vcsim server to come up online
|
||||
wait_for:
|
||||
host: "{{ vcsim }}"
|
||||
port: 443
|
||||
state: started
|
||||
|
||||
- name: get a list of Cluster from vcsim
|
||||
uri:
|
||||
url: http://{{ vcsim }}:5000/govc_find?filter=CCR
|
||||
register: clusters
|
||||
|
||||
- name: get a cluster
|
||||
set_fact:
|
||||
ccr1: "{{ clusters.json[0] | basename }}"
|
||||
|
||||
- debug: var=ccr1
|
||||
|
||||
- name: get a list of Hosts from vcsim
|
||||
uri:
|
||||
url: http://{{ vcsim }}:5000/govc_find?filter=H
|
||||
register: hosts
|
||||
|
||||
- name: get a cluster
|
||||
set_fact:
|
||||
host1: "{{ hosts.json[0] | basename }}"
|
||||
|
||||
- debug: var=host1
|
||||
|
||||
- name: gather DNS facts about all hosts in given cluster
|
||||
vmware_host_dns_facts:
|
||||
hostname: "{{ vcsim }}"
|
||||
username: "{{ vcsim_instance.json.username }}"
|
||||
password: "{{ vcsim_instance.json.password }}"
|
||||
cluster_name: "{{ ccr1 }}"
|
||||
validate_certs: no
|
||||
register: all_hosts_dns_result
|
||||
|
||||
- name: ensure DNS facts are gathered for all hosts in given cluster
|
||||
assert:
|
||||
that:
|
||||
- all_hosts_dns_result.hosts_dns_facts
|
||||
- not all_hosts_dns_result.changed
|
||||
|
||||
- name: gather DNS facts about host system
|
||||
vmware_host_dns_facts:
|
||||
hostname: "{{ vcsim }}"
|
||||
username: "{{ vcsim_instance.json.username }}"
|
||||
password: "{{ vcsim_instance.json.password }}"
|
||||
esxi_hostname: "{{ host1 }}"
|
||||
validate_certs: no
|
||||
register: all_hosts_dns_result
|
||||
|
||||
- name: ensure DNS facts are gathered about host system
|
||||
assert:
|
||||
that:
|
||||
- all_hosts_dns_result.hosts_dns_facts
|
||||
- not all_hosts_dns_result.changed
|
Loading…
Reference in a new issue