root / doc / api / api.html @ c1664c6ec064c44dfe78ff6800a6cf3e2f358fc0

View | Annotate | Download (81.5 KB)

1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4
        <head>
5
            <title>src.ielo.net - Zinn XMLRPC API 1.0.0 Documentation</title>
6
            <meta http-equiv="content-type" content="text/html; charset=utf-8" />
7
            <meta name="description" content="Zinn XMLRPC API Documentation" />
8
        </head>
9
        <body>
10
                <style type="text/css">
11
                .method {
12
                    background-color:#EEEEFF;
13
                    border:2px solid #CCCCCC;
14
                    border-collapse:collapse;
15
                    margin:1em;
16
                    padding:1em;
17
                }
18
                div.proto {
19
                    font-size: 120%;
20
                }
21
                div.proto, div.description {
22
                    background-color: #FFFFDD;
23
                    line-height: 1.5em;
24
                }
25
                div.see {
26
                    background-color: #fff;
27
                }
28
                div.proto, div.description, div.see {
29
                    border:1px dotted #ccc;
30
                    padding:0.5em;
31
                    margin-bottom:1em;
32
                }
33
                div.parameters {
34
                    border:1px solid transparent;
35
                    padding:0.5em;
36
                    margin-bottom:1em;
37
                }
38
                .methodname, .param {
39
                    font-weight:bold;
40
                }
41
                span.type {
42
                        font-style:italic;
43
                }
44
45
                a.indexA {
46
                    float: right;
47
                    border: 1px solid #ccc;
48
                    background-color: #507AAA;
49
                    color: #fff;
50
                    padding: 0.5em;
51
                }
52
                div.parameters span.param {
53
                    display:block;
54
                    text-indent:-2em;
55
                }
56
                #index {
57
                    float:left;
58
                    width:100%;
59
                }
60
                #index div {
61
                    width: 25em;
62
                    float: left;
63
                    margin-right:2em;
64
                }
65
                #index p {
66
                    padding: 0.3em;
67
                    border: 1px inset #666;
68
                    background-color: #999;
69
                    color:#fff;
70
                }
71
                div.method h4 {
72
                        font-size: 140%;
73
                }
74
                #index ul {
75
                        padding-left:2em;
76
                }
77
                .parameters ul, div.see ul, #index ul {
78
                    list-style-type:none;
79
                }
80
                .parameters ul li {
81
                    padding:1em;
82
                }
83
                </style>
84
                <h2>Zinn XMLRPC API 1.0.0</h2>
85
                <div id="index">
86
                    <h3>Methods Index</h3>
87
                        <div>
88
        <p class="indexLetter"><strong>A</strong></p><ul>
89
        <li><a href="#api.version">api.version</a></li></ul>
90
    </div>    <div>
91
        <p class="indexLetter"><strong>C</strong></p><ul>
92
        <li><a href="#client.accounting">client.accounting</a></li>
93
        <li><a href="#client.attributes">client.attributes</a></li>
94
        <li><a href="#client.create">client.create</a></li>
95
        <li><a href="#client.delete">client.delete</a></li>
96
        <li><a href="#client.invitation.acknowledge">client.invitation.acknowledge</a></li>
97
        <li><a href="#client.invitation.create">client.invitation.create</a></li>
98
        <li><a href="#client.invitation.list">client.invitation.list</a></li>
99
        <li><a href="#client.list">client.list</a></li>
100
        <li><a href="#client.update">client.update</a></li></ul>
101
    </div>    <div>
102
        <p class="indexLetter"><strong>I</strong></p><ul>
103
        <li><a href="#image.accounting">image.accounting</a></li>
104
        <li><a href="#image.attributes">image.attributes</a></li>
105
        <li><a href="#image.create">image.create</a></li>
106
        <li><a href="#image.delete">image.delete</a></li>
107
        <li><a href="#image.list">image.list</a></li>
108
        <li><a href="#image.update">image.update</a></li>
109
        <li><a href="#interface.accounting">interface.accounting</a></li>
110
        <li><a href="#interface.attributes">interface.attributes</a></li>
111
        <li><a href="#interface.create">interface.create</a></li>
112
        <li><a href="#interface.delete">interface.delete</a></li>
113
        <li><a href="#interface.ipaddress.attach">interface.ipaddress.attach</a></li>
114
        <li><a href="#interface.ipaddress.detach">interface.ipaddress.detach</a></li>
115
        <li><a href="#interface.ipaddress.list">interface.ipaddress.list</a></li>
116
        <li><a href="#interface.list">interface.list</a></li>
117
        <li><a href="#interface.types.list">interface.types.list</a></li>
118
        <li><a href="#interface.update">interface.update</a></li>
119
        <li><a href="#ipaddress.accounting">ipaddress.accounting</a></li>
120
        <li><a href="#ipaddress.attributes">ipaddress.attributes</a></li>
121
        <li><a href="#ipaddress.create">ipaddress.create</a></li>
122
        <li><a href="#ipaddress.delete">ipaddress.delete</a></li>
123
        <li><a href="#ipaddress.list">ipaddress.list</a></li>
124
        <li><a href="#ipaddress.update">ipaddress.update</a></li></ul>
125
    </div>    <div>
126
        <p class="indexLetter"><strong>M</strong></p><ul>
127
        <li><a href="#machine.accounting">machine.accounting</a></li>
128
        <li><a href="#machine.attributes">machine.attributes</a></li>
129
        <li><a href="#machine.boot">machine.boot</a></li>
130
        <li><a href="#machine.cputype.list">machine.cputype.list</a></li>
131
        <li><a href="#machine.create">machine.create</a></li>
132
        <li><a href="#machine.delete">machine.delete</a></li>
133
        <li><a href="#machine.interface.attach">machine.interface.attach</a></li>
134
        <li><a href="#machine.interface.detach">machine.interface.detach</a></li>
135
        <li><a href="#machine.interface.list">machine.interface.list</a></li>
136
        <li><a href="#machine.list">machine.list</a></li>
137
        <li><a href="#machine.migrate">machine.migrate</a></li>
138
        <li><a href="#machine.shutdown">machine.shutdown</a></li>
139
        <li><a href="#machine.storage.attach">machine.storage.attach</a></li>
140
        <li><a href="#machine.storage.bustype.list">machine.storage.bustype.list</a></li>
141
        <li><a href="#machine.storage.detach">machine.storage.detach</a></li>
142
        <li><a href="#machine.storage.list">machine.storage.list</a></li>
143
        <li><a href="#machine.update">machine.update</a></li>
144
        <li><a href="#machine.vnc.keymap.list">machine.vnc.keymap.list</a></li></ul>
145
    </div>    <div>
146
        <p class="indexLetter"><strong>P</strong></p><ul>
147
        <li><a href="#permission.list">permission.list</a></li></ul>
148
    </div>    <div>
149
        <p class="indexLetter"><strong>S</strong></p><ul>
150
        <li><a href="#sitegroup.list">sitegroup.list</a></li>
151
        <li><a href="#storage.accounting">storage.accounting</a></li>
152
        <li><a href="#storage.attributes">storage.attributes</a></li>
153
        <li><a href="#storage.clone">storage.clone</a></li>
154
        <li><a href="#storage.clone_config">storage.clone_config</a></li>
155
        <li><a href="#storage.clone_data">storage.clone_data</a></li>
156
        <li><a href="#storage.create">storage.create</a></li>
157
        <li><a href="#storage.delete">storage.delete</a></li>
158
        <li><a href="#storage.list">storage.list</a></li>
159
        <li><a href="#storage.update">storage.update</a></li>
160
        <li><a href="#system.listMethods">system.listMethods</a></li>
161
        <li><a href="#system.methodHelp">system.methodHelp</a></li>
162
        <li><a href="#system.methodSignature">system.methodSignature</a></li></ul>
163
    </div>    <div>
164
        <p class="indexLetter"><strong>R</strong></p><ul>
165
        <li><a href="#role.accounting">role.accounting</a></li>
166
        <li><a href="#role.attributes">role.attributes</a></li>
167
        <li><a href="#role.create">role.create</a></li>
168
        <li><a href="#role.delete">role.delete</a></li>
169
        <li><a href="#role.list">role.list</a></li>
170
        <li><a href="#role.permission.attach">role.permission.attach</a></li>
171
        <li><a href="#role.permission.detach">role.permission.detach</a></li>
172
        <li><a href="#role.permission.list">role.permission.list</a></li>
173
        <li><a href="#role.update">role.update</a></li>
174
        <li><a href="#role.user.attach">role.user.attach</a></li>
175
        <li><a href="#role.user.attributes">role.user.attributes</a></li>
176
        <li><a href="#role.user.detach">role.user.detach</a></li>
177
        <li><a href="#role.user.list">role.user.list</a></li>
178
        <li><a href="#role.user.update">role.user.update</a></li></ul>
179
    </div>    <div>
180
        <p class="indexLetter"><strong>U</strong></p><ul>
181
        <li><a href="#user.list">user.list</a></li></ul>
182
    </div>    <div>
183
        <p class="indexLetter"><strong>V</strong></p><ul>
184
        <li><a href="#vlan.accounting">vlan.accounting</a></li>
185
        <li><a href="#vlan.attributes">vlan.attributes</a></li>
186
        <li><a href="#vlan.create">vlan.create</a></li>
187
        <li><a href="#vlan.delete">vlan.delete</a></li>
188
        <li><a href="#vlan.get_next_tag">vlan.get_next_tag</a></li>
189
        <li><a href="#vlan.interface.attach">vlan.interface.attach</a></li>
190
        <li><a href="#vlan.interface.detach">vlan.interface.detach</a></li>
191
        <li><a href="#vlan.interface.list">vlan.interface.list</a></li>
192
        <li><a href="#vlan.is_tag_free">vlan.is_tag_free</a></li>
193
        <li><a href="#vlan.list">vlan.list</a></li>
194
        <li><a href="#vlan.update">vlan.update</a></li>
195
        <li><a href="#vsite.attributes">vsite.attributes</a></li>
196
        <li><a href="#vsite.create">vsite.create</a></li>
197
        <li><a href="#vsite.delete">vsite.delete</a></li>
198
        <li><a href="#vsite.list">vsite.list</a></li></ul>
199
    </div>
200
                </div>
201
                <div id="methods">
202
                    <h3>Methods List</h3>
203
                    <div class="method" id="api.version">
204
    <a class="indexA" href="#index">go to index</a>
205
    <h4>api.version</h4>
206
    <div class="proto">
207
        <span class="type">string</span>
208
        <span class="methodname">api.version</span>()
209
    </div>
210
    <div class="parameters">
211
    <strong>Parameters</strong>
212
    <ul></ul>
213
</div>
214
    <div class="description">
215
        <p><strong>Description</strong></p>
216
        <p>Get the API version.<br/></p>
217
    </div>
218
    
219
    
220
</div>
221
<div class="method" id="client.accounting">
222
    <a class="indexA" href="#index">go to index</a>
223
    <h4>client.accounting</h4>
224
    <div class="proto">
225
        <span class="type">none</span>
226
        <span class="methodname">client.accounting</span>()
227
    </div>
228
    
229
    <div class="description">
230
        <p><strong>Description</strong></p>
231
        <p><br/></p>
232
    </div>
233
    
234
    
235
</div>
236
<div class="method" id="client.attributes">
237
    <a class="indexA" href="#index">go to index</a>
238
    <h4>client.attributes</h4>
239
    <div class="proto">
240
        <span class="type">array</span>
241
        <span class="methodname">client.attributes</span>(<span class="type">bool</span>  onlyMutables)
242
    </div>
243
    <div class="parameters">
244
    <strong>Parameters</strong>
245
    <ul><li><span class="param"> onlyMutables</span> bool (optionnal) filters (un)mutable attributes. default=False.</li></ul>
246
</div>
247
    <div class="description">
248
        <p><strong>Description</strong></p>
249
        <p>List of attributes of a client.<br/><br/>        possible attributes are :<ul><li><span class="param">label</span> : unmutable, string the client label.</li><li><span class="param">address</span> : mutable, string the client postal address.</li><li><span class="param">country</span> : mutable, string the client country name.</li></ul></p>
250
    </div>
251
    
252
    
253
</div>
254
<div class="method" id="client.create">
255
    <a class="indexA" href="#index">go to index</a>
256
    <h4>client.create</h4>
257
    <div class="proto">
258
        <span class="type">none</span>
259
        <span class="methodname">client.create</span>(<span class="type">string</span>  label      , <span class="type">array</span>  attributes )
260
    </div>
261
    <div class="parameters">
262
    <strong>Parameters</strong>
263
    <ul><li><span class="param"> label      </span> string wanted label for the client (client name).</li><li><span class="param"> attributes </span> array (optionnal) of attributes.</li></ul>
264
</div>
265
    <div class="description">
266
        <p><strong>Description</strong></p>
267
        <p>Create a Client.<br/><br/>        A Client is a geographical container entity (eg: a company, a physical person, ...).<br/><br/>        A Client handle one/many users via Client's Role(s).<br/>        By default when a User create a Client, he's attached to the client<br/>        via the default 'owner' Role and have all permissions granted over the Client.<br/></p>
268
    </div>
269
    
270
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#client.attributes">client.attributes</a></li></ul></div>
271
</div>
272
<div class="method" id="client.delete">
273
    <a class="indexA" href="#index">go to index</a>
274
    <h4>client.delete</h4>
275
    <div class="proto">
276
        <span class="type">none</span>
277
        <span class="methodname">client.delete</span>(<span class="type">string</span>  label )
278
    </div>
279
    <div class="parameters">
280
    <strong>Parameters</strong>
281
    <ul><li><span class="param"> label </span> string the client label.</li></ul>
282
</div>
283
    <div class="description">
284
        <p><strong>Description</strong></p>
285
        <p>Destroy a client.<br/>        The client must be empty (no vsite(s) and no other user(s)) prior to allow deletion.<br/></p>
286
    </div>
287
    
288
    
289
</div>
290
<div class="method" id="client.invitation.acknowledge">
291
    <a class="indexA" href="#index">go to index</a>
292
    <h4>client.invitation.acknowledge</h4>
293
    <div class="proto">
294
        <span class="type">string</span>
295
        <span class="methodname">client.invitation.acknowledge</span>(<span class="type">string</span>  key)
296
    </div>
297
    <div class="parameters">
298
    <strong>Parameters</strong>
299
    <ul><li><span class="param"> key</span> string the invitation key.</li></ul>
300
</div>
301
    <div class="description">
302
        <p><strong>Description</strong></p>
303
        <p>Acknowlegde an invitation with a key.<br/><br/>        Return the label of the client.<br/></p>
304
    </div>
305
    
306
    
307
</div>
308
<div class="method" id="client.invitation.create">
309
    <a class="indexA" href="#index">go to index</a>
310
    <h4>client.invitation.create</h4>
311
    <div class="proto">
312
        <span class="type">array</span>
313
        <span class="methodname">client.invitation.create</span>(<span class="type">string</span>  label)
314
    </div>
315
    <div class="parameters">
316
    <strong>Parameters</strong>
317
    <ul><li><span class="param"> label</span> string label of the client.</li></ul>
318
</div>
319
    <div class="description">
320
        <p><strong>Description</strong></p>
321
        <p>Generate an invitation key for a given client.<br/><br/>        Invitation key principle is :<br/>        1. One User U1 attached to a Client C create an invitation Key for this<br/>        Client.<br/>        2. U1 sends this generated Key to a User U2 (eg via email).<br/>        3. U2 aknowledge the invitation whith the Key.<br/>        4. Client C users can now see User U2. U2 has no rights at this time so<br/>        U1 or another Client C user whith right permissions can give some<br/>        credentials to U2.<br/><br/>        Returned array contains a struct compound of :<ul><li><span class="param">key</span> : a md5 style string.</li><li><span class="param">expiration</span> : expiration date of the key.</li></ul></p>
322
    </div>
323
    
324
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#client.invitation.acknowledge">client.invitation.acknowledge</a></li><li><a href="#client.invitation.list">client.invitation.list</a></li></ul></div>
325
</div>
326
<div class="method" id="client.invitation.list">
327
    <a class="indexA" href="#index">go to index</a>
328
    <h4>client.invitation.list</h4>
329
    <div class="proto">
330
        <span class="type">array</span>
331
        <span class="methodname">client.invitation.list</span>(<span class="type">string</span>  label)
332
    </div>
333
    <div class="parameters">
334
    <strong>Parameters</strong>
335
    <ul><li><span class="param"> label</span> string label of the client.</li></ul>
336
</div>
337
    <div class="description">
338
        <p><strong>Description</strong></p>
339
        <p>List all invitation keys for a given client.<br/><br/>        Returned array contains a struct compound of :<ul><li><span class="param">key</span> : a md5 style string.</li><li><span class="param">expiration</span> : expiration date of the key.</li></ul></p>
340
    </div>
341
    
342
    
343
</div>
344
<div class="method" id="client.list">
345
    <a class="indexA" href="#index">go to index</a>
346
    <h4>client.list</h4>
347
    <div class="proto">
348
        <span class="type">array</span>
349
        <span class="methodname">client.list</span>(<span class="type">string</span>  label)
350
    </div>
351
    <div class="parameters">
352
    <strong>Parameters</strong>
353
    <ul><li><span class="param"> label</span> string (optionnal) the client label.</li></ul>
354
</div>
355
    <div class="description">
356
        <p><strong>Description</strong></p>
357
        <p>List clients.<br/>        If no label passed or empty : return the names of a user's clients.<br/>        Else, return a detailed list of the user's client :<ul><li><span class="param">vsites</span> : struct indexed by vsite label (included Vsite attribute)</li><li><span class="param">roles</span> : struct indexed by role label (included public attribute)</li><li><span class="param">users</span> : array of client's users labels</li></ul></p>
358
    </div>
359
    
360
    
361
</div>
362
<div class="method" id="client.update">
363
    <a class="indexA" href="#index">go to index</a>
364
    <h4>client.update</h4>
365
    <div class="proto">
366
        <span class="type">none</span>
367
        <span class="methodname">client.update</span>(<span class="type">string</span>  label      , <span class="type">struct</span>  attributes )
368
    </div>
369
    <div class="parameters">
370
    <strong>Parameters</strong>
371
    <ul><li><span class="param"> label      </span> string label of associated Client.</li><li><span class="param"> attributes </span> struct (optionnal) attributes.</li></ul>
372
</div>
373
    <div class="description">
374
        <p><strong>Description</strong></p>
375
        <p>Update mutables attributes of a client.<br/></p>
376
    </div>
377
    
378
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#client.attributes">client.attributes</a></li></ul></div>
379
</div>
380
<div class="method" id="image.accounting">
381
    <a class="indexA" href="#index">go to index</a>
382
    <h4>image.accounting</h4>
383
    <div class="proto">
384
        <span class="type">none</span>
385
        <span class="methodname">image.accounting</span>()
386
    </div>
387
    
388
    <div class="description">
389
        <p><strong>Description</strong></p>
390
        <p><br/></p>
391
    </div>
392
    
393
    
394
</div>
395
<div class="method" id="image.attributes">
396
    <a class="indexA" href="#index">go to index</a>
397
    <h4>image.attributes</h4>
398
    <div class="proto">
399
        <span class="type">array</span>
400
        <span class="methodname">image.attributes</span>(<span class="type">bool</span>  onlyMutables)
401
    </div>
402
    <div class="parameters">
403
    <strong>Parameters</strong>
404
    <ul><li><span class="param"> onlyMutables</span> bool (optionnal) filters unmutable attributes.</li></ul>
405
</div>
406
    <div class="description">
407
        <p><strong>Description</strong></p>
408
        <p>List of attributes of a image.<br/><br/><br/>        Possible attributes are :<ul><li><span class="param">label</span> : unmutable</li><li><span class="param">size</span> : unmutable, string, default=1G</li></ul></p>
409
    </div>
410
    
411
    
412
</div>
413
<div class="method" id="image.create">
414
    <a class="indexA" href="#index">go to index</a>
415
    <h4>image.create</h4>
416
    <div class="proto">
417
        <span class="type">none</span>
418
        <span class="methodname">image.create</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">attributes</span>  attributes )
419
    </div>
420
    <div class="parameters">
421
    <strong>Parameters</strong>
422
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the new storage.</li><li><span class="param"> attributes </span> attributes struct.</li></ul>
423
</div>
424
    <div class="description">
425
        <p><strong>Description</strong></p>
426
        <p>Create an image.<br/></p>
427
    </div>
428
    
429
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#storage.attributes">storage.attributes</a></li></ul></div>
430
</div>
431
<div class="method" id="image.delete">
432
    <a class="indexA" href="#index">go to index</a>
433
    <h4>image.delete</h4>
434
    <div class="proto">
435
        <span class="type">none</span>
436
        <span class="methodname">image.delete</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     )
437
    </div>
438
    <div class="parameters">
439
    <strong>Parameters</strong>
440
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the image.</li></ul>
441
</div>
442
    <div class="description">
443
        <p><strong>Description</strong></p>
444
        <p>Delete an image, must not be attached to any machine.<br/></p>
445
    </div>
446
    
447
    
448
</div>
449
<div class="method" id="image.list">
450
    <a class="indexA" href="#index">go to index</a>
451
    <h4>image.list</h4>
452
    <div class="proto">
453
        <span class="type">array|struct</span>
454
        <span class="methodname">image.list</span>(<span class="type">string</span>  vsite , <span class="type">(optionnal)</span>  label     )
455
    </div>
456
    <div class="parameters">
457
    <strong>Parameters</strong>
458
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> (optionnal) string|array label(s) of the image(s).</li></ul>
459
</div>
460
    <div class="description">
461
        <p><strong>Description</strong></p>
462
        <p>List image(s) : detailed if label(s), general if not.<br/></p>
463
    </div>
464
    
465
    
466
</div>
467
<div class="method" id="image.update">
468
    <a class="indexA" href="#index">go to index</a>
469
    <h4>image.update</h4>
470
    <div class="proto">
471
        <span class="type">none</span>
472
        <span class="methodname">image.update</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">struct</span>  attributes )
473
    </div>
474
    <div class="parameters">
475
    <strong>Parameters</strong>
476
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the image.</li><li><span class="param"> attributes </span> struct (optionnal) attributes.</li></ul>
477
</div>
478
    <div class="description">
479
        <p><strong>Description</strong></p>
480
        <p>Update mutables attributes of a image.<br/></p>
481
    </div>
482
    
483
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#image.attributes">image.attributes</a></li><li><a href="#image.create">image.create</a></li></ul></div>
484
</div>
485
<div class="method" id="interface.accounting">
486
    <a class="indexA" href="#index">go to index</a>
487
    <h4>interface.accounting</h4>
488
    <div class="proto">
489
        <span class="type">array</span>
490
        <span class="methodname">interface.accounting</span>(<span class="type">string</span>  vsite, <span class="type">string</span>  label)
491
    </div>
492
    <div class="parameters">
493
    <strong>Parameters</strong>
494
    <ul><li><span class="param"> vsite</span> string associated vsite</li><li><span class="param"> label</span> string label of the interface.</li></ul>
495
</div>
496
    <div class="description">
497
        <p><strong>Description</strong></p>
498
        <p>Get Accounting list for an interface.<br/><br/>        If no label, list all vsite interfaces labels.<br/>        Else, list interfaces indexed by label in a struct compound of :<ul><li><span class="param">start</span> : string of the starting period</li><li><span class="param">stop</span> : string of the stopping period</li><li><span class="param">byteIn</span> : BigInt number of bytes In</li><li><span class="param">byteOut</span> : BigInt number of bytes Out</li><li><span class="param">packetIn</span> : BigInt number of packets In</li><li><span class="param">packetOut</span> : BigInt number of packets Out</li></ul></p>
499
    </div>
500
    
501
    
502
</div>
503
<div class="method" id="interface.attributes">
504
    <a class="indexA" href="#index">go to index</a>
505
    <h4>interface.attributes</h4>
506
    <div class="proto">
507
        <span class="type">array</span>
508
        <span class="methodname">interface.attributes</span>(<span class="type">bool</span>  onlyMutables)
509
    </div>
510
    <div class="parameters">
511
    <strong>Parameters</strong>
512
    <ul><li><span class="param"> onlyMutables</span> bool (optionnal) filters unmutable attributes.</li></ul>
513
</div>
514
    <div class="description">
515
        <p><strong>Description</strong></p>
516
        <p>List attributes of an interface.<br/><br/><br/>        Possible attributes are :<ul><li><span class="param">label</span> : unmutable, string</li><li><span class="param">macAddr</span> : unmutable, string</li><li><span class="param">model</span> : mutable, string, default=virtio</li></ul></p>
517
    </div>
518
    
519
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#interface.types.list">interface.types.list</a></li></ul></div>
520
</div>
521
<div class="method" id="interface.create">
522
    <a class="indexA" href="#index">go to index</a>
523
    <h4>interface.create</h4>
524
    <div class="proto">
525
        <span class="type">none</span>
526
        <span class="methodname">interface.create</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">struct</span>  attributes )
527
    </div>
528
    <div class="parameters">
529
    <strong>Parameters</strong>
530
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the new interface.</li><li><span class="param"> attributes </span> struct (optionnal) attributes.</li></ul>
531
</div>
532
    <div class="description">
533
        <p><strong>Description</strong></p>
534
        <p>Create an interface.<br/>        An interface is a virtual network card.<br/></p>
535
    </div>
536
    
537
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#interface.attributes">interface.attributes</a></li><li><a href="#interface.ipaddress.attach">interface.ipaddress.attach</a></li><li><a href="#interface.ipaddress.detach">interface.ipaddress.detach</a></li><li><a href="#machine.interface.attach">machine.interface.attach</a></li><li><a href="#machine.interface.detach">machine.interface.detach</a></li><li><a href="#vlan.interface.detach">vlan.interface.detach</a></li><li><a href="#vlan.interface.detach">vlan.interface.detach</a></li></ul></div>
538
</div>
539
<div class="method" id="interface.delete">
540
    <a class="indexA" href="#index">go to index</a>
541
    <h4>interface.delete</h4>
542
    <div class="proto">
543
        <span class="type">none</span>
544
        <span class="methodname">interface.delete</span>(<span class="type">string</span>  vsite, <span class="type">string</span>  label)
545
    </div>
546
    <div class="parameters">
547
    <strong>Parameters</strong>
548
    <ul><li><span class="param"> vsite</span> string associated vsite.</li><li><span class="param"> label</span> string label of the interface.</li></ul>
549
</div>
550
    <div class="description">
551
        <p><strong>Description</strong></p>
552
        <p>Delete an interface.<br/></p>
553
    </div>
554
    
555
    
556
</div>
557
<div class="method" id="interface.ipaddress.attach">
558
    <a class="indexA" href="#index">go to index</a>
559
    <h4>interface.ipaddress.attach</h4>
560
    <div class="proto">
561
        <span class="type">none</span>
562
        <span class="methodname">interface.ipaddress.attach</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">string</span>  ipaddress )
563
    </div>
564
    <div class="parameters">
565
    <strong>Parameters</strong>
566
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the interface.</li><li><span class="param"> ipaddress </span> string label of ipaddress to attach.</li></ul>
567
</div>
568
    <div class="description">
569
        <p><strong>Description</strong></p>
570
        <p>Attach an ipaddress to an interface.<br/></p>
571
    </div>
572
    
573
    
574
</div>
575
<div class="method" id="interface.ipaddress.detach">
576
    <a class="indexA" href="#index">go to index</a>
577
    <h4>interface.ipaddress.detach</h4>
578
    <div class="proto">
579
        <span class="type">none</span>
580
        <span class="methodname">interface.ipaddress.detach</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">string</span>  ipaddress )
581
    </div>
582
    <div class="parameters">
583
    <strong>Parameters</strong>
584
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the interface.</li><li><span class="param"> ipaddress </span> string label of ipaddress to detach.</li></ul>
585
</div>
586
    <div class="description">
587
        <p><strong>Description</strong></p>
588
        <p>Detach an ipaddress from an interface.<br/></p>
589
    </div>
590
    
591
    
592
</div>
593
<div class="method" id="interface.ipaddress.list">
594
    <a class="indexA" href="#index">go to index</a>
595
    <h4>interface.ipaddress.list</h4>
596
    <div class="proto">
597
        <span class="type">array</span>
598
        <span class="methodname">interface.ipaddress.list</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">none|string|array</span>  ipaddress )
599
    </div>
600
    <div class="parameters">
601
    <strong>Parameters</strong>
602
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the interface.</li><li><span class="param"> ipaddress </span> none|string|array (optionnal) label(s) of the ipaddress(es).</li></ul>
603
</div>
604
    <div class="description">
605
        <p><strong>Description</strong></p>
606
        <p>List interface's attached ipaddress(es) : detailed if label(s), general if not.<br/></p>
607
    </div>
608
    
609
    
610
</div>
611
<div class="method" id="interface.list">
612
    <a class="indexA" href="#index">go to index</a>
613
    <h4>interface.list</h4>
614
    <div class="proto">
615
        <span class="type">array</span>
616
        <span class="methodname">interface.list</span>(<span class="type">string</span>  vsite, <span class="type">none|string|array</span>  label)
617
    </div>
618
    <div class="parameters">
619
    <strong>Parameters</strong>
620
    <ul><li><span class="param"> vsite</span> string associated vsite</li><li><span class="param"> label</span> none|string|array (optionnal) label(s) of the interface(s).</li></ul>
621
</div>
622
    <div class="description">
623
        <p><strong>Description</strong></p>
624
        <p>List interface(s).<br/><br/>        If no label, list all vsite interfaces labels.<br/>        Else, list interfaces indexed by label in a struct compound of :<ul><li><span class="param">Vsite</span> : string name of asociated Vsite.</li><li><span class="param">machine</span> : struct compound of label and current status of attached machine(s).</li><li><span class="param">vlan</span> : struct compound of label and tag of attached vlan.</li><li><span class="param">ip</span> : array of attached ip label(s)</li></ul></p>
625
    </div>
626
    
627
    
628
</div>
629
<div class="method" id="interface.types.list">
630
    <a class="indexA" href="#index">go to index</a>
631
    <h4>interface.types.list</h4>
632
    <div class="proto">
633
        <span class="type">array</span>
634
        <span class="methodname">interface.types.list</span>(<span class="type">string</span>  vsite)
635
    </div>
636
    <div class="parameters">
637
    <strong>Parameters</strong>
638
    <ul><li><span class="param"> vsite</span> string to have the list related to.</li></ul>
639
</div>
640
    <div class="description">
641
        <p><strong>Description</strong></p>
642
        <p>List network interface types (eg: virtio, ne2000, ...).<br/></p>
643
    </div>
644
    
645
    
646
</div>
647
<div class="method" id="interface.update">
648
    <a class="indexA" href="#index">go to index</a>
649
    <h4>interface.update</h4>
650
    <div class="proto">
651
        <span class="type">none</span>
652
        <span class="methodname">interface.update</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">struct</span>  attributes )
653
    </div>
654
    <div class="parameters">
655
    <strong>Parameters</strong>
656
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the interface.</li><li><span class="param"> attributes </span> struct (optionnal) attributes to update.</li></ul>
657
</div>
658
    <div class="description">
659
        <p><strong>Description</strong></p>
660
        <p>Update mutable attributes of an interface.<br/></p>
661
    </div>
662
    
663
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#interface.attributes">interface.attributes</a></li><li><a href="#interface.create">interface.create</a></li></ul></div>
664
</div>
665
<div class="method" id="ipaddress.accounting">
666
    <a class="indexA" href="#index">go to index</a>
667
    <h4>ipaddress.accounting</h4>
668
    <div class="proto">
669
        <span class="type">none</span>
670
        <span class="methodname">ipaddress.accounting</span>()
671
    </div>
672
    
673
    <div class="description">
674
        <p><strong>Description</strong></p>
675
        <p><br/></p>
676
    </div>
677
    
678
    
679
</div>
680
<div class="method" id="ipaddress.attributes">
681
    <a class="indexA" href="#index">go to index</a>
682
    <h4>ipaddress.attributes</h4>
683
    <div class="proto">
684
        <span class="type">array</span>
685
        <span class="methodname">ipaddress.attributes</span>(<span class="type">bool</span>  onlyMutables)
686
    </div>
687
    <div class="parameters">
688
    <strong>Parameters</strong>
689
    <ul><li><span class="param"> onlyMutables</span> bool (optionnal) filters unmutable attributes.</li></ul>
690
</div>
691
    <div class="description">
692
        <p><strong>Description</strong></p>
693
        <p>List of attributes of a ipaddress.<br/><br/><br/>        Possible attributes are :<ul><li><span class="param">label</span> : unmutable, string</li><li><span class="param">addr</span> : unmutable string, IP address</li><li><span class="param">reverse</span> : mutable, string, default=None</li></ul></p>
694
    </div>
695
    
696
    
697
</div>
698
<div class="method" id="ipaddress.create">
699
    <a class="indexA" href="#index">go to index</a>
700
    <h4>ipaddress.create</h4>
701
    <div class="proto">
702
        <span class="type">none</span>
703
        <span class="methodname">ipaddress.create</span>(<span class="type">string</span>  vsite, <span class="type">string</span>  label, <span class="type">struct</span>  attributes)
704
    </div>
705
    <div class="parameters">
706
    <strong>Parameters</strong>
707
    <ul><li><span class="param"> vsite</span> string associated vsite.</li><li><span class="param"> label</span> string label of the new ipaddress.</li><li><span class="param"> attributes</span> struct (optionnal) attributes.</li></ul>
708
</div>
709
    <div class="description">
710
        <p><strong>Description</strong></p>
711
        <p>Create an ipaddress.<br/></p>
712
    </div>
713
    <blockquote>
714
    <p><strong class="note">Note</strong>: ipaddress is dynamic, so you have to specify kind of IP Family you want to obtain in attributes : familiy=ipv4 or family=ipv6.</p>
715
</blockquote>
716
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#ipaddress.attributes">ipaddress.attributes</a></li></ul></div>
717
</div>
718
<div class="method" id="ipaddress.delete">
719
    <a class="indexA" href="#index">go to index</a>
720
    <h4>ipaddress.delete</h4>
721
    <div class="proto">
722
        <span class="type">none</span>
723
        <span class="methodname">ipaddress.delete</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     )
724
    </div>
725
    <div class="parameters">
726
    <strong>Parameters</strong>
727
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of ipaddress.</li></ul>
728
</div>
729
    <div class="description">
730
        <p><strong>Description</strong></p>
731
        <p>Destroy an ipaddress<br/></p>
732
    </div>
733
    
734
    
735
</div>
736
<div class="method" id="ipaddress.list">
737
    <a class="indexA" href="#index">go to index</a>
738
    <h4>ipaddress.list</h4>
739
    <div class="proto">
740
        <span class="type">array</span>
741
        <span class="methodname">ipaddress.list</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     )
742
    </div>
743
    <div class="parameters">
744
    <strong>Parameters</strong>
745
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string (optionnal) label of ipaddress.</li></ul>
746
</div>
747
    <div class="description">
748
        <p><strong>Description</strong></p>
749
        <p>List network ipaddresses.<br/></p>
750
    </div>
751
    
752
    
753
</div>
754
<div class="method" id="ipaddress.update">
755
    <a class="indexA" href="#index">go to index</a>
756
    <h4>ipaddress.update</h4>
757
    <div class="proto">
758
        <span class="type">none</span>
759
        <span class="methodname">ipaddress.update</span>(<span class="type">string</span>  vsite, <span class="type">string</span>  label, <span class="type">struct</span>  attributes)
760
    </div>
761
    <div class="parameters">
762
    <strong>Parameters</strong>
763
    <ul><li><span class="param"> vsite</span> string associated vsite.</li><li><span class="param"> label</span> string label of the ipaddress.</li><li><span class="param"> attributes</span> struct attributes.</li></ul>
764
</div>
765
    <div class="description">
766
        <p><strong>Description</strong></p>
767
        <p>Update mutable attributes of an ipaddress.<br/></p>
768
    </div>
769
    
770
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#ipaddress.attributes">ipaddress.attributes</a></li><li><a href="#ipaddress.create">ipaddress.create</a></li></ul></div>
771
</div>
772
<div class="method" id="machine.accounting">
773
    <a class="indexA" href="#index">go to index</a>
774
    <h4>machine.accounting</h4>
775
    <div class="proto">
776
        <span class="type">none</span>
777
        <span class="methodname">machine.accounting</span>()
778
    </div>
779
    
780
    <div class="description">
781
        <p><strong>Description</strong></p>
782
        <p><br/></p>
783
    </div>
784
    
785
    
786
</div>
787
<div class="method" id="machine.attributes">
788
    <a class="indexA" href="#index">go to index</a>
789
    <h4>machine.attributes</h4>
790
    <div class="proto">
791
        <span class="type">array</span>
792
        <span class="methodname">machine.attributes</span>(<span class="type">boolean</span>  onlyMutables)
793
    </div>
794
    <div class="parameters">
795
    <strong>Parameters</strong>
796
    <ul><li><span class="param"> onlyMutables</span> boolean (optionnal) filters unmutable attributes.</li></ul>
797
</div>
798
    <div class="description">
799
        <p><strong>Description</strong></p>
800
        <p>List attributes of a machine.<br/><br/><br/>        Possible attributes are :<ul><li><span class="param">label</span> : unmutable, string</li><li><span class="param">vcpu</span> : mutable,   integer, default=1</li><li><span class="param">cpu</span> : mutable,   integer, default=x86-64bit</li><li><span class="param">memory</span> : mutable,   string,  default=1024M</li><li><span class="param">image</span> : mutable,   string,  default=None</li></ul>        - vnc (substruct) : password(mutable, string, default=None), keymap(mutable, string, default=en-us)<br/></p>
801
    </div>
802
    
803
    
804
</div>
805
<div class="method" id="machine.boot">
806
    <a class="indexA" href="#index">go to index</a>
807
    <h4>machine.boot</h4>
808
    <div class="proto">
809
        <span class="type">none</span>
810
        <span class="methodname">machine.boot</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     )
811
    </div>
812
    <div class="parameters">
813
    <strong>Parameters</strong>
814
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the machine.</li></ul>
815
</div>
816
    <div class="description">
817
        <p><strong>Description</strong></p>
818
        <p>Boot a machine.<br/><br/>        The machine can boot only if it has :<br/>        - An interface.<br/>        - At least a bootable storage.<br/>        - All of its storages are ready.<br/></p>
819
    </div>
820
    
821
    
822
</div>
823
<div class="method" id="machine.cputype.list">
824
    <a class="indexA" href="#index">go to index</a>
825
    <h4>machine.cputype.list</h4>
826
    <div class="proto">
827
        <span class="type">array</span>
828
        <span class="methodname">machine.cputype.list</span>(<span class="type">string</span>  vsite)
829
    </div>
830
    <div class="parameters">
831
    <strong>Parameters</strong>
832
    <ul><li><span class="param"> vsite</span> string associated vsite.</li></ul>
833
</div>
834
    <div class="description">
835
        <p><strong>Description</strong></p>
836
        <p>List cpu types.<br/></p>
837
    </div>
838
    
839
    
840
</div>
841
<div class="method" id="machine.create">
842
    <a class="indexA" href="#index">go to index</a>
843
    <h4>machine.create</h4>
844
    <div class="proto">
845
        <span class="type">none</span>
846
        <span class="methodname">machine.create</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">struct</span>  attributes )
847
    </div>
848
    <div class="parameters">
849
    <strong>Parameters</strong>
850
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the new machine.</li><li><span class="param"> attributes </span> struct (optionnal) attributes.</li></ul>
851
</div>
852
    <div class="description">
853
        <p><strong>Description</strong></p>
854
        <p>Create a machine.<br/>        The machine is a GNU/Linux kvm virtual machine instance.<br/></p>
855
    </div>
856
    
857
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#machine.attributes">machine.attributes</a></li></ul></div>
858
</div>
859
<div class="method" id="machine.delete">
860
    <a class="indexA" href="#index">go to index</a>
861
    <h4>machine.delete</h4>
862
    <div class="proto">
863
        <span class="type">none</span>
864
        <span class="methodname">machine.delete</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     )
865
    </div>
866
    <div class="parameters">
867
    <strong>Parameters</strong>
868
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the machine.</li></ul>
869
</div>
870
    <div class="description">
871
        <p><strong>Description</strong></p>
872
        <p>Delete a machine.<br/>        Attached resources (interface, storage, ...) must be detached first.<br/></p>
873
    </div>
874
    
875
    
876
</div>
877
<div class="method" id="machine.interface.attach">
878
    <a class="indexA" href="#index">go to index</a>
879
    <h4>machine.interface.attach</h4>
880
    <div class="proto">
881
        <span class="type">none</span>
882
        <span class="methodname">machine.interface.attach</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">string</span>  interface )
883
    </div>
884
    <div class="parameters">
885
    <strong>Parameters</strong>
886
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the machine.</li><li><span class="param"> interface </span> string label of interface to attach.</li></ul>
887
</div>
888
    <div class="description">
889
        <p><strong>Description</strong></p>
890
        <p>Attach an interface to a machine.<br/></p>
891
    </div>
892
    
893
    
894
</div>
895
<div class="method" id="machine.interface.detach">
896
    <a class="indexA" href="#index">go to index</a>
897
    <h4>machine.interface.detach</h4>
898
    <div class="proto">
899
        <span class="type">none</span>
900
        <span class="methodname">machine.interface.detach</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">string</span>  interface )
901
    </div>
902
    <div class="parameters">
903
    <strong>Parameters</strong>
904
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the machine.</li><li><span class="param"> interface </span> string label of interface to detach.</li></ul>
905
</div>
906
    <div class="description">
907
        <p><strong>Description</strong></p>
908
        <p>Detach an interface from a machine.<br/></p>
909
    </div>
910
    
911
    
912
</div>
913
<div class="method" id="machine.interface.list">
914
    <a class="indexA" href="#index">go to index</a>
915
    <h4>machine.interface.list</h4>
916
    <div class="proto">
917
        <span class="type">array</span>
918
        <span class="methodname">machine.interface.list</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">none|string|array</span>  interface )
919
    </div>
920
    <div class="parameters">
921
    <strong>Parameters</strong>
922
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the machine.</li><li><span class="param"> interface </span> none|string|array (optionnal) label(s) of the interface(s).</li></ul>
923
</div>
924
    <div class="description">
925
        <p><strong>Description</strong></p>
926
        <p>List machine's attached interface(s).<br/>        Detailed if label(s), general if not.<br/></p>
927
    </div>
928
    
929
    
930
</div>
931
<div class="method" id="machine.list">
932
    <a class="indexA" href="#index">go to index</a>
933
    <h4>machine.list</h4>
934
    <div class="proto">
935
        <span class="type">array</span>
936
        <span class="methodname">machine.list</span>(<span class="type">string</span>  vsite , <span class="type">none|string|array</span>  label     )
937
    </div>
938
    <div class="parameters">
939
    <strong>Parameters</strong>
940
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> none|string|array (optionnal) label(s) of the machine(s).</li></ul>
941
</div>
942
    <div class="description">
943
        <p><strong>Description</strong></p>
944
        <p>List machine(s).<br/>        Detailed if label(s), general if not.<br/></p>
945
    </div>
946
    
947
    
948
</div>
949
<div class="method" id="machine.migrate">
950
    <a class="indexA" href="#index">go to index</a>
951
    <h4>machine.migrate</h4>
952
    <div class="proto">
953
        <span class="type">none</span>
954
        <span class="methodname">machine.migrate</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">string</span>  hostnode  )
955
    </div>
956
    <div class="parameters">
957
    <strong>Parameters</strong>
958
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string machine's label.</li><li><span class="param"> hostnode  </span> string machine destination node label.</li></ul>
959
</div>
960
    <div class="description">
961
        <p><strong>Description</strong></p>
962
        <p>Migrate a machine.<br/>        The machine can only migrate to another node than the one it runs.<br/></p>
963
    </div>
964
    
965
    
966
</div>
967
<div class="method" id="machine.shutdown">
968
    <a class="indexA" href="#index">go to index</a>
969
    <h4>machine.shutdown</h4>
970
    <div class="proto">
971
        <span class="type">none</span>
972
        <span class="methodname">machine.shutdown</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     )
973
    </div>
974
    <div class="parameters">
975
    <strong>Parameters</strong>
976
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the machine.</li></ul>
977
</div>
978
    <div class="description">
979
        <p><strong>Description</strong></p>
980
        <p>Shutdown a machine.<br/></p>
981
    </div>
982
    
983
    
984
</div>
985
<div class="method" id="machine.storage.attach">
986
    <a class="indexA" href="#index">go to index</a>
987
    <h4>machine.storage.attach</h4>
988
    <div class="proto">
989
        <span class="type">none</span>
990
        <span class="methodname">machine.storage.attach</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">string</span>  storage    , <span class="type">none|struct</span>  attributes )
991
    </div>
992
    <div class="parameters">
993
    <strong>Parameters</strong>
994
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the machine.</li><li><span class="param"> storage    </span> string label of storage to attach.</li><li><span class="param"> attributes </span> none|struct (optionnal) array attributes.</li></ul>
995
</div>
996
    <div class="description">
997
        <p><strong>Description</strong></p>
998
        <p>Attach a storage volume to a virual machine.<br/><br/>        Possible attributes are :<br/>        - bus (default : virtio)<br/>        - media (default : disk)<br/>        - readOnly (default : False)<br/>        - bootOrder (default : 1)<br/>        - bootable (default: False)<br/></p>
999
    </div>
1000
    
1001
    
1002
</div>
1003
<div class="method" id="machine.storage.bustype.list">
1004
    <a class="indexA" href="#index">go to index</a>
1005
    <h4>machine.storage.bustype.list</h4>
1006
    <div class="proto">
1007
        <span class="type">array</span>
1008
        <span class="methodname">machine.storage.bustype.list</span>(<span class="type">string</span>  vsite)
1009
    </div>
1010
    <div class="parameters">
1011
    <strong>Parameters</strong>
1012
    <ul><li><span class="param"> vsite</span> string label of associated vsite.</li></ul>
1013
</div>
1014
    <div class="description">
1015
        <p><strong>Description</strong></p>
1016
        <p>List storage bus types.<br/></p>
1017
    </div>
1018
    
1019
    
1020
</div>
1021
<div class="method" id="machine.storage.detach">
1022
    <a class="indexA" href="#index">go to index</a>
1023
    <h4>machine.storage.detach</h4>
1024
    <div class="proto">
1025
        <span class="type">none</span>
1026
        <span class="methodname">machine.storage.detach</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">string</span>  storage   )
1027
    </div>
1028
    <div class="parameters">
1029
    <strong>Parameters</strong>
1030
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the machine.</li><li><span class="param"> storage   </span> string label of storage to detach.</li></ul>
1031
</div>
1032
    <div class="description">
1033
        <p><strong>Description</strong></p>
1034
        <p>Detach a storage from a machine.<br/></p>
1035
    </div>
1036
    
1037
    
1038
</div>
1039
<div class="method" id="machine.storage.list">
1040
    <a class="indexA" href="#index">go to index</a>
1041
    <h4>machine.storage.list</h4>
1042
    <div class="proto">
1043
        <span class="type">array</span>
1044
        <span class="methodname">machine.storage.list</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">none|string|array</span>  storage   )
1045
    </div>
1046
    <div class="parameters">
1047
    <strong>Parameters</strong>
1048
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the machine.</li><li><span class="param"> storage   </span> none|string|array (optionnal) label(s) of the storage(s).</li></ul>
1049
</div>
1050
    <div class="description">
1051
        <p><strong>Description</strong></p>
1052
        <p>List machine's attached storage(s)<br/>        Detailed if label(s), general if not.<br/></p>
1053
    </div>
1054
    
1055
    
1056
</div>
1057
<div class="method" id="machine.update">
1058
    <a class="indexA" href="#index">go to index</a>
1059
    <h4>machine.update</h4>
1060
    <div class="proto">
1061
        <span class="type">none</span>
1062
        <span class="methodname">machine.update</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">struct</span>  attributes )
1063
    </div>
1064
    <div class="parameters">
1065
    <strong>Parameters</strong>
1066
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the machine.</li><li><span class="param"> attributes </span> struct (optionnal) attributes.</li></ul>
1067
</div>
1068
    <div class="description">
1069
        <p><strong>Description</strong></p>
1070
        <p>Update mutable attributes of a machine.<br/></p>
1071
    </div>
1072
    
1073
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#machine.attributes">machine.attributes</a></li><li><a href="#machine.create">machine.create</a></li></ul></div>
1074
</div>
1075
<div class="method" id="machine.vnc.keymap.list">
1076
    <a class="indexA" href="#index">go to index</a>
1077
    <h4>machine.vnc.keymap.list</h4>
1078
    <div class="proto">
1079
        <span class="type">array</span>
1080
        <span class="methodname">machine.vnc.keymap.list</span>(<span class="type">string</span>  vsite)
1081
    </div>
1082
    <div class="parameters">
1083
    <strong>Parameters</strong>
1084
    <ul><li><span class="param"> vsite</span> string associated vsite.</li></ul>
1085
</div>
1086
    <div class="description">
1087
        <p><strong>Description</strong></p>
1088
        <p>List vnc keymaps.<br/></p>
1089
    </div>
1090
    
1091
    
1092
</div>
1093
<div class="method" id="permission.list">
1094
    <a class="indexA" href="#index">go to index</a>
1095
    <h4>permission.list</h4>
1096
    <div class="proto">
1097
        <span class="type">struct</span>
1098
        <span class="methodname">permission.list</span>()
1099
    </div>
1100
    <div class="parameters">
1101
    <strong>Parameters</strong>
1102
    <ul></ul>
1103
</div>
1104
    <div class="description">
1105
        <p><strong>Description</strong></p>
1106
        <p>List permissions.<br/></p>
1107
    </div>
1108
    
1109
    
1110
</div>
1111
<div class="method" id="role.accounting">
1112
    <a class="indexA" href="#index">go to index</a>
1113
    <h4>role.accounting</h4>
1114
    <div class="proto">
1115
        <span class="type">none</span>
1116
        <span class="methodname">role.accounting</span>()
1117
    </div>
1118
    
1119
    <div class="description">
1120
        <p><strong>Description</strong></p>
1121
        <p><br/></p>
1122
    </div>
1123
    
1124
    
1125
</div>
1126
<div class="method" id="role.attributes">
1127
    <a class="indexA" href="#index">go to index</a>
1128
    <h4>role.attributes</h4>
1129
    <div class="proto">
1130
        <span class="type">array</span>
1131
        <span class="methodname">role.attributes</span>(<span class="type">bool</span>  onlyMutables)
1132
    </div>
1133
    <div class="parameters">
1134
    <strong>Parameters</strong>
1135
    <ul><li><span class="param"> onlyMutables</span> bool (optionnal) filters unmutable attributes.</li></ul>
1136
</div>
1137
    <div class="description">
1138
        <p><strong>Description</strong></p>
1139
        <p>List of attributes of a role.<br/><br/><br/>        possible attributes are :<ul><li><span class="param">label</span> : mutable, string</li><li><span class="param">public</span> : mutable, bool</li></ul></p>
1140
    </div>
1141
    
1142
    
1143
</div>
1144
<div class="method" id="role.create">
1145
    <a class="indexA" href="#index">go to index</a>
1146
    <h4>role.create</h4>
1147
    <div class="proto">
1148
        <span class="type">none</span>
1149
        <span class="methodname">role.create</span>(<span class="type">string</span>  client , <span class="type">string</span>  label  , <span class="type">strcut</span>  attributes )
1150
    </div>
1151
    <div class="parameters">
1152
    <strong>Parameters</strong>
1153
    <ul><li><span class="param"> client </span> string associated client label.</li><li><span class="param"> label  </span> string role label.</li><li><span class="param"> attributes </span> strcut (optionnal) attributes.</li></ul>
1154
</div>
1155
    <div class="description">
1156
        <p><strong>Description</strong></p>
1157
        <p>Create a role.<br/></p>
1158
    </div>
1159
    
1160
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#role.attributes">role.attributes</a></li></ul></div>
1161
</div>
1162
<div class="method" id="role.delete">
1163
    <a class="indexA" href="#index">go to index</a>
1164
    <h4>role.delete</h4>
1165
    <div class="proto">
1166
        <span class="type">none</span>
1167
        <span class="methodname">role.delete</span>(<span class="type">string</span>  client     , <span class="type">string</span>  label      )
1168
    </div>
1169
    <div class="parameters">
1170
    <strong>Parameters</strong>
1171
    <ul><li><span class="param"> client     </span> string associated client label.</li><li><span class="param"> label      </span> string role label.</li></ul>
1172
</div>
1173
    <div class="description">
1174
        <p><strong>Description</strong></p>
1175
        <p>Destroy a role.<br/></p>
1176
    </div>
1177
    
1178
    
1179
</div>
1180
<div class="method" id="role.list">
1181
    <a class="indexA" href="#index">go to index</a>
1182
    <h4>role.list</h4>
1183
    <div class="proto">
1184
        <span class="type">array</span>
1185
        <span class="methodname">role.list</span>(<span class="type">string</span>  client , <span class="type">none|string|array</span>  label  )
1186
    </div>
1187
    <div class="parameters">
1188
    <strong>Parameters</strong>
1189
    <ul><li><span class="param"> client </span> string associated client label.</li><li><span class="param"> label  </span> none|string|array role label.</li></ul>
1190
</div>
1191
    <div class="description">
1192
        <p><strong>Description</strong></p>
1193
        <p>List roles.<br/></p>
1194
    </div>
1195
    
1196
    
1197
</div>
1198
<div class="method" id="role.permission.attach">
1199
    <a class="indexA" href="#index">go to index</a>
1200
    <h4>role.permission.attach</h4>
1201
    <div class="proto">
1202
        <span class="type">none</span>
1203
        <span class="methodname">role.permission.attach</span>(<span class="type">string</span>  client     , <span class="type">string</span>  label      , <span class="type">string</span>  vsite      , <span class="type">string</span>  family     , <span class="type">string</span>  permission )
1204
    </div>
1205
    <div class="parameters">
1206
    <strong>Parameters</strong>
1207
    <ul><li><span class="param"> client     </span> string associated client.</li><li><span class="param"> label      </span> string label of the role.</li><li><span class="param"> vsite      </span> string label of the vsite.</li><li><span class="param"> family     </span> string family of the service.</li><li><span class="param"> permission </span> string permission related to service family.</li></ul>
1208
</div>
1209
    <div class="description">
1210
        <p><strong>Description</strong></p>
1211
        <p>Attach a user to a role.<br/></p>
1212
    </div>
1213
    
1214
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#role.permission.list">role.permission.list</a></li></ul></div>
1215
</div>
1216
<div class="method" id="role.permission.detach">
1217
    <a class="indexA" href="#index">go to index</a>
1218
    <h4>role.permission.detach</h4>
1219
    <div class="proto">
1220
        <span class="type">none</span>
1221
        <span class="methodname">role.permission.detach</span>(<span class="type">string</span>  client     , <span class="type">string</span>  label      , <span class="type">string</span>  vsite      , <span class="type">string</span>  family     , <span class="type">string</span>  permission )
1222
    </div>
1223
    <div class="parameters">
1224
    <strong>Parameters</strong>
1225
    <ul><li><span class="param"> client     </span> string associated client.</li><li><span class="param"> label      </span> string label of the role.</li><li><span class="param"> vsite      </span> string label of the vsite.</li><li><span class="param"> family     </span> string family of the service.</li><li><span class="param"> permission </span> string permission related to service family.</li></ul>
1226
</div>
1227
    <div class="description">
1228
        <p><strong>Description</strong></p>
1229
        <p>Detach a user from a role.<br/></p>
1230
    </div>
1231
    
1232
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#role.permission.list">role.permission.list</a></li></ul></div>
1233
</div>
1234
<div class="method" id="role.permission.list">
1235
    <a class="indexA" href="#index">go to index</a>
1236
    <h4>role.permission.list</h4>
1237
    <div class="proto">
1238
        <span class="type">array</span>
1239
        <span class="methodname">role.permission.list</span>(<span class="type">string</span>  client , <span class="type">string</span>  label  , <span class="type">string</span>  vsite  )
1240
    </div>
1241
    <div class="parameters">
1242
    <strong>Parameters</strong>
1243
    <ul><li><span class="param"> client </span> string associated client.</li><li><span class="param"> label  </span> string label of the role.</li><li><span class="param"> vsite  </span> string label of the vsite.</li></ul>
1244
</div>
1245
    <div class="description">
1246
        <p><strong>Description</strong></p>
1247
        <p>List role's attached permission(s)<br/></p>
1248
    </div>
1249
    
1250
    
1251
</div>
1252
<div class="method" id="role.update">
1253
    <a class="indexA" href="#index">go to index</a>
1254
    <h4>role.update</h4>
1255
    <div class="proto">
1256
        <span class="type">none</span>
1257
        <span class="methodname">role.update</span>(<span class="type">string</span>  client     , <span class="type">string</span>  label      , <span class="type">struct</span>  attributes )
1258
    </div>
1259
    <div class="parameters">
1260
    <strong>Parameters</strong>
1261
    <ul><li><span class="param"> client     </span> string associated client label.</li><li><span class="param"> label      </span> string role label.</li><li><span class="param"> attributes </span> struct (optionnal) attributes.</li></ul>
1262
</div>
1263
    <div class="description">
1264
        <p><strong>Description</strong></p>
1265
        <p>Update role attributes.<br/></p>
1266
    </div>
1267
    
1268
    
1269
</div>
1270
<div class="method" id="role.user.attach">
1271
    <a class="indexA" href="#index">go to index</a>
1272
    <h4>role.user.attach</h4>
1273
    <div class="proto">
1274
        <span class="type">none</span>
1275
        <span class="methodname">role.user.attach</span>(<span class="type">string</span>  client , <span class="type">string</span>  label  , <span class="type">string</span>  user   )
1276
    </div>
1277
    <div class="parameters">
1278
    <strong>Parameters</strong>
1279
    <ul><li><span class="param"> client </span> string associated client label.</li><li><span class="param"> label  </span> string role label.</li><li><span class="param"> user   </span> string user label.</li></ul>
1280
</div>
1281
    <div class="description">
1282
        <p><strong>Description</strong></p>
1283
        <p>Attach a user to a role.<br/></p>
1284
    </div>
1285
    
1286
    
1287
</div>
1288
<div class="method" id="role.user.attributes">
1289
    <a class="indexA" href="#index">go to index</a>
1290
    <h4>role.user.attributes</h4>
1291
    <div class="proto">
1292
        <span class="type">array</span>
1293
        <span class="methodname">role.user.attributes</span>(<span class="type">bool</span>  onlyMutables)
1294
    </div>
1295
    <div class="parameters">
1296
    <strong>Parameters</strong>
1297
    <ul><li><span class="param"> onlyMutables</span> bool (optionnal) filters unmutable attributes.</li></ul>
1298
</div>
1299
    <div class="description">
1300
        <p><strong>Description</strong></p>
1301
        <p>List of attributes of a userrole relation.<br/><br/><br/>        possible attributes are :<ul><li><span class="param">label</span> : unmutable, string</li><li><span class="param">public</span> : mutable, bool, default=False</li></ul></p>
1302
    </div>
1303
    
1304
    
1305
</div>
1306
<div class="method" id="role.user.detach">
1307
    <a class="indexA" href="#index">go to index</a>
1308
    <h4>role.user.detach</h4>
1309
    <div class="proto">
1310
        <span class="type">none</span>
1311
        <span class="methodname">role.user.detach</span>(<span class="type">string</span>  client , <span class="type">string</span>  label  , <span class="type">string</span>  user   )
1312
    </div>
1313
    <div class="parameters">
1314
    <strong>Parameters</strong>
1315
    <ul><li><span class="param"> client </span> string associated client label.</li><li><span class="param"> label  </span> string role label.</li><li><span class="param"> user   </span> string user label.</li></ul>
1316
</div>
1317
    <div class="description">
1318
        <p><strong>Description</strong></p>
1319
        <p>Detach a user from a role.<br/></p>
1320
    </div>
1321
    
1322
    
1323
</div>
1324
<div class="method" id="role.user.list">
1325
    <a class="indexA" href="#index">go to index</a>
1326
    <h4>role.user.list</h4>
1327
    <div class="proto">
1328
        <span class="type">array</span>
1329
        <span class="methodname">role.user.list</span>(<span class="type">string</span>  client , <span class="type">string</span>  label  , <span class="type">none|string|label</span>  user   )
1330
    </div>
1331
    <div class="parameters">
1332
    <strong>Parameters</strong>
1333
    <ul><li><span class="param"> client </span> string associated client label.</li><li><span class="param"> label  </span> string label of the role.</li><li><span class="param"> user   </span> none|string|label (optionnal) label(s) of user(s).</li></ul>
1334
</div>
1335
    <div class="description">
1336
        <p><strong>Description</strong></p>
1337
        <p>List role's attached user(s) : detailed if label(s), general if not.<br/></p>
1338
    </div>
1339
    
1340
    
1341
</div>
1342
<div class="method" id="role.user.update">
1343
    <a class="indexA" href="#index">go to index</a>
1344
    <h4>role.user.update</h4>
1345
    <div class="proto">
1346
        <span class="type">none</span>
1347
        <span class="methodname">role.user.update</span>(<span class="type">string</span>  client , <span class="type">string</span>  label  , <span class="type">struct</span>  attributes )
1348
    </div>
1349
    <div class="parameters">
1350
    <strong>Parameters</strong>
1351
    <ul><li><span class="param"> client </span> string associated client label.</li><li><span class="param"> label  </span> string role label.</li><li><span class="param"> attributes </span> struct (optionnal) attributes.</li></ul>
1352
</div>
1353
    <div class="description">
1354
        <p><strong>Description</strong></p>
1355
        <p>Update userrole relation attributes.<br/></p>
1356
    </div>
1357
    
1358
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#role.user.attributes">role.user.attributes</a></li></ul></div>
1359
</div>
1360
<div class="method" id="sitegroup.list">
1361
    <a class="indexA" href="#index">go to index</a>
1362
    <h4>sitegroup.list</h4>
1363
    <div class="proto">
1364
        <span class="type">none</span>
1365
        <span class="methodname">sitegroup.list</span>(<span class="type">none|string|array</span>  label)
1366
    </div>
1367
    <div class="parameters">
1368
    <strong>Parameters</strong>
1369
    <ul><li><span class="param"> label</span> none|string|array (optionnal) sitegroup label</li></ul>
1370
</div>
1371
    <div class="description">
1372
        <p><strong>Description</strong></p>
1373
        <p>List sitegroups.<br/></p>
1374
    </div>
1375
    
1376
    
1377
</div>
1378
<div class="method" id="storage.accounting">
1379
    <a class="indexA" href="#index">go to index</a>
1380
    <h4>storage.accounting</h4>
1381
    <div class="proto">
1382
        <span class="type">none</span>
1383
        <span class="methodname">storage.accounting</span>()
1384
    </div>
1385
    
1386
    <div class="description">
1387
        <p><strong>Description</strong></p>
1388
        <p><br/></p>
1389
    </div>
1390
    
1391
    
1392
</div>
1393
<div class="method" id="storage.attributes">
1394
    <a class="indexA" href="#index">go to index</a>
1395
    <h4>storage.attributes</h4>
1396
    <div class="proto">
1397
        <span class="type">array</span>
1398
        <span class="methodname">storage.attributes</span>(<span class="type">bool</span>  onlyMutables)
1399
    </div>
1400
    <div class="parameters">
1401
    <strong>Parameters</strong>
1402
    <ul><li><span class="param"> onlyMutables</span> bool (optionnal) filters unmutable attributes.</li></ul>
1403
</div>
1404
    <div class="description">
1405
        <p><strong>Description</strong></p>
1406
        <p>List of attributes of a storage.<br/><br/><br/>        Possible attributes are :<ul><li><span class="param">label</span> : unmutable</li><li><span class="param">size</span> : unmutable, string, default=1G</li></ul></p>
1407
    </div>
1408
    
1409
    
1410
</div>
1411
<div class="method" id="storage.clone">
1412
    <a class="indexA" href="#index">go to index</a>
1413
    <h4>storage.clone</h4>
1414
    <div class="proto">
1415
        <span class="type">none</span>
1416
        <span class="methodname">storage.clone</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">string</span>  from_label )
1417
    </div>
1418
    <div class="parameters">
1419
    <strong>Parameters</strong>
1420
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the storage.</li><li><span class="param"> from_label </span> string label of the storage to clone.</li></ul>
1421
</div>
1422
    <div class="description">
1423
        <p><strong>Description</strong></p>
1424
        <p>Composite call of storage_cloneconfig and storage_clonedata<br/></p>
1425
    </div>
1426
    
1427
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#storage.clone_config">storage.clone_config</a></li><li><a href="#storage.clone_data">storage.clone_data</a></li></ul></div>
1428
</div>
1429
<div class="method" id="storage.clone_config">
1430
    <a class="indexA" href="#index">go to index</a>
1431
    <h4>storage.clone_config</h4>
1432
    <div class="proto">
1433
        <span class="type">none</span>
1434
        <span class="methodname">storage.clone_config</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">string</span>  from_label )
1435
    </div>
1436
    <div class="parameters">
1437
    <strong>Parameters</strong>
1438
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the storage.</li><li><span class="param"> from_label </span> string label of the storage to clone.</li></ul>
1439
</div>
1440
    <div class="description">
1441
        <p><strong>Description</strong></p>
1442
        <p>Create from an existant storage a new empty one with same <br/>        size/vsite.<br/></p>
1443
    </div>
1444
    
1445
    
1446
</div>
1447
<div class="method" id="storage.clone_data">
1448
    <a class="indexA" href="#index">go to index</a>
1449
    <h4>storage.clone_data</h4>
1450
    <div class="proto">
1451
        <span class="type">none</span>
1452
        <span class="methodname">storage.clone_data</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">string</span>  from_label )
1453
    </div>
1454
    <div class="parameters">
1455
    <strong>Parameters</strong>
1456
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the storage.</li><li><span class="param"> from_label </span> string label of the storage to clone.</li></ul>
1457
</div>
1458
    <div class="description">
1459
        <p><strong>Description</strong></p>
1460
        <p>Clone data of a storage to another storage.<br/></p>
1461
    </div>
1462
    
1463
    
1464
</div>
1465
<div class="method" id="storage.create">
1466
    <a class="indexA" href="#index">go to index</a>
1467
    <h4>storage.create</h4>
1468
    <div class="proto">
1469
        <span class="type">none</span>
1470
        <span class="methodname">storage.create</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">attributes</span>  attributes )
1471
    </div>
1472
    <div class="parameters">
1473
    <strong>Parameters</strong>
1474
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the new storage.</li><li><span class="param"> attributes </span> attributes struct.</li></ul>
1475
</div>
1476
    <div class="description">
1477
        <p><strong>Description</strong></p>
1478
        <p>Create a storage volume.<br/></p>
1479
    </div>
1480
    
1481
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#storage.attributes">storage.attributes</a></li></ul></div>
1482
</div>
1483
<div class="method" id="storage.delete">
1484
    <a class="indexA" href="#index">go to index</a>
1485
    <h4>storage.delete</h4>
1486
    <div class="proto">
1487
        <span class="type">none</span>
1488
        <span class="methodname">storage.delete</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     )
1489
    </div>
1490
    <div class="parameters">
1491
    <strong>Parameters</strong>
1492
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the storage.</li></ul>
1493
</div>
1494
    <div class="description">
1495
        <p><strong>Description</strong></p>
1496
        <p>Delete a storage, must not be attached to any machine.<br/></p>
1497
    </div>
1498
    
1499
    
1500
</div>
1501
<div class="method" id="storage.list">
1502
    <a class="indexA" href="#index">go to index</a>
1503
    <h4>storage.list</h4>
1504
    <div class="proto">
1505
        <span class="type">array|struct</span>
1506
        <span class="methodname">storage.list</span>(<span class="type">string</span>  vsite , <span class="type">(optionnal)</span>  label     )
1507
    </div>
1508
    <div class="parameters">
1509
    <strong>Parameters</strong>
1510
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> (optionnal) string|array label(s) of the storage(s).</li></ul>
1511
</div>
1512
    <div class="description">
1513
        <p><strong>Description</strong></p>
1514
        <p>List storage(s) : detailed if label(s), general if not.<br/></p>
1515
    </div>
1516
    
1517
    
1518
</div>
1519
<div class="method" id="storage.update">
1520
    <a class="indexA" href="#index">go to index</a>
1521
    <h4>storage.update</h4>
1522
    <div class="proto">
1523
        <span class="type">none</span>
1524
        <span class="methodname">storage.update</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">struct</span>  attributes )
1525
    </div>
1526
    <div class="parameters">
1527
    <strong>Parameters</strong>
1528
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the storage.</li><li><span class="param"> attributes </span> struct (optionnal) attributes.</li></ul>
1529
</div>
1530
    <div class="description">
1531
        <p><strong>Description</strong></p>
1532
        <p>Update mutables attributes of a storage.<br/></p>
1533
    </div>
1534
    
1535
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#storage.attributes">storage.attributes</a></li><li><a href="#storage.create">storage.create</a></li></ul></div>
1536
</div>
1537
<div class="method" id="system.listMethods">
1538
    <a class="indexA" href="#index">go to index</a>
1539
    <h4>system.listMethods</h4>
1540
    <div class="proto">
1541
        <span class="type">none</span>
1542
        <span class="methodname">system.listMethods</span>()
1543
    </div>
1544
    
1545
    <div class="description">
1546
        <p><strong>Description</strong></p>
1547
        <p>Return a list of the method names implemented by this server.<br/></p>
1548
    </div>
1549
    
1550
    
1551
</div>
1552
<div class="method" id="system.methodHelp">
1553
    <a class="indexA" href="#index">go to index</a>
1554
    <h4>system.methodHelp</h4>
1555
    <div class="proto">
1556
        <span class="type">none</span>
1557
        <span class="methodname">system.methodHelp</span>()
1558
    </div>
1559
    
1560
    <div class="description">
1561
        <p><strong>Description</strong></p>
1562
        <p>Return a documentation string describing the use of the given method.<br/></p>
1563
    </div>
1564
    
1565
    
1566
</div>
1567
<div class="method" id="system.methodSignature">
1568
    <a class="indexA" href="#index">go to index</a>
1569
    <h4>system.methodSignature</h4>
1570
    <div class="proto">
1571
        <span class="type">none</span>
1572
        <span class="methodname">system.methodSignature</span>()
1573
    </div>
1574
    
1575
    <div class="description">
1576
        <p><strong>Description</strong></p>
1577
        <p>Return a list of type signatures.<br/><br/>        Each type signature is a list of the form [rtype, type1, type2, ...]<br/>        where rtype is the return type and typeN is the type of the Nth<br/>        argument. If no signature information is available, the empty<br/>        string is returned.<br/></p>
1578
    </div>
1579
    
1580
    
1581
</div>
1582
<div class="method" id="user.list">
1583
    <a class="indexA" href="#index">go to index</a>
1584
    <h4>user.list</h4>
1585
    <div class="proto">
1586
        <span class="type">none</span>
1587
        <span class="methodname">user.list</span>(<span class="type">none|string|array</span>  label)
1588
    </div>
1589
    <div class="parameters">
1590
    <strong>Parameters</strong>
1591
    <ul><li><span class="param"> label</span> none|string|array (optionnal) user label</li></ul>
1592
</div>
1593
    <div class="description">
1594
        <p><strong>Description</strong></p>
1595
        <p>List user(s).<br/></p>
1596
    </div>
1597
    
1598
    
1599
</div>
1600
<div class="method" id="vlan.accounting">
1601
    <a class="indexA" href="#index">go to index</a>
1602
    <h4>vlan.accounting</h4>
1603
    <div class="proto">
1604
        <span class="type">none</span>
1605
        <span class="methodname">vlan.accounting</span>()
1606
    </div>
1607
    
1608
    <div class="description">
1609
        <p><strong>Description</strong></p>
1610
        <p><br/></p>
1611
    </div>
1612
    
1613
    
1614
</div>
1615
<div class="method" id="vlan.attributes">
1616
    <a class="indexA" href="#index">go to index</a>
1617
    <h4>vlan.attributes</h4>
1618
    <div class="proto">
1619
        <span class="type">array</span>
1620
        <span class="methodname">vlan.attributes</span>(<span class="type">bool</span>  onlyMutables)
1621
    </div>
1622
    <div class="parameters">
1623
    <strong>Parameters</strong>
1624
    <ul><li><span class="param"> onlyMutables</span> bool (optionnal) filters unmutable attributes.</li></ul>
1625
</div>
1626
    <div class="description">
1627
        <p><strong>Description</strong></p>
1628
        <p>List attributes of a vlan.<br/><br/><br/>        Possible attributes are :<ul><li><span class="param">label</span> : unmutable, string</li><li><span class="param">tag</span> : unmutable, integer, default=1</li></ul></p>
1629
    </div>
1630
    
1631
    
1632
</div>
1633
<div class="method" id="vlan.create">
1634
    <a class="indexA" href="#index">go to index</a>
1635
    <h4>vlan.create</h4>
1636
    <div class="proto">
1637
        <span class="type">none</span>
1638
        <span class="methodname">vlan.create</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">struct</span>  attributes)
1639
    </div>
1640
    <div class="parameters">
1641
    <strong>Parameters</strong>
1642
    <ul><li><span class="param"> vsite </span> string associated vsite label.</li><li><span class="param"> label     </span> string vlan label.</li><li><span class="param"> attributes</span> struct (optionnal) attributes.</li></ul>
1643
</div>
1644
    <div class="description">
1645
        <p><strong>Description</strong></p>
1646
        <p>Create a tagged vlan.<br/></p>
1647
    </div>
1648
    
1649
    
1650
</div>
1651
<div class="method" id="vlan.delete">
1652
    <a class="indexA" href="#index">go to index</a>
1653
    <h4>vlan.delete</h4>
1654
    <div class="proto">
1655
        <span class="type">none</span>
1656
        <span class="methodname">vlan.delete</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     )
1657
    </div>
1658
    <div class="parameters">
1659
    <strong>Parameters</strong>
1660
    <ul><li><span class="param"> vsite </span> string associated vsite label.</li><li><span class="param"> label     </span> string vlan label.</li></ul>
1661
</div>
1662
    <div class="description">
1663
        <p><strong>Description</strong></p>
1664
        <p>Destroy a vlan.<br/></p>
1665
    </div>
1666
    
1667
    
1668
</div>
1669
<div class="method" id="vlan.get_next_tag">
1670
    <a class="indexA" href="#index">go to index</a>
1671
    <h4>vlan.get_next_tag</h4>
1672
    <div class="proto">
1673
        <span class="type">int</span>
1674
        <span class="methodname">vlan.get_next_tag</span>(<span class="type">string</span>  vsite )
1675
    </div>
1676
    <div class="parameters">
1677
    <strong>Parameters</strong>
1678
    <ul><li><span class="param"> vsite </span> string associated vsite label.</li></ul>
1679
</div>
1680
    <div class="description">
1681
        <p><strong>Description</strong></p>
1682
        <p>Get the next available tag.<br/></p>
1683
    </div>
1684
    
1685
    
1686
</div>
1687
<div class="method" id="vlan.interface.attach">
1688
    <a class="indexA" href="#index">go to index</a>
1689
    <h4>vlan.interface.attach</h4>
1690
    <div class="proto">
1691
        <span class="type">none</span>
1692
        <span class="methodname">vlan.interface.attach</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">string</span>  interface )
1693
    </div>
1694
    <div class="parameters">
1695
    <strong>Parameters</strong>
1696
    <ul><li><span class="param"> vsite </span> string associated vsite label.</li><li><span class="param"> label     </span> string vlan label.</li><li><span class="param"> interface </span> string interface label.</li></ul>
1697
</div>
1698
    <div class="description">
1699
        <p><strong>Description</strong></p>
1700
        <p>Attach an interface to a vlan.<br/></p>
1701
    </div>
1702
    
1703
    
1704
</div>
1705
<div class="method" id="vlan.interface.detach">
1706
    <a class="indexA" href="#index">go to index</a>
1707
    <h4>vlan.interface.detach</h4>
1708
    <div class="proto">
1709
        <span class="type">none</span>
1710
        <span class="methodname">vlan.interface.detach</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">string</span>  interface )
1711
    </div>
1712
    <div class="parameters">
1713
    <strong>Parameters</strong>
1714
    <ul><li><span class="param"> vsite </span> string associated vsite label.</li><li><span class="param"> label     </span> string vlan label.</li><li><span class="param"> interface </span> string interface label.</li></ul>
1715
</div>
1716
    <div class="description">
1717
        <p><strong>Description</strong></p>
1718
        <p>Restore interface attachment to default vlan.<br/></p>
1719
    </div>
1720
    
1721
    
1722
</div>
1723
<div class="method" id="vlan.interface.list">
1724
    <a class="indexA" href="#index">go to index</a>
1725
    <h4>vlan.interface.list</h4>
1726
    <div class="proto">
1727
        <span class="type">array</span>
1728
        <span class="methodname">vlan.interface.list</span>(<span class="type">string</span>  vsite , <span class="type">string</span>  label     , <span class="type">none|string|array</span>  interface )
1729
    </div>
1730
    <div class="parameters">
1731
    <strong>Parameters</strong>
1732
    <ul><li><span class="param"> vsite </span> string associated vsite.</li><li><span class="param"> label     </span> string label of the vlan.</li><li><span class="param"> interface </span> none|string|array label(s) of the interface(s).</li></ul>
1733
</div>
1734
    <div class="description">
1735
        <p><strong>Description</strong></p>
1736
        <p>List vlan's attached interface(s)<br/>        Detailed if interface(s) label(s), general if not.<br/></p>
1737
    </div>
1738
    
1739
    
1740
</div>
1741
<div class="method" id="vlan.is_tag_free">
1742
    <a class="indexA" href="#index">go to index</a>
1743
    <h4>vlan.is_tag_free</h4>
1744
    <div class="proto">
1745
        <span class="type">True/False</span>
1746
        <span class="methodname">vlan.is_tag_free</span>(<span class="type">int</span>  tag )
1747
    </div>
1748
    <div class="parameters">
1749
    <strong>Parameters</strong>
1750
    <ul><li><span class="param"> tag </span> int tag.</li></ul>
1751
</div>
1752
    <div class="description">
1753
        <p><strong>Description</strong></p>
1754
        <p>Check if a tag id is free to use.<br/></p>
1755
    </div>
1756
    
1757
    
1758
</div>
1759
<div class="method" id="vlan.list">
1760
    <a class="indexA" href="#index">go to index</a>
1761
    <h4>vlan.list</h4>
1762
    <div class="proto">
1763
        <span class="type">array</span>
1764
        <span class="methodname">vlan.list</span>(<span class="type">string</span>  vsite , <span class="type">none|string|array</span>  label     )
1765
    </div>
1766
    <div class="parameters">
1767
    <strong>Parameters</strong>
1768
    <ul><li><span class="param"> vsite </span> string associated vsite label.</li><li><span class="param"> label     </span> none|string|array vlan label.</li></ul>
1769
</div>
1770
    <div class="description">
1771
        <p><strong>Description</strong></p>
1772
        <p>List virtual networks.<br/></p>
1773
    </div>
1774
    
1775
    
1776
</div>
1777
<div class="method" id="vlan.update">
1778
    <a class="indexA" href="#index">go to index</a>
1779
    <h4>vlan.update</h4>
1780
    <div class="proto">
1781
        <span class="type">none</span>
1782
        <span class="methodname">vlan.update</span>(<span class="type">string</span>  vsite  , <span class="type">string</span>  label      , <span class="type">struct</span>  attributes )
1783
    </div>
1784
    <div class="parameters">
1785
    <strong>Parameters</strong>
1786
    <ul><li><span class="param"> vsite  </span> string associated vsite.</li><li><span class="param"> label      </span> string label of the vlan.</li><li><span class="param"> attributes </span> struct (optionnal) attributes.</li></ul>
1787
</div>
1788
    <div class="description">
1789
        <p><strong>Description</strong></p>
1790
        <p>Update mutable attributes of a vlan.<br/></p>
1791
    </div>
1792
    
1793
    <div class="see"><strong class="see">See also</strong>:<ul><li><a href="#vlan.attributes">vlan.attributes</a></li><li><a href="#vlan.create">vlan.create</a></li></ul></div>
1794
</div>
1795
<div class="method" id="vsite.attributes">
1796
    <a class="indexA" href="#index">go to index</a>
1797
    <h4>vsite.attributes</h4>
1798
    <div class="proto">
1799
        <span class="type">array</span>
1800
        <span class="methodname">vsite.attributes</span>(<span class="type">boolean</span>  onlyMutables)
1801
    </div>
1802
    <div class="parameters">
1803
    <strong>Parameters</strong>
1804
    <ul><li><span class="param"> onlyMutables</span> boolean (optionnal) filters unmutable attributes.</li></ul>
1805
</div>
1806
    <div class="description">
1807
        <p><strong>Description</strong></p>
1808
        <p>List of attributes of a vsite.<br/><br/><br/>        possible attributes are :<ul><li><span class="param">label</span> : unmutable, string name of the vsite</li></ul></p>
1809
    </div>
1810
    
1811
    
1812
</div>
1813
<div class="method" id="vsite.create">
1814
    <a class="indexA" href="#index">go to index</a>
1815
    <h4>vsite.create</h4>
1816
    <div class="proto">
1817
        <span class="type">none</span>
1818
        <span class="methodname">vsite.create</span>(<span class="type">string</span>  label, <span class="type">struct</span>  attributes)
1819
    </div>
1820
    <div class="parameters">
1821
    <strong>Parameters</strong>
1822
    <ul><li><span class="param"> label</span> string label of the vsite.</li><li><span class="param"> attributes</span> struct (optionnal) attributes.</li></ul>
1823
</div>
1824
    <div class="description">
1825
        <p><strong>Description</strong></p>
1826
        <p>Create a vsite.<br/></p>
1827
    </div>
1828
    
1829
    
1830
</div>
1831
<div class="method" id="vsite.delete">
1832
    <a class="indexA" href="#index">go to index</a>
1833
    <h4>vsite.delete</h4>
1834
    <div class="proto">
1835
        <span class="type">none</span>
1836
        <span class="methodname">vsite.delete</span>(<span class="type">string</span>  label)
1837
    </div>
1838
    <div class="parameters">
1839
    <strong>Parameters</strong>
1840
    <ul><li><span class="param"> label</span> string vsite label.</li></ul>
1841
</div>
1842
    <div class="description">
1843
        <p><strong>Description</strong></p>
1844
        <p>Destroy a vsite.<br/></p>
1845
    </div>
1846
    
1847
    
1848
</div>
1849
<div class="method" id="vsite.list">
1850
    <a class="indexA" href="#index">go to index</a>
1851
    <h4>vsite.list</h4>
1852
    <div class="proto">
1853
        <span class="type">array</span>
1854
        <span class="methodname">vsite.list</span>(<span class="type">none|string|array</span>  label)
1855
    </div>
1856
    <div class="parameters">
1857
    <strong>Parameters</strong>
1858
    <ul><li><span class="param"> label</span> none|string|array (optionnal) vsite label.</li></ul>
1859
</div>
1860
    <div class="description">
1861
        <p><strong>Description</strong></p>
1862
        <p>List vsite(s).<br/></p>
1863
    </div>
1864
    
1865
    
1866
</div>
1867
1868
                </div>
1869
        </body>
1870
</html>
1871