1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
# 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
DOCUMENTATION = r'''
name: libvirt
extends_documentation_fragment:
- constructed
- community.libvirt.requirements
short_description: Libvirt inventory source
description:
- Get libvirt guests in an inventory source.
author:
- Dave Olsthoorn (@daveol) <dave@bewaar.me>
version_added: "2.10.0"
options:
plugin:
description: Token that ensures this is a source file for the 'libvirt' plugin.
required: True
choices: ['libvirt', 'community.libvirt.libvirt']
uri:
description: Libvirt Connection URI
required: True
type: str
inventory_hostname:
description: |
What to register as the inventory hostname.
If set to 'uuid' the uuid of the server will be used and a
group will be created for the server name.
If set to 'name' the name of the server will be used unless
there are more than one server with the same name in which
case the 'uuid' logic will be used.
Default is to do 'name'.
type: string
choices:
- name
- uuid
default: "name"
'''
EXAMPLES = r'''
# Connect to lxc host
plugin: community.libvirt.libvirt
uri: 'lxc:///'
# Connect to qemu
plugin: community.libvirt.libvirt
uri: 'qemu:///system'
'''
from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
from ansible.errors import AnsibleError
from ansible.module_utils.six import raise_from
try:
import libvirt
except ImportError as imp_exc:
LIBVIRT_IMPORT_ERROR = imp_exc
else:
LIBVIRT_IMPORT_ERROR = None
VIRDOMAINSTATE = ["nostate", "running", "blocked", "paused", "shutdown", "shutoff", "crashed", "pmsuspended", "last"]
class InventoryModule(BaseInventoryPlugin, Constructable):
NAME = 'community.libvirt.libvirt'
def parse(self, inventory, loader, path, cache=True):
if LIBVIRT_IMPORT_ERROR:
raise_from(
AnsibleError('libvirt python bindings must be installed to use this plugin'),
LIBVIRT_IMPORT_ERROR)
super(InventoryModule, self).parse(
inventory,
loader,
path,
cache=cache
)
config_data = self._read_config_data(path)
# set _options from config data
self._consume_options(config_data)
uri = self.get_option('uri')
if not uri:
raise AnsibleError("hypervisor uri not given")
connection = libvirt.open(uri)
if not connection:
raise AnsibleError("hypervisor connection failure")
# TODO(daveol)
# make using connection plugins optional
connection_plugin = dict({
'LXC': 'community.libvirt.libvirt_lxc',
'QEMU': 'community.libvirt.libvirt_qemu'
}).get(connection.getType())
for server in connection.listAllDomains():
inventory_hostname = dict({
'uuid': server.UUIDString(),
'name': server.name()
}).get(
self.get_option('inventory_hostname')
)
inventory_hostname_alias = dict({
'name': server.UUIDString(),
'uuid': server.name()
}).get(
self.get_option('inventory_hostname')
)
# TODO(daveol): Fix "Invalid characters were found in group names"
# This warning is generated because of uuid's
self.inventory.add_host(inventory_hostname)
self.inventory.add_group(inventory_hostname_alias)
self.inventory.add_child(inventory_hostname_alias, inventory_hostname)
if connection_plugin is not None:
self.inventory.set_variable(
inventory_hostname,
'ansible_libvirt_uri',
uri
)
self.inventory.set_variable(
inventory_hostname,
'ansible_connection',
connection_plugin
)
try:
domain = connection.lookupByUUIDString(server.UUIDString())
except libvirt.libvirtError as e:
self.inventory.set_variable(
inventory_hostname,
'ERROR',
str(e)
)
else:
_domain_state, _domain_maxmem, _domain_mem, _domain_cpus, _domain_cput = domain.info()
domain_info = {"state_number": _domain_state,
"state": VIRDOMAINSTATE[_domain_state],
"maxMem_kb": _domain_maxmem,
"memory_kb": _domain_mem,
"nrVirtCpu": _domain_cpus,
"cpuTime_ns": _domain_cput}
self.inventory.set_variable(
inventory_hostname,
'info',
domain_info
)
self.inventory.set_variable(
inventory_hostname,
'xml_desc',
domain.XMLDesc()
)
# This needs the guest powered on, 'qemu-guest-agent' installed and the org.qemu.guest_agent.0 channel configured.
domain_guestInfo = ''
try:
# type==0 returns all types (users, os, timezone, hostname, filesystem, disks, interfaces)
domain_guestInfo = domain.guestInfo(types=0)
except libvirt.libvirtError as e:
domain_guestInfo = {"error": str(e)}
finally:
self.inventory.set_variable(
inventory_hostname,
'guest_info',
domain_guestInfo
)
# This needs the guest powered on, 'qemu-guest-agent' installed and the org.qemu.guest_agent.0 channel configured.
domain_interfaceAddresses = ''
try:
domain_interfaceAddresses = domain.interfaceAddresses(source=libvirt.VIR_DOMAIN_INTERFACE_ADDRESSES_SRC_AGENT)
except libvirt.libvirtError as e:
domain_interfaceAddresses = {"error": str(e)}
finally:
self.inventory.set_variable(
inventory_hostname,
'interface_addresses',
domain_interfaceAddresses
)
# Get variables for compose
variables = self.inventory.hosts[inventory_hostname].get_vars()
# Set composed variables
self._set_composite_vars(
self.get_option('compose'),
variables,
inventory_hostname,
self.get_option('strict'),
)
# Add host to composed groups
self._add_host_to_composed_groups(
self.get_option('groups'),
variables,
inventory_hostname,
self.get_option('strict'),
)
# Add host to keyed groups
self._add_host_to_keyed_groups(
self.get_option('keyed_groups'),
variables,
inventory_hostname,
self.get_option('strict'),
)
|
