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

#initializeConfig

Returns a new instance of Config.



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
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
# File 'lib/vagrant-libvirt/config.rb', line 144

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_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

  # Domain specific settings.
  @uuid              = UNSET_VALUE
  @memory            = UNSET_VALUE
  @cpus              = UNSET_VALUE
  @cpu_mode          = UNSET_VALUE
  @cpu_model         = UNSET_VALUE
  @cpu_fallback      = UNSET_VALUE
  @cpu_features      = UNSET_VALUE
  @features          = UNSET_VALUE
  @numa_nodes        = UNSET_VALUE
  @loader            = 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 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
end

Instance Attribute Details

#autostartObject

Autostart



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

def autostart
  @autostart
end

#boot_orderObject

Returns the value of attribute boot_order.



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

def boot_order
  @boot_order
end

#cdromsObject

Returns the value of attribute cdroms.



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

def cdroms
  @cdroms
end

#channel(options = {}) ⇒ Object

Returns the value of attribute channel.



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

def channel
  @channel
end

#channelsObject

Channels



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

def channels
  @channels
end

#cmd_lineObject

Returns the value of attribute cmd_line.



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

def cmd_line
  @cmd_line
end

#connect_via_sshObject

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_fallbackObject

Returns the value of attribute cpu_fallback.



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

def cpu_fallback
  @cpu_fallback
end

#cpu_featuresObject

Returns the value of attribute cpu_features.



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

def cpu_features
  @cpu_features
end

#cpu_modeObject

Returns the value of attribute cpu_mode.



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

def cpu_mode
  @cpu_mode
end

#cpu_modelObject

Returns the value of attribute cpu_model.



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

def cpu_model
  @cpu_model
end

#cpusObject

Returns the value of attribute cpus.



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

def cpus
  @cpus
end

#default_prefixObject

Default host prefix (alternative to use project folder name)



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

def default_prefix
  @default_prefix
end

#disk_busObject

Returns the value of attribute disk_bus.



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

def disk_bus
  @disk_bus
end

#disk_deviceObject

Returns the value of attribute disk_device.



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

def disk_device
  @disk_device
end

#disksObject

Storage



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

def disks
  @disks
end

#driverObject

A hypervisor name to access via Libvirt.



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

def driver
  @driver
end

#dtbObject

Returns the value of attribute dtb.



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

def dtb
  @dtb
end

#emulator_pathObject

Returns the value of attribute emulator_path.



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

def emulator_path
  @emulator_path
end

#featuresObject

Returns the value of attribute features.



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

def features
  @features
end

#graphics_autoportObject

Returns the value of attribute graphics_autoport.



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

def graphics_autoport
  @graphics_autoport
end

#graphics_ipObject

Returns the value of attribute graphics_ip.



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

def graphics_ip
  @graphics_ip
end

#graphics_passwdObject

Returns the value of attribute graphics_passwd.



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

def graphics_passwd
  @graphics_passwd
end

#graphics_portObject

Returns the value of attribute graphics_port.



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

def graphics_port
  @graphics_port
end

#graphics_typeObject

Returns the value of attribute graphics_type.



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

def graphics_type
  @graphics_type
end

#hostObject

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_fileObject

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

#initrdObject

Returns the value of attribute initrd.



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

def initrd
  @initrd
end

#inputsObject

Inputs



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

def inputs
  @inputs
end

#kernelObject

Returns the value of attribute kernel.



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

def kernel
  @kernel
end

#keymapObject

Returns the value of attribute keymap.



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

def keymap
  @keymap
end

#kvm_hiddenObject

Returns the value of attribute kvm_hidden.



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

def kvm_hidden
  @kvm_hidden
end

#loaderObject

Returns the value of attribute loader.



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

def loader
  @loader
end

#machine_archObject

Returns the value of attribute machine_arch.



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

def machine_arch
  @machine_arch
end

#machine_typeObject

Returns the value of attribute machine_type.



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

def machine_type
  @machine_type
end

#machine_virtual_sizeObject

Returns the value of attribute machine_virtual_size.



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

def machine_virtual_size
  @machine_virtual_size
end

#management_network_addressObject

Returns the value of attribute management_network_address.



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

def management_network_address
  @management_network_address
end

#management_network_autostartObject

Returns the value of attribute management_network_autostart.



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

def management_network_autostart
  @management_network_autostart
end

#management_network_guest_ipv6Object

Returns the value of attribute management_network_guest_ipv6.



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

def management_network_guest_ipv6
  @management_network_guest_ipv6
end

#management_network_macObject

Returns the value of attribute management_network_mac.



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

def management_network_mac
  @management_network_mac
end

#management_network_modeObject

Returns the value of attribute management_network_mode.



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

def management_network_mode
  @management_network_mode
end

#management_network_nameObject

Libvirt default network



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

def management_network_name
  @management_network_name
end

#memoryObject

Returns the value of attribute memory.



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

def memory
  @memory
end

#mgmt_attachObject

Attach mgmt network



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

def mgmt_attach
  @mgmt_attach
end

#nestedObject

Returns the value of attribute nested.



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

def nested
  @nested
end

#nic_adapter_countObject

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



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

def nic_adapter_count
  @nic_adapter_count
end

#nic_model_typeObject

Returns the value of attribute nic_model_type.



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

def nic_model_type
  @nic_model_type
end

#numa_nodesObject

Returns the value of attribute numa_nodes.



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

def numa_nodes
  @numa_nodes
end

#passwordObject

Password for Libvirt connection.



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

def password
  @password
end

#pcisObject

PCI device passthrough



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

def pcis
  @pcis
end

#random_hostnameObject

Turn on to prevent hostname conflicts



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

def random_hostname
  @random_hostname
end

#redirdevsObject

Redirected devices



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

def redirdevs
  @redirdevs
end

#redirfiltersObject

Returns the value of attribute redirfilters.



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

def redirfilters
  @redirfilters
end

#rngObject

Random number device passthrough



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

def rng
  @rng
end

#smartcard_devObject

smartcard device



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

def smartcard_dev
  @smartcard_dev
end

#socketObject

Path towards the libvirt socket



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

def socket
  @socket
end

#sound_typeObject

Returns the value of attribute sound_type.



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

def sound_type
  @sound_type
end

#storage_pool_nameObject

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

#suspend_modeObject

Suspend mode



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

def suspend_mode
  @suspend_mode
end

#tpm_modelObject

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



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

def tpm_model
  @tpm_model
end

#tpm_pathObject

Returns the value of attribute tpm_path.



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

def tpm_path
  @tpm_path
end

#tpm_typeObject

Returns the value of attribute tpm_type.



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

def tpm_type
  @tpm_type
end

#uriObject

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

#usbsObject

USB device passthrough



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

def usbs
  @usbs
end

#usernameObject

The username to access Libvirt.



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

def username
  @username
end

#uuidObject

Domain specific settings used while creating new domain.



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

def uuid
  @uuid
end

#video_typeObject

Returns the value of attribute video_type.



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

def video_type
  @video_type
end

#video_vramObject

Returns the value of attribute video_vram.



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

def video_vram
  @video_vram
end

#volume_cacheObject

Returns the value of attribute volume_cache.



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

def volume_cache
  @volume_cache
end

#watchdog_devObject

Watchdog device



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

def watchdog_dev
  @watchdog_dev
end

Instance Method Details

#_generate_numaObject



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
# File 'lib/vagrant-libvirt/config.rb', line 276

def _generate_numa
  raise 'NUMA nodes must be a factor of CPUs' if @cpus % @numa_nodes != 0

  if @memory % @numa_nodes != 0
    raise 'NUMA nodes must be a factor of memory'
  end

  numa = []

  (1..@numa_nodes).each do |node|
    numa_cpu_start = (@cpus / @numa_nodes) * (node - 1)
    numa_cpu_end = (@cpus / @numa_nodes) * node - 1
    numa_cpu = Array(numa_cpu_start..numa_cpu_end).join(',')
    numa_mem = @memory / @numa_nodes

    numa.push(id: node,
              cpu: numa_cpu,
              mem: numa_mem)
  end

  @numa_nodes = numa
end

#_generate_uriObject

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



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
# File 'lib/vagrant-libvirt/config.rb', line 493

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', 'openvz', 'uml', 'phyp', 'parallels', 'kvm'
                '/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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/vagrant-libvirt/config.rb', line 258

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



247
248
249
250
251
252
253
254
255
256
# File 'lib/vagrant-libvirt/config.rb', line 247

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



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
# File 'lib/vagrant-libvirt/config.rb', line 444

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



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
# File 'lib/vagrant-libvirt/config.rb', line 469

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



243
244
245
# File 'lib/vagrant-libvirt/config.rb', line 243

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

#cpu_feature(options = {}) ⇒ Object



299
300
301
302
303
304
305
306
307
308
# File 'lib/vagrant-libvirt/config.rb', line 299

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

#finalize!Object



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
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
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
# File 'lib/vagrant-libvirt/config.rb', line 540

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
  @random_hostname = false if @random_hostname == 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

  # 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
  @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'
                 ''
    end
  @cpu_fallback = 'allow' if @cpu_fallback == UNSET_VALUE
  @cpu_features = [] if @cpu_features == UNSET_VALUE
  @features = ['acpi','apic','pae'] if @features == UNSET_VALUE
  @numa_nodes = @numa_nodes == UNSET_VALUE ? nil : _generate_numa
  @loader = nil if @loader == 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 = 5900 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 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
end

#input(options = {}) ⇒ Object



310
311
312
313
314
315
316
317
318
319
# File 'lib/vagrant-libvirt/config.rb', line 310

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

#merge(other) ⇒ Object



674
675
676
677
678
679
680
681
682
683
# File 'lib/vagrant-libvirt/config.rb', line 674

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



353
354
355
356
357
358
359
360
361
362
363
# File 'lib/vagrant-libvirt/config.rb', line 353

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

#random(options = {}) ⇒ Object



343
344
345
346
347
348
349
350
351
# File 'lib/vagrant-libvirt/config.rb', line 343

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



393
394
395
396
397
398
399
# File 'lib/vagrant-libvirt/config.rb', line 393

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



401
402
403
404
405
406
407
408
409
410
411
# File 'lib/vagrant-libvirt/config.rb', line 401

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[:class] || -1,
                     product: options[:class] || -1,
                     version: options[:class] || -1,
                     allow: options[:allow])
end

#smartcard(options = {}) ⇒ Object



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
# File 'lib/vagrant-libvirt/config.rb', line 413

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



434
435
436
437
438
439
440
441
442
# File 'lib/vagrant-libvirt/config.rb', line 434

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



379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/vagrant-libvirt/config.rb', line 379

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

#validate(machine) ⇒ Object



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
# File 'lib/vagrant-libvirt/config.rb', line 656

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! && !(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' format"
    end
  end

  { 'Libvirt Provider' => errors }
end

#watchdog(options = {}) ⇒ Object



365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/vagrant-libvirt/config.rb', line 365

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