/
Vm.java
388 lines (347 loc) · 10.2 KB
/
Vm.java
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
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
/*
Copyright (c) 2015-2016 Red Hat, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package types;
import org.ovirt.api.metamodel.annotations.Link;
import org.ovirt.api.metamodel.annotations.Type;
import java.util.Date;
/**
* Represents a virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Type
public interface Vm extends VmBase {
/**
* The current status of the virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
VmStatus status();
/**
* Human readable detail of current status.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
String statusDetail();
/**
* The reason the virtual machine was stopped.
* Optionally set by user when shutting down the virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
String stopReason();
/**
* The date in which the virtual machine was started.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
Date startTime();
/**
* The date in which the virtual machine was stopped.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
Date stopTime();
/**
* If `true`, the virtual machine has been started using the _run once_ command, meaning
* it's configuration might differ from the stored one for the purpose of this single run.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
Boolean runOnce();
/**
* Optional payloads of the virtual machine, used for ISOs to configure it.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
Payload[] payloads();
/**
* Fully qualified domain name of the virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
String fqdn();
/**
* If `true`, the virtual machine is reconfigured to the latest version of it's template when it is started.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
Boolean useLatestTemplateVersion();
/**
* Virtual machine configuration has been changed and requires restart of the virtual machine.
* Changed configuration is applied at processing the virtual machine's _shut down_.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
Boolean nextRunConfigurationExists();
/**
* How the NUMA topology is applied.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
NumaTuneMode numaTuneMode();
/**
* What time zone is used by the virtual machine (as returned by guest agent).
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
TimeZone guestTimeZone();
/**
* What operating system is installed on the virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
GuestOperatingSystem guestOperatingSystem();
/**
* Indicates whether the virtual machine has snapshots with disks in `ILLEGAL` state.
*
* @author Ala Hino <ahino@redhat.com>
* @author Tahlia Richardson <trichard@redhat.com>
* @date 11 Aug 2017
* @status updated_by_docs
* @since 4.1.9
*/
Boolean hasIllegalImages();
/**
* Reference to the host the virtual machine is running on.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link Host host();
/**
* Reference to the template the virtual machine is based on.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link Template template();
/**
* References the original template used to create the virtual machine.
*
* If the virtual machine is cloned from a template or another virtual machine,
* the `template` links to the Blank template, and the `original_template`
* is used to track history.
*
* Otherwise the `template` and `original_template` are the same.
*
* @author Marek Libra <mlibra@redhat.com>
* @author Byron Gravenorst <bgraveno@redhat.com>
* @date 02 Dec 2016
* @status updated_by_docs
*/
@Link Template originalTemplate();
/**
* The virtual machine configuration can be optionally predefined via one of the instance types.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link InstanceType instanceType();
/**
* References the list of network interface devices on the virtual machine.
*
* @author Martin Mucha <mmucha@redhat.com>
* @author Byron Gravenorst <bgraveno@redhat.com>
* @date 02 Dec 2016
* @status updated_by_docs
*/
@Link Nic[] nics();
/**
* Refers to all snapshots taken from the virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link Snapshot[] snapshots();
/**
* Reference to the pool the virtual machine is optionally member of.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link VmPool vmPool();
/**
* Reference to the ISO mounted to the CDROM.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link Cdrom[] cdroms();
/**
* Reference to the ISO mounted to the floppy.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link Floppy[] floppies();
@Link ReportedDevice[] reportedDevices();
/**
* Refers to the Watchdog configuration.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link Watchdog[] watchdogs();
/**
* Permissions set for this virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link Permission[] permissions();
@Link ExternalHostProvider externalHostProvider();
/**
* Optional. Used for labeling of sub-clusters.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link AffinityLabel[] affinityLabels();
/**
* List of applications installed on the virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link Application[] applications();
/**
* List of graphics consoles configured for this virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link GraphicsConsole[] graphicsConsoles();
/**
* References devices associated to this virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link HostDevice[] hostDevices();
/**
* Lists all the Katello errata assigned to the virtual machine.
*
* [source]
* ----
* GET /ovirt-engine/api/vms/123/katelloerrata
* ----
*
* You will receive response in XML like this one:
*
* [source,xml]
* ----
* <katello_errata>
* <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
* <name>RHBA-2013:XYZ</name>
* <description>The description of the erratum</description>
* <title>some bug fix update</title>
* <type>bugfix</type>
* <issued>2013-11-20T02:00:00.000+02:00</issued>
* <solution>Few guidelines regarding the solution</solution>
* <summary>Updated packages that fix one bug are now available for XYZ</summary>
* <packages>
* <package>
* <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
* </package>
* ...
* </packages>
* </katello_erratum>
* ...
* </katello_errata>
* ----
*
* @author Moti Asayag <masayag@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link KatelloErratum[] katelloErrata();
/**
* Refers to the NUMA Nodes configuration used by this virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link NumaNode[] numaNodes();
/**
* List of user sessions opened for this virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link Session[] sessions();
/**
* Statistics data collected from this virtual machine.
*
* Note that some statistics, notably `memory.buffered` and `memory.cached`
* are available only when https://www.ovirt.org/documentation/vmm-guide/chap-Installing_Linux_Virtual_Machines.html#installing-guest-agents-and-drivers[oVirt guest agent]
* is installed in the virtual machine.
*
* @author Marek Libra <mlibra@redhat.com>
* @date 12 Dec 2016
* @status added
*/
@Link Statistic[] statistics();
@Link Tag[] tags();
/**
* References the disks attached to the virtual machine.
*
* @author Byron Gravenorst <bgraveno@redhat.com>
* @date 02 Dec 2016
* @status updated_by_docs
*/
@Link DiskAttachment[] diskAttachments();
}