Class: VBox::VirtualBox

Inherits:
Base
  • Object
show all
Defined in:
lib/virtualbox/classes/virtual_box.rb

Instance Attribute Summary

Attributes inherited from Base

#ref

Instance Method Summary collapse

Methods inherited from Base

#_this, #delete!, #ensure_hash, #initialize, #vbox_class

Constructor Details

This class inherits a constructor from VBox::Base

Instance Method Details

#api_version ⇒ Object 



22
23
24
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 22

def api_version
  VBox::WebService.send_request(:i_virtual_box_get_api_version, _this)
end

#check_firmware_present(args = {}) ⇒ Object

Methods



121
122
123
124
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 121

def check_firmware_present(args={})
  ensure_hash args
  VBox::WebService.send_request(:i_virtual_box_check_firmware_present, _this.merge(args))
end

#compose_machine_filename(args = {}) ⇒ Object 



126
127
128
129
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 126

def compose_machine_filename(args={})
  ensure_hash args
  VBox::WebService.send_request(:i_virtual_box_compose_machine_filename, _this.merge(args))
end

#create_appliance ⇒ Object 



131
132
133
134
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 131

def create_appliance
  appliance = VBox::WebService.send_request(:i_virtual_box_create_appliance, _this)
  VBox::Appliance.new(appliance)
end

#create_dhcp_server(args = {}) ⇒ Object 



136
137
138
139
140
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 136

def create_dhcp_server(args={})
  ensure_hash args
  dhcp_server = VBox::WebService.send_request(:i_virtual_box_create_dhcp_server, _this.merge(args))
  VBox::DHCPServer.new(dhcp_server)
end

#create_hard_disk(args = {}) ⇒ Object 



142
143
144
145
146
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 142

def create_hard_disk(args={})
  ensure_hash args
  hard_disk = VBox::WebService.send_request(:i_virtual_box_create_hard_disk, _this.merge(args))
  VBox::Medium.new(hard_disk)
end

#create_machine(args = {}) ⇒ Object 



148
149
150
151
152
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 148

def create_machine(args={})
  ensure_hash args
  machine = VBox::WebService.send_request(:i_virtual_box_create_machine, _this.merge(args))
  VBox::Machine.new(machine)
end

#create_shared_folder(args = {}) ⇒ Object 



154
155
156
157
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 154

def create_shared_folder(args={})
  ensure_hash args
  VBox::WebService.send_request(:i_virtual_box_create_shared_folder, _this.merge(args))
end

#dhcp_servers ⇒ Object 



99
100
101
102
103
104
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 99

def dhcp_servers
  dhcp_servers = VBox::WebService.send_request(:i_virtual_box_get_dhcp_server, _this)
  dhcp_servers.to_a.map do |dhcp_server|
    VBox::DHCPServer.new(dhcp_server)
  end
end

#dvd_images ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 62

def dvd_images
  dvd_images = VBox::WebService.send_request(:i_virtual_box_get_dvd_images, _this)
  dvd_images.to_a.map do |dvd_image|
    VBox::Medium.new(dvd_image)
  end
end

#event_source ⇒ Object 



106
107
108
109
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 106

def event_source
  event_source = VBox::WebService.send_request(:i_virtual_box_get_event_source, _this)
  VBox::EventSource.new(event_source)
end

#find_dhcp_server_by_network_name(args = {}) ⇒ Object 



159
160
161
162
163
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 159

def find_dhcp_server_by_network_name(args={})
  ensure_hash args
  dhcp_server = VBox::WebService.send_request(:i_virtual_box_find_dhcp_server_by_network_name, _this.merge(args))
  VBox::DHCPServer.new(dhcp_server)
end

#find_machine(args = {}) ⇒ Object 



165
166
167
168
169
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 165

def find_machine(args={})
  ensure_hash args
  machine = VBox::WebService.send_request(:i_virtual_box_find_machine, _this.merge(args))
  VBox::Machine.new(machine)
end

#floppy_images ⇒ Object 



69
70
71
72
73
74
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 69

def floppy_images
  floppy_images = VBox::WebService.send_request(:i_virtual_box_get_floppy_images, _this)
  floppy_images.to_a.map do |floppy_image|
    VBox::Medium.new(floppy_image)
  end
end

#generic_network_drivers ⇒ Object 



115
116
117
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 115

def generic_network_drivers
  VBox::WebService.send_request(:i_virtual_box_get_generic_network_drivers, _this)
end

#get_extra_data(args = {}) ⇒ Object 



171
172
173
174
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 171

def get_extra_data(args={})
  ensure_hash args
  VBox::WebService.send_request(:i_virtual_box_get_extra_data, _this.merge(args))
end

#get_extra_data_keys ⇒ Object 



176
177
178
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 176

def get_extra_data_keys
  VBox::WebService.send_request(:i_virtual_box_get_extra_data_keys, _this)
end

#get_guest_os_type(args = {}) ⇒ Object 



180
181
182
183
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 180

def get_guest_os_type(args={})
  ensure_hash args
  VBox::WebService.send_request(:i_virtual_box_get_guest_os_type, _this.merge(args))
end

#get_machine_states(args = {}) ⇒ Object 



185
186
187
188
189
190
191
192
193
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 185

def get_machine_states(args={})
  ensure_hash args
  if args.has_key?(:machines)
    args[:machines].map! do |machine|
      machine.ref
    end
  end
  VBox::WebService.send_request(:i_virtual_box_get_machine_states, _this.merge(args))
end

#get_machines_by_groups(args = {}) ⇒ Object 



195
196
197
198
199
200
201
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 195

def get_machines_by_groups(args={})
  ensure_hash args
  machines = VBox::WebService.send_request(:i_virtual_box_get_machines_by_groups, _this.merge(args))
  machines.to_a.map do |machine|
    VBox::Machine.new(machine)
  end
end

#guest_os_types ⇒ Object 



83
84
85
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 83

def guest_os_types
  VBox::WebService.send_request(:i_virtual_box_get_guest_os_types, _this)
end

#hard_disks ⇒ Object 



55
56
57
58
59
60
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 55

def hard_disks
  hard_disks = VBox::WebService.send_request(:i_virtual_box_get_hard_disks, _this)
  hard_disks.to_a.map do |hard_disk|
    VBox::Medium.new(hard_disk)
  end
end

#home_folder ⇒ Object 



26
27
28
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 26

def home_folder
  VBox::WebService.send_request(:i_virtual_box_get_home_folder, _this)
end

#host ⇒ Object 



34
35
36
37
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 34

def host
  host = VBox::WebService.send_request(:i_virtual_box_get_host, _this)
  VBox::Host.new(host)
end

#internal_networks ⇒ Object 



111
112
113
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 111

def internal_networks
  VBox::WebService.send_request(:i_virtual_box_get_internal_networks, _this)
end

#machine_groups ⇒ Object 



51
52
53
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 51

def machine_groups
  VBox::WebService.send_request(:i_virtual_box_get_machine_groups, _this)
end

#machines ⇒ Object 



44
45
46
47
48
49
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 44

def machines
  machines = VBox::WebService.send_request(:i_virtual_box_get_machines, _this)
  machines.to_a.map do |machine|
    VBox::Machine.new(machine)
  end
end

#open_machine(args = {}) ⇒ Object 



203
204
205
206
207
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 203

def open_machine(args={})
  ensure_hash args
  machine = VBox::WebService.send_request(:i_virtual_box_open_machine, _this.merge(args))
  VBox::Machine.new(machine)
end

#open_medium ⇒ Object 



209
210
211
212
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 209

def open_medium
  medium = VBox::WebService.send_request(:i_virtual_box_open_medium, _this.merge(args))
  VBox::Medium.new(medium)
end

#package_type ⇒ Object 



18
19
20
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 18

def package_type
  VBox::WebService.send_request(:i_virtual_box_get_package_type, _this)
end

#performance_collector ⇒ Object 



94
95
96
97
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 94

def performance_collector
  performance_collector = VBox::WebService.send_request(:i_virtual_box_get_performance_collector, _this)
  VBox::PerformanceCollector.new(performance_collector)
end

#progress_operations ⇒ Object 



76
77
78
79
80
81
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 76

def progress_operations
  progress_operations = VBox::WebService.send_request(:i_virtual_box_get_progress_operations, _this)
  progress_operations.to_a.map do |progress_operation|
    VBox::Progress.new(progress_operation)
  end
end

#register_machine(args = {}) ⇒ Object 



214
215
216
217
218
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 214

def register_machine(args={})
  ensure_hash args
  args[:machine] = args[:machine].ref
  VBox::WebService.send_request(:i_virtual_box_register_machine, _this.merge(args))
end

#remove_dhcp_server(args = {}) ⇒ Object 



220
221
222
223
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 220

def remove_dhcp_server(args={})
  ensure_hash args
  VBox::WebService.send_request(:i_virtual_box_remove_dhcp_server, _this.merge(args))
end

#remove_shared_folder(args = {}) ⇒ Object 



225
226
227
228
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 225

def remove_shared_folder(args={})
  ensure_hash args
  VBox::WebService.send_request(:i_virtual_box_remove_shared_folder, _this.merge(args))
end

#revision ⇒ Object 



14
15
16
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 14

def revision
  VBox::WebService.send_request(:i_virtual_box_get_revision, _this)
end

#set_extra_data(args = {}) ⇒ Object 



230
231
232
233
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 230

def set_extra_data(args={})
  ensure_hash args
  VBox::WebService.send_request(:i_virtual_box_set_extra_data, _this.merge(args))
end

#set_settings_secret(args = {}) ⇒ Object 



235
236
237
238
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 235

def set_settings_secret(args={})
  ensure_hash args
  VBox::WebService.send_request(:i_virtual_box_set_settings_secret, _this.merge(args))
end

#settings_file_path ⇒ Object 



30
31
32
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 30

def settings_file_path
  VBox::WebService.send_request(:i_virtual_box_get_settings_file_path, _this)
end

#shared_folders ⇒ Object 



87
88
89
90
91
92
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 87

def shared_folders
  shared_folders = VBox::WebService.send_request(:i_virtual_box_get_shared_folders, _this)
  shared_folders.to_a.map do |shared_folder|
    VBox::SharedFolder.new(shared_folder)
  end
end

#system_properties ⇒ Object 



39
40
41
42
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 39

def system_properties
  system_properties = VBox::WebService.send_request(:i_virtual_box_get_system_properties, _this)
  VBox::SystemProperties.new(system_properties)
end

#version ⇒ Object

Attributes



6
7
8
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 6

def version
  VBox::WebService.send_request(:i_virtual_box_get_version, _this)
end

#version_normalized ⇒ Object 



10
11
12
 
# File 'lib/virtualbox/classes/virtual_box.rb', line 10

def version_normalized
  VBox::WebService.send_request(:i_virtual_box_get_version_normalized, _this)
end