forked from xapi-project/xapi-project.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
66 lines (63 loc) · 6.49 KB
/
index.html
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
---
layout: base
title: XenAPI Reference
---
<div class="row">
<div class="col-md-9" id="content">
<h2 class="title">XenAPI Classes</h2>
<p>Click on a class to view the associated fields and messages.</p>
<img src="classes.png" alt="Xen-api class diagram" usemap="#graph" border="0" />
<map id="graph" name="graph">
<area shape="poly" href="classes/task.html" title="an asynchronous server-side task" alt="" coords="408,233 406,227 402,222 395,217 387,214 378,213 369,214 360,217 354,222 349,227 348,233 349,240 354,245 360,250 369,252 378,253 387,252 395,250 402,245 406,240"/>
<area shape="poly" href="classes/event.html" title="allows event registration and reading" alt="" coords="408,296 406,289 402,284 395,279 387,277 378,276 369,277 360,279 354,284 349,289 348,296 349,302 354,307 360,312 369,315 378,316 387,315 395,312 402,307 406,302"/>
<area shape="poly" href="classes/pool.html" title="a Resource Pool" alt="" coords="470,78 469,72 464,66 458,62 449,59 440,58 431,59 422,62 416,66 411,72 410,78 411,84 416,90 422,94 431,97 440,98 449,97 458,94 464,90 469,84"/>
<area shape="rect" href="classes/session.html" title="an authenticated session" alt="" coords="92,211,152,251"/>
<area shape="rect" href="classes/user.html" title="a user" alt="" coords="6,201,66,241"/>
<area shape="rect" href="classes/host.html" title="a physical host" alt="" coords="187,223,247,263"/>
<area shape="rect" href="classes/vm.html" title="a Virtual Machine" alt="" coords="508,279,568,319"/>
<area shape="poly" href="classes/vm_metrics.html" title="dynamic VM configuration information" alt="" coords="673,301 671,295 665,289 656,285 644,282 631,281 618,282 607,285 597,289 591,295 589,301 591,307 597,313 607,317 618,320 631,321 644,320 656,317 665,313 671,307"/>
<area shape="poly" href="classes/vm_guest_metrics.html" title="dynamic information from inside the guest" alt="" coords="670,360 667,354 658,348 645,344 628,341 610,340 592,341 575,344 562,348 553,354 550,360 553,366 562,372 575,376 592,379 610,380 628,379 645,376 658,372 667,366"/>
<area shape="poly" href="classes/crashdump.html" title="VM crashdump" alt="" coords="650,246 648,239 642,234 633,229 622,227 609,226 596,227 585,229 576,234 570,239 568,246 570,252 576,257 585,262 596,265 609,266 622,265 633,262 642,257 648,252"/>
<area shape="poly" href="classes/console.html" title="location information for a guest's console" alt="" coords="590,387 589,380 584,375 577,370 569,368 559,367 549,368 540,370 533,375 529,380 527,387 529,393 533,398 540,403 549,406 559,407 569,406 577,403 584,398 589,393"/>
<area shape="rect" href="classes/pbd.html" title="the connection between an SR and a host" alt="" coords="244,147,304,187"/>
<area shape="poly" href="classes/host_metrics.html" title="dynamic host information" alt="" coords="202,307 199,300 193,295 183,290 170,288 156,287 141,288 128,290 118,295 112,300 109,307 112,313 118,318 128,323 141,326 156,327 170,326 183,323 193,318 199,313"/>
<area shape="poly" href="classes/host_cpu.html" title="a physical CPU on a host" alt="" coords="206,164 204,158 199,153 191,148 182,145 171,144 160,145 151,148 143,153 138,158 136,164 138,171 143,176 151,181 160,183 171,184 182,183 191,181 199,176 204,171"/>
<area shape="rect" href="classes/network.html" title="an ethernet network" alt="" coords="331,331,391,371"/>
<area shape="rect" href="classes/vif.html" title="a network interface for a Virtual Machine" alt="" coords="423,334,483,374"/>
<area shape="poly" href="classes/vif_metrics.html" title="IO stats and configuration information for a virtual interface" alt="" coords="498,451 496,445 490,439 481,435 470,432 457,431 444,432 432,435 423,439 417,445 415,451 417,457 423,463 432,467 444,470 457,471 470,470 481,467 490,463 496,457"/>
<area shape="rect" href="classes/pif.html" title="a network interface for a physical host" alt="" coords="241,306,301,346"/>
<area shape="poly" href="classes/pif_metrics.html" title="IO stats and configuration information for a physical interface" alt="" coords="274,412 272,406 266,400 257,396 245,393 232,392 219,393 208,396 198,400 193,406 191,412 193,418 198,424 208,428 219,431 232,432 245,431 257,428 266,424 272,418"/>
<area shape="rect" href="classes/sr.html" title="Storage Repository, a container for virtual disk images (VDIs)" alt="" coords="323,97,383,137"/>
<area shape="rect" href="classes/vdi.html" title="a virtual disk image" alt="" coords="412,124,472,164"/>
<area shape="poly" href="classes/sm.html" title="storage manager plugin module" alt="" coords="377,26 375,19 371,14 364,9 356,7 347,6 337,7 329,9 322,14 318,19 317,26 318,32 322,37 329,42 337,45 347,46 356,45 364,42 371,37 375,32"/>
<area shape="rect" href="classes/vbd.html" title="a virtual block device" alt="" coords="486,181,546,221"/>
<area shape="poly" href="classes/vbd_metrics.html" title="IO stats and configuration information for a virtual block device" alt="" coords="623,128 620,122 614,116 604,112 592,109 578,108 564,109 551,112 541,116 535,122 533,128 535,134 541,140 551,144 564,147 578,148 592,147 604,144 614,140 620,134"/>
</map>
<h2>Classes, Fields and Messages</h2>
<p>Classes have both <i>fields</i> and <i>messages.</i> Messages are either <i>implicit</i> or <i>explicit</i> where an implicit message is one of:</p>
<ul>
<li> a constructor (usually called "create");</li>
<li> a destructor (usually called "destroy");</li>
<li> "get_by_name_label";</li>
<li> "get_by_uuid"</li>
<li> "get_record"; and</li>
<li> "get_all".</li>
</ul>
<p>Explicit messages include all the rest, more class-specific messages (e.g. "VM.start", "VM.clone")</p>
<p>Every field has at least one <i>accessor</i> depending both on its type and whether it is read-only or read-write. Accessors for a field named "X" would be a proper subset of:</p>
<ul>
<li> set_X: change the value of field X (only if it is read-write);</li>
<li> get_X: retrieve the value of field X;</li>
<li> add_to_X: add a key/value pair (only if field has type set or map); and</li>
<li> remove_from_X: remove a key (only if a field has type set or map).</li>
</ul>
</div>
<div class="col-md-3" id="sidebar">
<h2 class="title">Classes</h2>
<div id="class_overview"><a href="{{ site.baseurl }}/xen-api/index.html">Overview</a></div>
{% assign classes = site.pages | where:"class_index",true %}
{% for c in classes %}
<a href="{{ site.baseurl }}{{ c.url }}">{{ c.class }}</a><br/>
{% endfor %}
</div>
</div>