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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
#!/usr/bin/perl
# $Id: clienttest.pl $
## @file
# This little perl program attempts to connect to a running VirtualBox
# webservice and calls various methods on it. Please refer to the SDK
# programming reference (SDKRef.pdf) for how to use this sample.
#
# Note! The following license applies to this file only
#
#
# Copyright (C) 2008-2023 Oracle and/or its affiliates.
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
use strict;
use SOAP::Lite;
use vboxService; # generated by stubmaker, see SDKRef.pdf
use Data::Dumper;
my $cmd = 'clienttest';
my $optMode;
my $vmname;
my $disk;
while (my $this = shift(@ARGV))
{
if (($this =~ /^-h/) || ($this =~ /^--help/))
{
print "$cmd: test the VirtualBox web service.\n".
"Usage:\n".
" $cmd <mode>\n".
"with <mode> being one of 'version', 'list', 'start'; default is 'list'.\n".
" $cmd version: print version of VirtualBox web service.\n".
" $cmd list: list installed virtual machines.\n".
" $cmd startvm <vm>: start the virtual machine named <vm>.\n".
" $cmd acpipowerbutton <vm>: shutdown of the irtual machine named <vm>.\n";
" $cmd openhd <disk>: open disk image <disk>.\n";
exit 0;
}
elsif ( ($this eq 'version')
|| ($this eq 'list')
)
{
$optMode = $this;
}
elsif ( ($this eq 'startvm')
|| ($this eq 'acpipowerbutton')
)
{
$optMode = $this;
if (!($vmname = shift(@ARGV)))
{
die "[$cmd] Missing parameter: You must specify the name of the VM to start.\nStopped";
}
}
elsif ($this eq 'openhd')
{
$optMode = $this;
if (!($disk = shift(@ARGV)))
{
die "[$cmd] Missing parameter: You must specify the name of the disk to open.\nStopped";
}
}
else
{
die "[$cmd] Unknown option \"$this\"; stopped";
}
}
$optMode = "list"
if (!$optMode);
# SOAP::Lite hacking to make it serialize the enum types we use correctly.
# In the long run, this needs to be done either by stubmaker.pl or something
# else, because the WSDL clearly says they're restricted strings. Quite silly
# that the default behavior is to ignore the parameter and just let the server
# use the default value for the type.
sub SOAP::Serializer::as_LockType
{
my ($self, $value, $name, $type, $attr) = @_;
die "String value expected instead of @{[ref $value]} reference\n"
if ref $value;
return [
$name,
{'xsi:type' => 'vbox:LockType', %$attr},
SOAP::Utils::encode_data($value)
];
}
sub SOAP::Serializer::as_DeviceType
{
my ($self, $value, $name, $type, $attr) = @_;
die "String value expected instead of @{[ref $value]} reference\n"
if ref $value;
return [
$name,
{'xsi:type' => 'vbox:DeviceType', %$attr},
SOAP::Utils::encode_data($value)
];
}
sub SOAP::Serializer::as_AccessMode
{
my ($self, $value, $name, $type, $attr) = @_;
die "String value expected instead of @{[ref $value]} reference\n"
if ref $value;
return [
$name,
{'xsi:type' => 'vbox:AccessMode', %$attr},
SOAP::Utils::encode_data($value)
];
}
## @todo needs much more error handling, e.g. openhd never complains
my $vbox = vboxService->IWebsessionManager_logon("test", "test");
if (!$vbox)
{
die "[$cmd] Logon to session manager with user \"test\" and password \"test\" failed.\nStopped";
}
if ($optMode eq "version")
{
my $v = vboxService->IVirtualBox_getVersion($vbox);
print "[$cmd] Version number of running VirtualBox web service: $v\n";
}
elsif ($optMode eq "list")
{
print "[$cmd] Listing machines:\n";
my @result = vboxService->IVirtualBox_getMachines($vbox);
foreach my $idMachine (@result)
{
my $if = vboxService->IManagedObjectRef_getInterfaceName($idMachine);
my $name = vboxService->IMachine_getName($idMachine);
print "machine $if $idMachine: $name\n";
}
}
elsif ($optMode eq "startvm")
{
my $machine = vboxService->IVirtualBox_findMachine($vbox, $vmname);
die "[$cmd] Cannot find VM \"$vmname\"; stopped"
if (!$machine);
my $session = vboxService->IWebsessionManager_getSessionObject($vbox);
die "[$cmd] Cannot get session object; stopped"
if (!$session);
my $uuid = vboxService->IMachine_getId($machine);
die "[$cmd] Cannot get uuid for machine; stopped"
if (!$uuid);
print "[$cmd] UUID: $uuid\n";
my @env = ();
my $progress = vboxService->IMachine_launchVMProcess($machine,
$session,
"headless",
@env);
die "[$cmd] Cannot launch VM; stopped"
if (!$progress);
print("[$cmd] Waiting for the VM to start...\n");
vboxService->IProgress_waitForCompletion($progress, -1);
my $fCompleted;
$fCompleted = vboxService->IProgress_getCompleted($progress);
print("[$cmd] Completed: $fCompleted\n");
my $resultCode;
$resultCode = vboxService->IProgress_getResultCode($progress);
print("[$cmd] Result: $resultCode\n");
vboxService->ISession_unlockMachine($session);
vboxService->IWebsessionManager_logoff($vbox);
}
elsif ($optMode eq "acpipowerbutton")
{
my $machine = vboxService->IVirtualBox_findMachine($vbox, $vmname);
die "[$cmd] Cannot find VM \"$vmname\"; stopped"
if (!$machine);
my $session = vboxService->IWebsessionManager_getSessionObject($vbox);
die "[$cmd] Cannot get session object; stopped"
if (!$session);
vboxService->IMachine_lockMachine($machine, $session, 'Shared');
my $console = vboxService->ISession_getConsole($session);
vboxService->IConsole_powerButton($console);
vboxService->ISession_unlockMachine($session);
vboxService->IWebsessionManager_logoff($vbox);
}
elsif ($optMode eq "openhd")
{
my $medium = vboxService->IVirtualBox_openMedium($vbox, $disk,
'HardDisk',
'ReadWrite',
0);
}
|
