Class: VagrantPlugins::ProviderLibvirt::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/vagrant-libvirt/config.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Config

Returns a new instance of Config.



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/vagrant-libvirt/config.rb', line 164

def initialize
  @uri               = UNSET_VALUE
  @driver            = UNSET_VALUE
  @host              = UNSET_VALUE
  @connect_via_ssh   = UNSET_VALUE
  @username          = UNSET_VALUE
  @password          = UNSET_VALUE
  @id_ssh_key_file   = UNSET_VALUE
  @storage_pool_name = UNSET_VALUE
  @random_hostname   = UNSET_VALUE
  @management_network_device  = UNSET_VALUE
  @management_network_name    = UNSET_VALUE
  @management_network_address = UNSET_VALUE
  @management_network_mode = UNSET_VALUE
  @management_network_mac  = UNSET_VALUE
  @management_network_guest_ipv6 = UNSET_VALUE
  @management_network_autostart = UNSET_VALUE
  @management_network_pci_slot = UNSET_VALUE
  @management_network_pci_bus = UNSET_VALUE

  # System connection information
  @system_uri      = UNSET_VALUE

  # Domain specific settings.
  @uuid              = UNSET_VALUE
  @memory            = UNSET_VALUE
  @memory_backing    = UNSET_VALUE
  @cpus              = UNSET_VALUE
  @cpu_mode          = UNSET_VALUE
  @cpu_model         = UNSET_VALUE
  @cpu_fallback      = UNSET_VALUE
  @cpu_features      = UNSET_VALUE
  @cpu_topology      = UNSET_VALUE
  @features          = UNSET_VALUE
  @features_hyperv   = UNSET_VALUE
  @numa_nodes        = UNSET_VALUE
  @loader            = UNSET_VALUE
  @nvram             = UNSET_VALUE
  @machine_type      = UNSET_VALUE
  @machine_arch      = UNSET_VALUE
  @machine_virtual_size = UNSET_VALUE
  @disk_bus          = UNSET_VALUE
  @disk_device       = UNSET_VALUE
  @nic_model_type    = UNSET_VALUE
  @nested            = UNSET_VALUE
  @volume_cache      = UNSET_VALUE
  @kernel            = UNSET_VALUE
  @initrd            = UNSET_VALUE
  @dtb               = UNSET_VALUE
  @cmd_line          = UNSET_VALUE
  @emulator_path     = UNSET_VALUE
  @graphics_type     = UNSET_VALUE
  @graphics_autoport = UNSET_VALUE
  @graphics_port     = UNSET_VALUE
  @graphics_ip       = UNSET_VALUE
  @graphics_passwd   = UNSET_VALUE
  @video_type        = UNSET_VALUE
  @video_vram        = UNSET_VALUE
  @sound_type        = UNSET_VALUE
  @keymap            = UNSET_VALUE
  @kvm_hidden        = UNSET_VALUE

  @tpm_model         = UNSET_VALUE
  @tpm_type          = UNSET_VALUE
  @tpm_path          = UNSET_VALUE

  @nic_adapter_count = UNSET_VALUE

  # Boot order
  @boot_order        = []
  # Storage
  @disks             = []
  @cdroms            = []

  # Inputs
  @inputs            = UNSET_VALUE

  # Channels
  @channels          = UNSET_VALUE

  # PCI device passthrough
  @pcis              = UNSET_VALUE

  # Random number device passthrough
  @rng = UNSET_VALUE

  # Watchdog device
  @watchdog_dev      = UNSET_VALUE

  # USB controller
  @usbctl_dev        = UNSET_VALUE

  # USB device passthrough
  @usbs              = UNSET_VALUE

  # Redirected devices
  @redirdevs         = UNSET_VALUE
  @redirfilters      = UNSET_VALUE

  # smartcard device
  @smartcard_dev     = UNSET_VALUE

  # Suspend mode
  @suspend_mode      = UNSET_VALUE

  # Autostart
  @autostart         = UNSET_VALUE

  # Attach mgmt network
  @mgmt_attach       = UNSET_VALUE

  @qemu_args  = []
  @qemu_use_session  = UNSET_VALUE
end

Instance Attribute Details

#autostart ⇒ Object

Autostart



153
154
155
 
# File 'lib/vagrant-libvirt/config.rb', line 153

def autostart
  @autostart
end

#boot_order ⇒ Object

Returns the value of attribute boot_order.



81
82
83
 
# File 'lib/vagrant-libvirt/config.rb', line 81

def boot_order
  @boot_order
end

#cdroms ⇒ Object

Returns the value of attribute cdroms.



119
120
121
 
# File 'lib/vagrant-libvirt/config.rb', line 119

def cdroms
  @cdroms
end

#channel(options = {}) ⇒ Object

Returns the value of attribute channel.



69
70
71
 
# File 'lib/vagrant-libvirt/config.rb', line 69

def channel
  @channel
end

#channels ⇒ Object

Channels



125
126
127
 
# File 'lib/vagrant-libvirt/config.rb', line 125

def channels
  @channels
end

#cmd_line ⇒ Object

Returns the value of attribute cmd_line.



91
92
93
 
# File 'lib/vagrant-libvirt/config.rb', line 91

def cmd_line
  @cmd_line
end

#connect_via_ssh ⇒ Object

If use ssh tunnel to connect to Libvirt.



27
28
29
 
# File 'lib/vagrant-libvirt/config.rb', line 27

def connect_via_ssh
  @connect_via_ssh
end

#cpu_fallback ⇒ Object

Returns the value of attribute cpu_fallback.



73
74
75
 
# File 'lib/vagrant-libvirt/config.rb', line 73

def cpu_fallback
  @cpu_fallback
end

#cpu_features ⇒ Object

Returns the value of attribute cpu_features.



74
75
76
 
# File 'lib/vagrant-libvirt/config.rb', line 74

def cpu_features
  @cpu_features
end

#cpu_mode ⇒ Object

Returns the value of attribute cpu_mode.



71
72
73
 
# File 'lib/vagrant-libvirt/config.rb', line 71

def cpu_mode
  @cpu_mode
end

#cpu_model ⇒ Object

Returns the value of attribute cpu_model.



72
73
74
 
# File 'lib/vagrant-libvirt/config.rb', line 72

def cpu_model
  @cpu_model
end

#cpu_topology ⇒ Object

Returns the value of attribute cpu_topology.



75
76
77
 
# File 'lib/vagrant-libvirt/config.rb', line 75

def cpu_topology
  @cpu_topology
end

#cpus ⇒ Object

Returns the value of attribute cpus.



70
71
72
 
# File 'lib/vagrant-libvirt/config.rb', line 70

def cpus
  @cpus
end

#default_prefix ⇒ Object

Default host prefix (alternative to use project folder name)



63
64
65
 
# File 'lib/vagrant-libvirt/config.rb', line 63

def default_prefix
  @default_prefix
end

#disk_bus ⇒ Object

Returns the value of attribute disk_bus.



85
86
87
 
# File 'lib/vagrant-libvirt/config.rb', line 85

def disk_bus
  @disk_bus
end

#disk_device ⇒ Object

Returns the value of attribute disk_device.



86
87
88
 
# File 'lib/vagrant-libvirt/config.rb', line 86

def disk_device
  @disk_device
end

#disks ⇒ Object

Storage



118
119
120
 
# File 'lib/vagrant-libvirt/config.rb', line 118

def disks
  @disks
end

#driver ⇒ Object

A hypervisor name to access via Libvirt.



21
22
23
 
# File 'lib/vagrant-libvirt/config.rb', line 21

def driver
  @driver
end

#dtb ⇒ Object

Returns the value of attribute dtb.



93
94
95
 
# File 'lib/vagrant-libvirt/config.rb', line 93

def dtb
  @dtb
end

#emulator_path ⇒ Object

Returns the value of attribute emulator_path.



94
95
96
 
# File 'lib/vagrant-libvirt/config.rb', line 94

def emulator_path
  @emulator_path
end

#features ⇒ Object

Returns the value of attribute features.



76
77
78
 
# File 'lib/vagrant-libvirt/config.rb', line 76

def features
  @features
end

#features_hyperv ⇒ Object

Returns the value of attribute features_hyperv.



77
78
79
 
# File 'lib/vagrant-libvirt/config.rb', line 77

def features_hyperv
  @features_hyperv
end

#graphics_autoport ⇒ Object

Returns the value of attribute graphics_autoport.



96
97
98
 
# File 'lib/vagrant-libvirt/config.rb', line 96

def graphics_autoport
  @graphics_autoport
end

#graphics_ip ⇒ Object

Returns the value of attribute graphics_ip.



99
100
101
 
# File 'lib/vagrant-libvirt/config.rb', line 99

def graphics_ip
  @graphics_ip
end

#graphics_passwd ⇒ Object

Returns the value of attribute graphics_passwd.



98
99
100
 
# File 'lib/vagrant-libvirt/config.rb', line 98

def graphics_passwd
  @graphics_passwd
end

#graphics_port ⇒ Object

Returns the value of attribute graphics_port.



97
98
99
 
# File 'lib/vagrant-libvirt/config.rb', line 97

def graphics_port
  @graphics_port
end

#graphics_type ⇒ Object

Returns the value of attribute graphics_type.



95
96
97
 
# File 'lib/vagrant-libvirt/config.rb', line 95

def graphics_type
  @graphics_type
end

#host ⇒ Object

The name of the server, where libvirtd is running.



24
25
26
 
# File 'lib/vagrant-libvirt/config.rb', line 24

def host
  @host
end

#id_ssh_key_file ⇒ Object

ID SSH key file



38
39
40
 
# File 'lib/vagrant-libvirt/config.rb', line 38

def id_ssh_key_file
  @id_ssh_key_file
end

#initrd ⇒ Object

Returns the value of attribute initrd.



92
93
94
 
# File 'lib/vagrant-libvirt/config.rb', line 92

def initrd
  @initrd
end

#inputs ⇒ Object

Inputs



122
123
124
 
# File 'lib/vagrant-libvirt/config.rb', line 122

def inputs
  @inputs
end

#kernel ⇒ Object

Returns the value of attribute kernel.



90
91
92
 
# File 'lib/vagrant-libvirt/config.rb', line 90

def kernel
  @kernel
end

#keymap ⇒ Object

Returns the value of attribute keymap.



102
103
104
 
# File 'lib/vagrant-libvirt/config.rb', line 102

def keymap
  @keymap
end

#kvm_hidden ⇒ Object

Returns the value of attribute kvm_hidden.



103
104
105
 
# File 'lib/vagrant-libvirt/config.rb', line 103

def kvm_hidden
  @kvm_hidden
end

#loader ⇒ Object

Returns the value of attribute loader.



79
80
81
 
# File 'lib/vagrant-libvirt/config.rb', line 79

def loader
  @loader
end

#machine_arch ⇒ Object

Returns the value of attribute machine_arch.



83
84
85
 
# File 'lib/vagrant-libvirt/config.rb', line 83

def machine_arch
  @machine_arch
end

#machine_type ⇒ Object

Returns the value of attribute machine_type.



82
83
84
 
# File 'lib/vagrant-libvirt/config.rb', line 82

def machine_type
  @machine_type
end

#machine_virtual_size ⇒ Object

Returns the value of attribute machine_virtual_size.



84
85
86
 
# File 'lib/vagrant-libvirt/config.rb', line 84

def machine_virtual_size
  @machine_virtual_size
end

#management_network_address ⇒ Object

Returns the value of attribute management_network_address.



51
52
53
 
# File 'lib/vagrant-libvirt/config.rb', line 51

def management_network_address
  @management_network_address
end

#management_network_autostart ⇒ Object

Returns the value of attribute management_network_autostart.



55
56
57
 
# File 'lib/vagrant-libvirt/config.rb', line 55

def management_network_autostart
  @management_network_autostart
end

#management_network_device ⇒ Object

Libvirt default network



49
50
51
 
# File 'lib/vagrant-libvirt/config.rb', line 49

def management_network_device
  @management_network_device
end

#management_network_guest_ipv6 ⇒ Object

Returns the value of attribute management_network_guest_ipv6.



54
55
56
 
# File 'lib/vagrant-libvirt/config.rb', line 54

def management_network_guest_ipv6
  @management_network_guest_ipv6
end

#management_network_mac ⇒ Object

Returns the value of attribute management_network_mac.



53
54
55
 
# File 'lib/vagrant-libvirt/config.rb', line 53

def management_network_mac
  @management_network_mac
end

#management_network_mode ⇒ Object

Returns the value of attribute management_network_mode.



52
53
54
 
# File 'lib/vagrant-libvirt/config.rb', line 52

def management_network_mode
  @management_network_mode
end

#management_network_name ⇒ Object

Returns the value of attribute management_network_name.



50
51
52
 
# File 'lib/vagrant-libvirt/config.rb', line 50

def management_network_name
  @management_network_name
end

#management_network_pci_bus ⇒ Object

Returns the value of attribute management_network_pci_bus.



56
57
58
 
# File 'lib/vagrant-libvirt/config.rb', line 56

def management_network_pci_bus
  @management_network_pci_bus
end

#management_network_pci_slot ⇒ Object

Returns the value of attribute management_network_pci_slot.



57
58
59
 
# File 'lib/vagrant-libvirt/config.rb', line 57

def management_network_pci_slot
  @management_network_pci_slot
end

#memory ⇒ Object

Returns the value of attribute memory.



67
68
69
 
# File 'lib/vagrant-libvirt/config.rb', line 67

def memory
  @memory
end

#memory_backing ⇒ Object

Returns the value of attribute memory_backing.



68
69
70
 
# File 'lib/vagrant-libvirt/config.rb', line 68

def memory_backing
  @memory_backing
end

#mgmt_attach ⇒ Object

Attach mgmt network



156
157
158
 
# File 'lib/vagrant-libvirt/config.rb', line 156

def mgmt_attach
  @mgmt_attach
end

#nested ⇒ Object

Returns the value of attribute nested.



88
89
90
 
# File 'lib/vagrant-libvirt/config.rb', line 88

def nested
  @nested
end

#nic_adapter_count ⇒ Object

Sets the max number of NICs that can be created Default set to 8. Don’t change the default unless you know what are doing



115
116
117
 
# File 'lib/vagrant-libvirt/config.rb', line 115

def nic_adapter_count
  @nic_adapter_count
end

#nic_model_type ⇒ Object

Returns the value of attribute nic_model_type.



87
88
89
 
# File 'lib/vagrant-libvirt/config.rb', line 87

def nic_model_type
  @nic_model_type
end

#numa_nodes ⇒ Object

Returns the value of attribute numa_nodes.



78
79
80
 
# File 'lib/vagrant-libvirt/config.rb', line 78

def numa_nodes
  @numa_nodes
end

#nvram ⇒ Object

Returns the value of attribute nvram.



80
81
82
 
# File 'lib/vagrant-libvirt/config.rb', line 80

def nvram
  @nvram
end

#password ⇒ Object

Password for Libvirt connection.



35
36
37
 
# File 'lib/vagrant-libvirt/config.rb', line 35

def password
  @password
end

#pcis ⇒ Object

PCI device passthrough



128
129
130
 
# File 'lib/vagrant-libvirt/config.rb', line 128

def pcis
  @pcis
end

#qemu_args ⇒ Object

Additional qemuargs arguments



159
160
161
 
# File 'lib/vagrant-libvirt/config.rb', line 159

def qemu_args
  @qemu_args
end

#qemu_use_session ⇒ Object

Use qemu session instead of system



162
163
164
 
# File 'lib/vagrant-libvirt/config.rb', line 162

def qemu_use_session
  @qemu_use_session
end

#random_hostname ⇒ Object

Turn on to prevent hostname conflicts



46
47
48
 
# File 'lib/vagrant-libvirt/config.rb', line 46

def random_hostname
  @random_hostname
end

#redirdevs ⇒ Object

Redirected devices



143
144
145
 
# File 'lib/vagrant-libvirt/config.rb', line 143

def redirdevs
  @redirdevs
end

#redirfilters ⇒ Object

Returns the value of attribute redirfilters.



144
145
146
 
# File 'lib/vagrant-libvirt/config.rb', line 144

def redirfilters
  @redirfilters
end

#rng ⇒ Object

Random number device passthrough



131
132
133
 
# File 'lib/vagrant-libvirt/config.rb', line 131

def rng
  @rng
end

#smartcard_dev ⇒ Object

smartcard device



147
148
149
 
# File 'lib/vagrant-libvirt/config.rb', line 147

def smartcard_dev
  @smartcard_dev
end

#socket ⇒ Object

Path towards the libvirt socket



29
30
31
 
# File 'lib/vagrant-libvirt/config.rb', line 29

def socket
  @socket
end

#sound_type ⇒ Object

Returns the value of attribute sound_type.



104
105
106
 
# File 'lib/vagrant-libvirt/config.rb', line 104

def sound_type
  @sound_type
end

#storage_pool_name ⇒ Object

Libvirt storage pool name, where box image and instance snapshots will be stored.



42
43
44
 
# File 'lib/vagrant-libvirt/config.rb', line 42

def storage_pool_name
  @storage_pool_name
end

#storage_pool_path ⇒ Object

Returns the value of attribute storage_pool_path.



43
44
45
 
# File 'lib/vagrant-libvirt/config.rb', line 43

def storage_pool_path
  @storage_pool_path
end

#suspend_mode ⇒ Object

Suspend mode



150
151
152
 
# File 'lib/vagrant-libvirt/config.rb', line 150

def suspend_mode
  @suspend_mode
end

#system_uri ⇒ Object

System connection information



60
61
62
 
# File 'lib/vagrant-libvirt/config.rb', line 60

def system_uri
  @system_uri
end

#tpm_model ⇒ Object

Sets the information for connecting to a host TPM device Only supports socket-based TPMs



108
109
110
 
# File 'lib/vagrant-libvirt/config.rb', line 108

def tpm_model
  @tpm_model
end

#tpm_path ⇒ Object

Returns the value of attribute tpm_path.



110
111
112
 
# File 'lib/vagrant-libvirt/config.rb', line 110

def tpm_path
  @tpm_path
end

#tpm_type ⇒ Object

Returns the value of attribute tpm_type.



109
110
111
 
# File 'lib/vagrant-libvirt/config.rb', line 109

def tpm_type
  @tpm_type
end

#uri ⇒ Object

manually specify URI will supercede most other options if provided



18
19
20
 
# File 'lib/vagrant-libvirt/config.rb', line 18

def uri
  @uri
end

#usbctl_dev ⇒ Object

USB controller



137
138
139
 
# File 'lib/vagrant-libvirt/config.rb', line 137

def usbctl_dev
  @usbctl_dev
end

#usbs ⇒ Object

USB device passthrough



140
141
142
 
# File 'lib/vagrant-libvirt/config.rb', line 140

def usbs
  @usbs
end

#username ⇒ Object

The username to access Libvirt.



32
33
34
 
# File 'lib/vagrant-libvirt/config.rb', line 32

def username
  @username
end

#uuid ⇒ Object

Domain specific settings used while creating new domain.



66
67
68
 
# File 'lib/vagrant-libvirt/config.rb', line 66

def uuid
  @uuid
end

#video_type ⇒ Object

Returns the value of attribute video_type.



100
101
102
 
# File 'lib/vagrant-libvirt/config.rb', line 100

def video_type
  @video_type
end

#video_vram ⇒ Object

Returns the value of attribute video_vram.



101
102
103
 
# File 'lib/vagrant-libvirt/config.rb', line 101

def video_vram
  @video_vram
end

#volume_cache ⇒ Object

Returns the value of attribute volume_cache.



89
90
91
 
# File 'lib/vagrant-libvirt/config.rb', line 89

def volume_cache
  @volume_cache
end

#watchdog_dev ⇒ Object

Watchdog device



134
135
136
 
# File 'lib/vagrant-libvirt/config.rb', line 134

def watchdog_dev
  @watchdog_dev
end

Instance Method Details

#_generate_numa ⇒ Object 



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/vagrant-libvirt/config.rb', line 312

def _generate_numa
  @numa_nodes.collect { |x|
    # Perform some validation of cpu values
    unless x[:cpus] =~ /^\d+-\d+$/
      raise 'numa_nodes[:cpus] must be in format "integer-integer"'
    end

    # Convert to KiB
    x[:memory] = x[:memory].to_i * 1024
  }

  # Grab the value of the last @numa_nodes[:cpus] and verify @cpus matches
  # Note: [:cpus] is zero based and @cpus is not, so we need to +1
  last_cpu = @numa_nodes.last[:cpus]
  last_cpu = last_cpu.scan(/\d+$/)[0]
  last_cpu = last_cpu.to_i + 1

  if @cpus != last_cpu.to_i
    raise 'The total number of numa_nodes[:cpus] must equal config.cpus'
  end

  @numa_nodes
end

#_generate_uri ⇒ Object

code to generate URI from a config moved out of the connect action



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/vagrant-libvirt/config.rb', line 584

def _generate_uri
  # builds the libvirt connection URI from the given driver config
  # Setup connection uri.
  uri = @driver.dup
  virt_path = case uri
              when 'qemu', 'kvm'
                @qemu_use_session ? '/session' : '/system'
              when 'openvz', 'uml', 'phyp', 'parallels'
                '/system'
              when '@en', 'esx'
                '/'
              when 'vbox', 'vmwarews', 'hyperv'
                '/session'
              else
                raise "Require specify driver #{uri}"
  end
  if uri == 'kvm'
    uri = 'qemu' # use qemu uri for kvm domain type
  end

  if @connect_via_ssh
    uri << '+ssh://'
    uri << @username + '@' if @username

    uri << if @host
             @host
           else
             'localhost'
           end
  else
    uri << '://'
    uri << @host if @host
  end

  uri << virt_path
  uri << '?no_verify=1'

  if @id_ssh_key_file
    # set ssh key for access to libvirt host
    uri << "\&keyfile="
    # if no slash, prepend $HOME/.ssh/
    @id_ssh_key_file.prepend("#{`echo ${HOME}`.chomp}/.ssh/") if @id_ssh_key_file !~ /\A\//
    uri << @id_ssh_key_file
  end
  # set path to libvirt socket
  uri << "\&socket=" + @socket if @socket
  uri
end

#_get_cdrom_dev(cdroms) ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/vagrant-libvirt/config.rb', line 294

def _get_cdrom_dev(cdroms)
  exist = Hash[cdroms.collect { |x| [x[:dev], true] }]
  # hda - hdc
  curr = 'a'.ord
  while curr <= 'd'.ord
    dev = 'hd' + curr.chr
    if exist[dev]
      curr += 1
      next
    else
      return dev
    end
  end

  # is it better to raise our own error, or let libvirt cause the exception?
  raise 'Only four cdroms may be attached at a time'
end

#_get_device(disks) ⇒ Object 



283
284
285
286
287
288
289
290
291
292
 
# File 'lib/vagrant-libvirt/config.rb', line 283

def _get_device(disks)
  # skip existing devices and also the first one (vda)
  exist = disks.collect { |x| x[:device] } + [1.vdev.to_s]
  skip = 1 # we're 1 based, not 0 based...
  loop do
    dev = skip.vdev # get lettered device
    return dev unless exist.include?(dev)
    skip += 1
  end
end

#_handle_cdrom_storage(options = {}) ⇒ Object 



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/vagrant-libvirt/config.rb', line 531

def _handle_cdrom_storage(options = {})
  # <disk type="file" device="cdrom">
  #   <source file="/home/user/virtio-win-0.1-100.iso"/>
  #   <target dev="hdc"/>
  #   <readonly/>
  #   <address type='drive' controller='0' bus='1' target='0' unit='0'/>
  # </disk>
  #
  # note the target dev will need to be changed with each cdrom drive (hdc, hdd, etc),
  # as will the address unit number (unit=0, unit=1, etc)

  options = {
    bus: 'ide',
    path: nil
  }.merge(options)

  cdrom = {
    dev: options[:dev],
    bus: options[:bus],
    path: options[:path]
  }

  @cdroms << cdrom
end

#_handle_disk_storage(options = {}) ⇒ Object 



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/vagrant-libvirt/config.rb', line 556

def _handle_disk_storage(options = {})
  options = {
    type: 'qcow2',
    size: '10G', # matches the fog default
    path: nil,
    bus: 'virtio'
  }.merge(options)

  disk = {
    device: options[:device],
    type: options[:type],
    size: options[:size],
    path: options[:path],
    bus: options[:bus],
    cache: options[:cache] || 'default',
    allow_existing: options[:allow_existing],
    shareable: options[:shareable],
    serial: options[:serial]
  }

  @disks << disk # append
end

#boot(device) ⇒ Object 



279
280
281
 
# File 'lib/vagrant-libvirt/config.rb', line 279

def boot(device)
  @boot_order << device # append
end

#cpu_feature(options = {}) ⇒ Object 



336
337
338
339
340
341
342
343
344
345
 
# File 'lib/vagrant-libvirt/config.rb', line 336

def cpu_feature(options = {})
  if options[:name].nil? || options[:policy].nil?
    raise 'CPU Feature name AND policy must be specified'
  end

  @cpu_features = [] if @cpu_features == UNSET_VALUE

  @cpu_features.push(name:   options[:name],
                     policy: options[:policy])
end

#cputopology(options = {}) ⇒ Object 



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/vagrant-libvirt/config.rb', line 355

def cputopology(options = {})
  if options[:sockets].nil? || options[:cores].nil? || options[:threads].nil?
    raise 'CPU topology must have all of sockets, cores and threads specified'
  end

  if @cpu_topology == UNSET_VALUE
    @cpu_topology = {}
  end

  @cpu_topology[:sockets] = options[:sockets]
  @cpu_topology[:cores] = options[:cores]
  @cpu_topology[:threads] = options[:threads]
end

#finalize! ⇒ Object 



633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/vagrant-libvirt/config.rb', line 633

def finalize!
  @driver = 'kvm' if @driver == UNSET_VALUE
  @host = nil if @host == UNSET_VALUE
  @connect_via_ssh = false if @connect_via_ssh == UNSET_VALUE
  @username = nil if @username == UNSET_VALUE
  @password = nil if @password == UNSET_VALUE
  @id_ssh_key_file = 'id_rsa' if @id_ssh_key_file == UNSET_VALUE
  @storage_pool_name = 'default' if @storage_pool_name == UNSET_VALUE
  @storage_pool_path = nil if @storage_pool_path == UNSET_VALUE
  @random_hostname = false if @random_hostname == UNSET_VALUE
  @management_network_device = 'virbr0' if @management_network_device == UNSET_VALUE
  @management_network_name = 'vagrant-libvirt' if @management_network_name == UNSET_VALUE
  @management_network_address = '192.168.121.0/24' if @management_network_address == UNSET_VALUE
  @management_network_mode = 'nat' if @management_network_mode == UNSET_VALUE
  @management_network_mac = nil if @management_network_mac == UNSET_VALUE
  @management_network_guest_ipv6 = 'yes' if @management_network_guest_ipv6 == UNSET_VALUE
  @management_network_autostart = false if @management_network_autostart == UNSET_VALUE
  @management_network_pci_bus = nil if @management_network_pci_bus == UNSET_VALUE
  @management_network_pci_slot = nil if @management_network_pci_slot == UNSET_VALUE
  @system_uri      = 'qemu:///system' if @system_uri == UNSET_VALUE

  @qemu_use_session = false if @qemu_use_session == UNSET_VALUE

  # generate a URI if none is supplied
  @uri = _generate_uri if @uri == UNSET_VALUE

  # Domain specific settings.
  @uuid = '' if @uuid == UNSET_VALUE
  @memory = 512 if @memory == UNSET_VALUE
  @memory_backing = [] if @memory_backing == UNSET_VALUE
  @cpus = 1 if @cpus == UNSET_VALUE
  @cpu_mode = 'host-model' if @cpu_mode == UNSET_VALUE
  @cpu_model = if (@cpu_model == UNSET_VALUE) && (@cpu_mode == 'custom')
                 'qemu64'
               elsif @cpu_mode != 'custom'
                 ''
               else
                 @cpu_model
    end
  @cpu_topology = {} if @cpu_topology == UNSET_VALUE
  @cpu_fallback = 'allow' if @cpu_fallback == UNSET_VALUE
  @cpu_features = [] if @cpu_features == UNSET_VALUE
  @features = ['acpi','apic','pae'] if @features == UNSET_VALUE
  @features_hyperv = [] if @features_hyperv == UNSET_VALUE
  @numa_nodes = @numa_nodes == UNSET_VALUE ? nil : _generate_numa
  @loader = nil if @loader == UNSET_VALUE
  @nvram = nil if @nvram == UNSET_VALUE
  @machine_type = nil if @machine_type == UNSET_VALUE
  @machine_arch = nil if @machine_arch == UNSET_VALUE
  @machine_virtual_size = nil if @machine_virtual_size == UNSET_VALUE
  @disk_bus = 'virtio' if @disk_bus == UNSET_VALUE
  @disk_device = 'vda' if @disk_device == UNSET_VALUE
  @nic_model_type = nil if @nic_model_type == UNSET_VALUE
  @nested = false if @nested == UNSET_VALUE
  @volume_cache = 'default' if @volume_cache == UNSET_VALUE
  @kernel = nil if @kernel == UNSET_VALUE
  @cmd_line = '' if @cmd_line == UNSET_VALUE
  @initrd = '' if @initrd == UNSET_VALUE
  @dtb = nil if @dtb == UNSET_VALUE
  @graphics_type = 'vnc' if @graphics_type == UNSET_VALUE
  @graphics_autoport = 'yes' if @graphics_port == UNSET_VALUE
  @graphics_autoport = 'no' if @graphics_port != UNSET_VALUE
  if (@graphics_type != 'vnc' && @graphics_type != 'spice') ||
     @graphics_passwd == UNSET_VALUE
    @graphics_passwd = nil
  end
  @graphics_port = -1 if @graphics_port == UNSET_VALUE
  @graphics_ip = '127.0.0.1' if @graphics_ip == UNSET_VALUE
  @video_type = 'cirrus' if @video_type == UNSET_VALUE
  @video_vram = 9216 if @video_vram == UNSET_VALUE
  @sound_type = nil if @sound_type == UNSET_VALUE
  @keymap = 'en-us' if @keymap == UNSET_VALUE
  @kvm_hidden = false if @kvm_hidden == UNSET_VALUE
  @tpm_model = 'tpm-tis' if @tpm_model == UNSET_VALUE
  @tpm_type = 'passthrough' if @tpm_type == UNSET_VALUE
  @tpm_path = nil if @tpm_path == UNSET_VALUE
  @nic_adapter_count = 8 if @nic_adapter_count == UNSET_VALUE
  @emulator_path = nil if @emulator_path == UNSET_VALUE

  # Boot order
  @boot_order = [] if @boot_order == UNSET_VALUE

  # Storage
  @disks = [] if @disks == UNSET_VALUE
  @disks.map! do |disk|
    disk[:device] = _get_device(@disks) if disk[:device].nil?
    disk
  end
  @cdroms = [] if @cdroms == UNSET_VALUE
  @cdroms.map! do |cdrom|
    cdrom[:dev] = _get_cdrom_dev(@cdroms) if cdrom[:dev].nil?
    cdrom
  end

  # Inputs
  @inputs = [{ type: 'mouse', bus: 'ps2' }] if @inputs == UNSET_VALUE

  # Channels
  @channels = [] if @channels == UNSET_VALUE

  # PCI device passthrough
  @pcis = [] if @pcis == UNSET_VALUE

  # Random number generator passthrough
  @rng = {} if @rng == UNSET_VALUE

  # Watchdog device
  @watchdog_dev = {} if @watchdog_dev == UNSET_VALUE

  # USB controller
  @usbctl_dev = {} if @usbctl_dev == UNSET_VALUE

  # USB device passthrough
  @usbs = [] if @usbs == UNSET_VALUE

  # Redirected devices
  @redirdevs = [] if @redirdevs == UNSET_VALUE
  @redirfilters = [] if @redirfilters == UNSET_VALUE

  # smartcard device
  @smartcard_dev = {} if @smartcard_dev == UNSET_VALUE

  # Suspend mode
  @suspend_mode = 'pause' if @suspend_mode == UNSET_VALUE

  # Autostart
  @autostart = false if @autostart == UNSET_VALUE

  # Attach mgmt network
  @mgmt_attach = true if @mgmt_attach == UNSET_VALUE

  @qemu_args = [] if @qemu_args == UNSET_VALUE
end

#hyperv_feature(options = {}) ⇒ Object 



347
348
349
350
351
352
353
 
# File 'lib/vagrant-libvirt/config.rb', line 347

def hyperv_feature(options = {})
  if options[:name].nil? || options[:state].nil?
    raise 'Feature name AND state must be specified'
  end

  @features_hyperv = [{name: options[:name], state: options[:state]}]  if @features_hyperv == UNSET_VALUE
end

#input(options = {}) ⇒ Object 



384
385
386
387
388
389
390
391
392
393
 
# File 'lib/vagrant-libvirt/config.rb', line 384

def input(options = {})
  if options[:type].nil? || options[:bus].nil?
    raise 'Input type AND bus must be specified'
  end

  @inputs = [] if @inputs == UNSET_VALUE

  @inputs.push(type: options[:type],
               bus:  options[:bus])
end

#memorybacking(option, config = {}) ⇒ Object 



369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/vagrant-libvirt/config.rb', line 369

def memorybacking(option, config = {})
  case option
  when :source
    raise 'Source type must be specified' if config[:type].nil?
  when :access
    raise 'Access mode must be specified' if config[:mode].nil?
  when :allocation
    raise 'Allocation mode must be specified' if config[:mode].nil?
  end

  @memory_backing = [] if @memory_backing == UNSET_VALUE
  @memory_backing.push(name: option,
                       config: config)
end

#merge(other) ⇒ Object 



791
792
793
794
795
796
797
798
799
800
801
 
# File 'lib/vagrant-libvirt/config.rb', line 791

def merge(other)
  super.tap do |result|
    c = disks.dup
    c += other.disks
    result.disks = c

    c = cdroms.dup
    c += other.cdroms
    result.cdroms = c
  end
end

#pci(options = {}) ⇒ Object 



427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/vagrant-libvirt/config.rb', line 427

def pci(options = {})
  if options[:bus].nil? || options[:slot].nil? || options[:function].nil?
    raise 'Bus AND slot AND function must be specified. Check `lspci` for that numbers.'
  end

  @pcis = [] if @pcis == UNSET_VALUE

  @pcis.push(bus:       options[:bus],
             slot:      options[:slot],
             function:  options[:function])
end

#qemuargs(options = {}) ⇒ Object 



579
580
581
 
# File 'lib/vagrant-libvirt/config.rb', line 579

def qemuargs(options = {})
  @qemu_args << options if options[:value]
end

#random(options = {}) ⇒ Object 



417
418
419
420
421
422
423
424
425
 
# File 'lib/vagrant-libvirt/config.rb', line 417

def random(options = {})
  if !options[:model].nil? && options[:model] != 'random'
    raise 'The only supported rng backend is "random".'
  end

  @rng = {} if @rng == UNSET_VALUE

  @rng[:model] = options[:model]
end

#redirdev(options = {}) ⇒ Object 



480
481
482
483
484
485
486
 
# File 'lib/vagrant-libvirt/config.rb', line 480

def redirdev(options = {})
  raise 'Type must be specified.' if options[:type].nil?

  @redirdevs = [] if @redirdevs == UNSET_VALUE

  @redirdevs.push(type: options[:type])
end

#redirfilter(options = {}) ⇒ Object 



488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/vagrant-libvirt/config.rb', line 488

def redirfilter(options = {})
  raise 'Option allow must be specified.' if options[:allow].nil?

  @redirfilters = [] if @redirfilters == UNSET_VALUE

  @redirfilters.push(class: options[:class] || -1,
                     vendor: options[:vendor] || -1,
                     product: options[:product] || -1,
                     version: options[:version] || -1,
                     allow: options[:allow])
end

#smartcard(options = {}) ⇒ Object 



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/vagrant-libvirt/config.rb', line 500

def smartcard(options = {})
  if options[:mode].nil?
    raise 'Option mode must be specified.'
  elsif options[:mode] != 'passthrough'
    raise 'Currently only passthrough mode is supported!'
  elsif options[:type] == 'tcp' && (options[:source_mode].nil? || options[:source_host].nil? || options[:source_service].nil?)
    raise 'If using type "tcp", option "source_mode", "source_host" and "source_service" must be specified.'
  end

  if @smartcard_dev == UNSET_VALUE
    @smartcard_dev = {}
  end

  @smartcard_dev[:mode] = options[:mode]
  @smartcard_dev[:type] = options[:type] || 'spicevmc'
  @smartcard_dev[:source_mode] = options[:source_mode] if @smartcard_dev[:type] == 'tcp'
  @smartcard_dev[:source_host] = options[:source_host] if @smartcard_dev[:type] == 'tcp'
  @smartcard_dev[:source_service] = options[:source_service] if @smartcard_dev[:type] == 'tcp'
end

#storage(storage_type, options = {}) ⇒ Object

NOTE: this will run twice for each time it’s needed- keep it idempotent



521
522
523
524
525
526
527
528
529
 
# File 'lib/vagrant-libvirt/config.rb', line 521

def storage(storage_type, options = {})
  if storage_type == :file
    if options[:device] == :cdrom
      _handle_cdrom_storage(options)
    else
      _handle_disk_storage(options)
    end
  end
end

#usb(options = {}) ⇒ Object 



466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/vagrant-libvirt/config.rb', line 466

def usb(options = {})
  if (options[:bus].nil? || options[:device].nil?) && options[:vendor].nil? && options[:product].nil?
    raise 'Bus and device and/or vendor and/or product must be specified. Check `lsusb` for these.'
  end

  @usbs = [] if @usbs == UNSET_VALUE

  @usbs.push(bus:           options[:bus],
             device:        options[:device],
             vendor:        options[:vendor],
             product:       options[:product],
             startupPolicy: options[:startupPolicy])
end

#usb_controller(options = {}) ⇒ Object 



453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/vagrant-libvirt/config.rb', line 453

def usb_controller(options = {})
  if options[:model].nil?
    raise 'USB controller model must be specified.'
  end

  if @usbctl_dev == UNSET_VALUE
      @usbctl_dev = {}
  end

  @usbctl_dev[:model] = options[:model]
  @usbctl_dev[:ports] = options[:ports]
end

#validate(machine) ⇒ Object 



767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
 
# File 'lib/vagrant-libvirt/config.rb', line 767

def validate(machine)
  errors = _detected_errors

  machine.provider_config.disks.each do |disk|
    if disk[:path] && (disk[:path][0] == '/')
      errors << "absolute volume paths like '#{disk[:path]}' not yet supported"
    end
  end

  machine.config.vm.networks.each do |_type, opts|
    if opts[:mac]
      opts[:mac].downcase!
      if opts[:mac] =~ /\A([0-9a-f]{12})\z/
        opts[:mac] = opts[:mac].scan(/../).join(':')
      end
      unless opts[:mac] =~ /\A([0-9a-f]{2}:){5}([0-9a-f]{2})\z/
        errors << "Configured NIC MAC '#{opts[:mac]}' is not in 'xx:xx:xx:xx:xx:xx' or 'xxxxxxxxxxxx' format"
      end
    end
  end

  { 'Libvirt Provider' => errors }
end

#watchdog(options = {}) ⇒ Object 



439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/vagrant-libvirt/config.rb', line 439

def watchdog(options = {})
  if options[:model].nil?
    raise 'Model must be specified.'
  end

  if @watchdog_dev == UNSET_VALUE
      @watchdog_dev = {}
  end

  @watchdog_dev[:model] = options[:model]
  @watchdog_dev[:action] = options[:action] || 'reset'
end