Context Navigation

opengnsys-api.html @ df81ab78

Visit:

918-git-images-111dconfigfileconfigure-oglivegit-imageslgromero-new-oglivemainmaint-cronmount-efivarfsmultivmmultivm-ogboot-installerogClonningEngineogboot-installer-jenkinsoglive-ipv6test-python-scriptsticket-301ticket-50ticket-50-oldticket-577ticket-585ticket-611ticket-612ticket-693ticket-700ubu24tplunification2use-local-agent-oglivevarios-instalacionwebconsole3

Last change on this file since df81ab78 was df81ab78, checked in by ramon <ramongomez@…>, 9 years ago

#708: Continuar con la documentación de la API REST con Swagger; modificar la respuesta de la ruta GET /ous/:ouid/images/:imageid/software para normalizar la salida de datos.

git-svn-id: https://opengnsys.es/svn/branches/version1.1@5018 a21b9725-9963-47de-94b9-378ad31fedc9

Property mode set to 100644

File size: 91.3 KB

Line
1	<!doctype html>
2	<html>
3	<head>
4	<title>OpenGnsys REST API definition</title>
5	<style type="text/css">
6	body {
7	font-family: Trebuchet MS, sans-serif;
8	font-size: 15px;
9	color: #444;
10	margin-right: 24px;
11	}
12
13	h1 {
14	font-size: 25px;
15	}
16	h2 {
17	font-size: 20px;
18	}
19	h3 {
20	font-size: 16px;
21	font-weight: bold;
22	}
23	hr {
24	height: 1px;
25	border: 0;
26	color: #ddd;
27	background-color: #ddd;
28	display: none;
29	}
30
31	.app-desc {
32	clear: both;
33	margin-left: 20px;
34	}
35	.param-name {
36	width: 100%;
37	}
38	.license-info {
39	margin-left: 20px;
40	}
41
42	.license-url {
43	margin-left: 20px;
44	}
45
46	.model {
47	margin: 0 0 0px 20px;
48	}
49
50	.method {
51	margin-left: 20px;
52	}
53
54	.method-notes {
55	margin: 10px 0 20px 0;
56	font-size: 90%;
57	color: #555;
58	}
59
60	pre {
61	padding: 10px;
62	margin-bottom: 2px;
63	}
64
65	.http-method {
66	text-transform: uppercase;
67	}
68
69	pre.get {
70	background-color: #0f6ab4;
71	}
72
73	pre.post {
74	background-color: #10a54a;
75	}
76
77	pre.put {
78	background-color: #c5862b;
79	}
80
81	pre.delete {
82	background-color: #a41e22;
83	}
84
85	.huge {
86	color: #fff;
87	}
88
89	pre.example {
90	background-color: #f3f3f3;
91	padding: 10px;
92	border: 1px solid #ddd;
93	}
94
95	code {
96	white-space: pre;
97	}
98
99	.nickname {
100	font-weight: bold;
101	}
102
103	.method-path {
104	font-size: 1.5em;
105	background-color: #0f6ab4;
106	}
107
108	.up {
109	float:right;
110	}
111
112	.parameter {
113	width: 500px;
114	}
115
116	.param {
117	width: 500px;
118	padding: 10px 0 0 20px;
119	font-weight: bold;
120	}
121
122	.param-desc {
123	width: 700px;
124	padding: 0 0 0 20px;
125	color: #777;
126	}
127
128	.param-type {
129	font-style: italic;
130	}
131
132	.param-enum-header {
133	width: 700px;
134	padding: 0 0 0 60px;
135	color: #777;
136	font-weight: bold;
137	}
138
139	.param-enum {
140	width: 700px;
141	padding: 0 0 0 80px;
142	color: #777;
143	font-style: italic;
144	}
145
146	.field-label {
147	padding: 0;
148	margin: 0;
149	clear: both;
150	}
151
152	.field-items {
153	padding: 0 0 15px 0;
154	margin-bottom: 15px;
155	}
156
157	.return-type {
158	clear: both;
159	padding-bottom: 10px;
160	}
161
162	.param-header {
163	font-weight: bold;
164	}
165
166	.method-tags {
167	text-align: right;
168	}
169
170	.method-tag {
171	background: none repeat scroll 0% 0% #24A600;
172	border-radius: 3px;
173	padding: 2px 10px;
174	margin: 2px;
175	color: #FFF;
176	display: inline-block;
177	text-decoration: none;
178	}
179	</style>
180	</head>
181	<body>
182	<h1>OpenGnsys REST API definition</h1>
183	<div class="app-desc">Information about the OpenGnsys REST API functions (including Server and Repository Manager). </div>
184	<div class="app-desc">More information: <a href="http://opengnsys.es/">http://opengnsys.es/</a></div>
185	<div class="app-desc">Contact Info: <a href="opengnsys-devel@listas.unizar.es">opengnsys-devel@listas.unizar.es</a></div>
186	<div class="app-desc">Version: 1.1.0</div>
187	<div class="app-desc">BasePath:/opengnsys/rest</div>
188	<div class="license-info">Creative Commons 4.0 International</div>
189	<div class="license-url">http://creativecommons.org/licenses/by/4.0/</div>
190	<h2>Access</h2>
191	<ol>
192	<li>APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true</li>
193	</ol>
194
195	<h2><a name="__Methods">Methods</a></h2>
196	[ Jump to <a href="#__Models">Models</a> ]
197
198	<h2>Table of Contents </h2>
199	<div class="method-summary"></div>
200	<ol>
201	<li><a href="#ousGet"><code><span class="http-method">get</span> /ous</code></a></li>
202	<li><a href="#ousOuidGet"><code><span class="http-method">get</span> /ous/{ouid}</code></a></li>
203	<li><a href="#ousOuidImagesGet"><code><span class="http-method">get</span> /ous/{ouid}/images</code></a></li>
204	<li><a href="#ousOuidImagesImageidGet"><code><span class="http-method">get</span> /ous/{ouid}/images/{imageid}</code></a></li>
205	<li><a href="#ousOuidImagesImageidSoftwareGet"><code><span class="http-method">get</span> /ous/{ouid}/images/{imageid}/software</code></a></li>
206	<li><a href="#ousOuidLabsGet"><code><span class="http-method">get</span> /ous/{ouid}/labs</code></a></li>
207	<li><a href="#ousOuidLabsLabidClientsClientidDiskcfgGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/diskcfg</code></a></li>
208	<li><a href="#ousOuidLabsLabidClientsClientidGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}</code></a></li>
209	<li><a href="#ousOuidLabsLabidClientsClientidHardwareGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware</code></a></li>
210	<li><a href="#ousOuidLabsLabidClientsClientidStatusGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/status</code></a></li>
211	<li><a href="#ousOuidLabsLabidClientsGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients</code></a></li>
212	<li><a href="#ousOuidLabsLabidGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></a></li>
213	<li><a href="#ousOuidReposGet"><code><span class="http-method">get</span> /ous/{ouid}/repos</code></a></li>
214	<li><a href="#ousOuidReposRepoidGet"><code><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></a></li>
215	<li><a href="#loginPost"><code><span class="http-method">post</span> /login</code></a></li>
216	</ol>
217
218	<div class="method"><a name="ousOuidLabsLabidClientsClientidDiskcfgGet"/>
219	<div class="method-path">
220	<a class="up" href="#__Methods">Up</a>
221	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/diskcfg</code></pre></div>
222	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidDiskcfgGet</span>)</div>
223	<div class="method-notes">Get disks configuration of a `client`</div>
224
225	<h3 class="field-label">Path parameters</h3>
226	<div class="field-items">
227	<div class="param">ouid (required)</div>
228
229	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
230
231	<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
232
233	<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
234	</div> <!-- field-items -->
235
236	<h3 class="field-label">Consumes</h3>
237	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
238	<ul>
239	<li><code>application/json</code></li>
240	</ul>
241
242
243
244
245
246	<h3 class="field-label">Return type</h3>
247	<div class="return-type">
248	<a href="#inline_response_200_10">inline_response_200_10</a>
249
250	</div>
251
252	<!--Todo: process Response Object and its headers, schema, examples -->
253
254	<h3 class="field-label">Example data</h3>
255	<div class="example-data-content-type">Content-Type: application/json</div>
256	<pre class="example"><code>{
257	"diskcfg" : [ {
258	"parttable" : "aeiou",
259	"image" : {
260	"deploydate" : "2000-01-23T04:56:07.000+00:00",
261	"id" : 123,
262	"updated" : true
263	},
264	"disk" : 123,
265	"partition" : 123,
266	"size" : 123456789,
267	"os" : "aeiou",
268	"usage" : 123,
269	"parttype" : "aeiou",
270	"filesystem" : "aeiou"
271	} ],
272	"name" : "aeiou",
273	"id" : 123
274	}</code></pre>
275
276	<h3 class="field-label">Produces</h3>
277	This API call produces the following media types according to the <span class="header">Accept</span> request header;
278	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
279	<ul>
280	<li><code>application/json</code></li>
281	</ul>
282
283	<h3 class="field-label">Responses</h3>
284	<h4 class="field-label">200</h4>
285	Successful response
286	<a href="#inline_response_200_10">inline_response_200_10</a>
287	</div> <!-- method -->
288	<hr/>
289	<div class="method"><a name="ousOuidLabsLabidClientsClientidGet"/>
290	<div class="method-path">
291	<a class="up" href="#__Methods">Up</a>
292	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}</code></pre></div>
293	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidGet</span>)</div>
294	<div class="method-notes">Get a `client` object.</div>
295
296	<h3 class="field-label">Path parameters</h3>
297	<div class="field-items">
298	<div class="param">ouid (required)</div>
299
300	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
301
302	<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
303
304	<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
305	</div> <!-- field-items -->
306
307	<h3 class="field-label">Consumes</h3>
308	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
309	<ul>
310	<li><code>application/json</code></li>
311	</ul>
312
313
314
315
316
317	<h3 class="field-label">Return type</h3>
318	<div class="return-type">
319	<a href="#inline_response_200_9">inline_response_200_9</a>
320
321	</div>
322
323	<!--Todo: process Response Object and its headers, schema, examples -->
324
325	<h3 class="field-label">Example data</h3>
326	<div class="example-data-content-type">Content-Type: application/json</div>
327	<pre class="example"><code>{
328	"image" : "aeiou",
329	"routerip" : "aeiou",
330	"boottype" : "aeiou",
331	"ip" : "aeiou",
332	"repo" : {
333	"id" : 123
334	},
335	"netdriver" : "aeiou",
336	"netiface" : "aeiou",
337	"mac" : "aeiou",
338	"serialno" : "aeiou",
339	"netmask" : "aeiou",
340	"name" : "aeiou",
341	"id" : 123,
342	"validation" : true
343	}</code></pre>
344
345	<h3 class="field-label">Produces</h3>
346	This API call produces the following media types according to the <span class="header">Accept</span> request header;
347	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
348	<ul>
349	<li><code>application/json</code></li>
350	</ul>
351
352	<h3 class="field-label">Responses</h3>
353	<h4 class="field-label">200</h4>
354	Successful response
355	<a href="#inline_response_200_9">inline_response_200_9</a>
356	</div> <!-- method -->
357	<hr/>
358	<div class="method"><a name="ousOuidLabsLabidClientsClientidHardwareGet"/>
359	<div class="method-path">
360	<a class="up" href="#__Methods">Up</a>
361	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware</code></pre></div>
362	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidHardwareGet</span>)</div>
363	<div class="method-notes">Get the hardware definition of a `client` object.</div>
364
365	<h3 class="field-label">Path parameters</h3>
366	<div class="field-items">
367	<div class="param">ouid (required)</div>
368
369	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
370
371	<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
372
373	<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
374	</div> <!-- field-items -->
375
376	<h3 class="field-label">Consumes</h3>
377	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
378	<ul>
379	<li><code>application/json</code></li>
380	</ul>
381
382
383
384
385
386	<h3 class="field-label">Return type</h3>
387	<div class="return-type">
388	<a href="#inline_response_200_11">inline_response_200_11</a>
389
390	</div>
391
392	<!--Todo: process Response Object and its headers, schema, examples -->
393
394	<h3 class="field-label">Example data</h3>
395	<div class="example-data-content-type">Content-Type: application/json</div>
396	<pre class="example"><code>{
397	"name" : "aeiou",
398	"id" : 123,
399	"hardware" : [ {
400	"description" : "aeiou",
401	"type" : "aeiou"
402	} ]
403	}</code></pre>
404
405	<h3 class="field-label">Produces</h3>
406	This API call produces the following media types according to the <span class="header">Accept</span> request header;
407	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
408	<ul>
409	<li><code>application/json</code></li>
410	</ul>
411
412	<h3 class="field-label">Responses</h3>
413	<h4 class="field-label">200</h4>
414	Successful response
415	<a href="#inline_response_200_11">inline_response_200_11</a>
416	</div> <!-- method -->
417	<hr/>
418	<div class="method"><a name="ousOuidLabsLabidClientsClientidStatusGet"/>
419	<div class="method-path">
420	<a class="up" href="#__Methods">Up</a>
421	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/status</code></pre></div>
422	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidStatusGet</span>)</div>
423	<div class="method-notes">Get execution status of a `client`</div>
424
425	<h3 class="field-label">Path parameters</h3>
426	<div class="field-items">
427	<div class="param">ouid (required)</div>
428
429	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
430
431	<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
432
433	<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
434	</div> <!-- field-items -->
435
436	<h3 class="field-label">Consumes</h3>
437	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
438	<ul>
439	<li><code>application/json</code></li>
440	</ul>
441
442
443
444
445
446	<h3 class="field-label">Return type</h3>
447	<div class="return-type">
448	<a href="#inline_response_200_12">inline_response_200_12</a>
449
450	</div>
451
452	<!--Todo: process Response Object and its headers, schema, examples -->
453
454	<h3 class="field-label">Example data</h3>
455	<div class="example-data-content-type">Content-Type: application/json</div>
456	<pre class="example"><code>{
457	"ip" : "aeiou",
458	"id" : 123,
459	"status" : "aeiou"
460	}</code></pre>
461
462	<h3 class="field-label">Produces</h3>
463	This API call produces the following media types according to the <span class="header">Accept</span> request header;
464	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
465	<ul>
466	<li><code>application/json</code></li>
467	</ul>
468
469	<h3 class="field-label">Responses</h3>
470	<h4 class="field-label">200</h4>
471	Successful response
472	<a href="#inline_response_200_12">inline_response_200_12</a>
473	</div> <!-- method -->
474	<hr/>
475	<div class="method"><a name="ousOuidLabsLabidClientsGet"/>
476	<div class="method-path">
477	<a class="up" href="#__Methods">Up</a>
478	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients</code></pre></div>
479	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsGet</span>)</div>
480	<div class="method-notes">Get all `client` objects defined in an `lab`.</div>
481
482	<h3 class="field-label">Path parameters</h3>
483	<div class="field-items">
484	<div class="param">ouid (required)</div>
485
486	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
487
488	<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div>
489	</div> <!-- field-items -->
490
491	<h3 class="field-label">Consumes</h3>
492	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
493	<ul>
494	<li><code>application/json</code></li>
495	</ul>
496
497
498
499
500
501	<h3 class="field-label">Return type</h3>
502	<div class="return-type">
503	array[<a href="#inline_response_200_8">inline_response_200_8</a>]
504
505	</div>
506
507	<!--Todo: process Response Object and its headers, schema, examples -->
508
509	<h3 class="field-label">Example data</h3>
510	<div class="example-data-content-type">Content-Type: application/json</div>
511	<pre class="example"><code>[ {
512	"ou" : {
513	"id" : 123
514	},
515	"name" : "aeiou",
516	"id" : 123,
517	"lab" : ""
518	} ]</code></pre>
519
520	<h3 class="field-label">Produces</h3>
521	This API call produces the following media types according to the <span class="header">Accept</span> request header;
522	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
523	<ul>
524	<li><code>application/json</code></li>
525	</ul>
526
527	<h3 class="field-label">Responses</h3>
528	<h4 class="field-label">200</h4>
529	Successful response
530
531	</div> <!-- method -->
532	<hr/>
533	<div class="method"><a name="ousOuidImagesImageidSoftwareGet"/>
534	<div class="method-path">
535	<a class="up" href="#__Methods">Up</a>
536	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images/{imageid}/software</code></pre></div>
537	<div class="method-summary"> (<span class="nickname">ousOuidImagesImageidSoftwareGet</span>)</div>
538	<div class="method-notes">Get software inventory store into an `image`</div>
539
540	<h3 class="field-label">Path parameters</h3>
541	<div class="field-items">
542	<div class="param">ouid (required)</div>
543
544	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">imageid (required)</div>
545
546	<div class="param-desc"><span class="param-type">Path Parameter</span> — image definition identificator </div>
547	</div> <!-- field-items -->
548
549	<h3 class="field-label">Consumes</h3>
550	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
551	<ul>
552	<li><code>application/json</code></li>
553	</ul>
554
555
556
557
558
559	<h3 class="field-label">Return type</h3>
560	<div class="return-type">
561	<a href="#inline_response_200_5">inline_response_200_5</a>
562
563	</div>
564
565	<!--Todo: process Response Object and its headers, schema, examples -->
566
567	<h3 class="field-label">Example data</h3>
568	<div class="example-data-content-type">Content-Type: application/json</div>
569	<pre class="example"><code>{
570	"os" : "aeiou",
571	"software" : [ {
572	"application" : "aeiou"
573	} ],
574	"name" : "aeiou",
575	"id" : 123
576	}</code></pre>
577
578	<h3 class="field-label">Produces</h3>
579	This API call produces the following media types according to the <span class="header">Accept</span> request header;
580	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
581	<ul>
582	<li><code>application/json</code></li>
583	</ul>
584
585	<h3 class="field-label">Responses</h3>
586	<h4 class="field-label">200</h4>
587	Successful response
588	<a href="#inline_response_200_5">inline_response_200_5</a>
589	</div> <!-- method -->
590	<hr/>
591	<div class="method"><a name="ousOuidImagesGet"/>
592	<div class="method-path">
593	<a class="up" href="#__Methods">Up</a>
594	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images</code></pre></div>
595	<div class="method-summary"> (<span class="nickname">ousOuidImagesGet</span>)</div>
596	<div class="method-notes">Get all `image` objects defined in an `OU`.</div>
597
598	<h3 class="field-label">Path parameters</h3>
599	<div class="field-items">
600	<div class="param">ouid (required)</div>
601
602	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
603	</div> <!-- field-items -->
604
605	<h3 class="field-label">Consumes</h3>
606	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
607	<ul>
608	<li><code>application/json</code></li>
609	</ul>
610
611
612
613
614
615	<h3 class="field-label">Return type</h3>
616	<div class="return-type">
617	array[<a href="#inline_response_200_3">inline_response_200_3</a>]
618
619	</div>
620
621	<!--Todo: process Response Object and its headers, schema, examples -->
622
623	<h3 class="field-label">Example data</h3>
624	<div class="example-data-content-type">Content-Type: application/json</div>
625	<pre class="example"><code>[ {
626	"ou" : {
627	"id" : 123
628	},
629	"name" : "aeiou",
630	"id" : 123,
631	"inremotepc" : true
632	} ]</code></pre>
633
634	<h3 class="field-label">Produces</h3>
635	This API call produces the following media types according to the <span class="header">Accept</span> request header;
636	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
637	<ul>
638	<li><code>application/json</code></li>
639	</ul>
640
641	<h3 class="field-label">Responses</h3>
642	<h4 class="field-label">200</h4>
643	Successful response
644
645	</div> <!-- method -->
646	<hr/>
647	<div class="method"><a name="ousOuidImagesImageidGet"/>
648	<div class="method-path">
649	<a class="up" href="#__Methods">Up</a>
650	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images/{imageid}</code></pre></div>
651	<div class="method-summary"> (<span class="nickname">ousOuidImagesImageidGet</span>)</div>
652	<div class="method-notes">Get an `image` object.</div>
653
654	<h3 class="field-label">Path parameters</h3>
655	<div class="field-items">
656	<div class="param">ouid (required)</div>
657
658	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">imageid (required)</div>
659
660	<div class="param-desc"><span class="param-type">Path Parameter</span> — image definition identificator </div>
661	</div> <!-- field-items -->
662
663	<h3 class="field-label">Consumes</h3>
664	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
665	<ul>
666	<li><code>application/json</code></li>
667	</ul>
668
669
670
671
672
673	<h3 class="field-label">Return type</h3>
674	<div class="return-type">
675	<a href="#inline_response_200_4">inline_response_200_4</a>
676
677	</div>
678
679	<!--Todo: process Response Object and its headers, schema, examples -->
680
681	<h3 class="field-label">Example data</h3>
682	<div class="example-data-content-type">Content-Type: application/json</div>
683	<pre class="example"><code>{
684	"path" : "aeiou",
685	"creationdate" : "2000-01-23T04:56:07.000+00:00",
686	"release" : "aeiou",
687	"repo" : {
688	"id" : 123
689	},
690	"name" : "aeiou",
691	"description" : "aeiou",
692	"client" : {
693	"disk" : 123,
694	"partition" : 123,
695	"id" : 123
696	},
697	"id" : 123,
698	"inremotepc" : true,
699	"type" : "aeiou",
700	"baseimg" : "aeiou"
701	}</code></pre>
702
703	<h3 class="field-label">Produces</h3>
704	This API call produces the following media types according to the <span class="header">Accept</span> request header;
705	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
706	<ul>
707	<li><code>application/json</code></li>
708	</ul>
709
710	<h3 class="field-label">Responses</h3>
711	<h4 class="field-label">200</h4>
712	Successful response
713	<a href="#inline_response_200_4">inline_response_200_4</a>
714	</div> <!-- method -->
715	<hr/>
716	<div class="method"><a name="ousOuidLabsGet"/>
717	<div class="method-path">
718	<a class="up" href="#__Methods">Up</a>
719	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs</code></pre></div>
720	<div class="method-summary"> (<span class="nickname">ousOuidLabsGet</span>)</div>
721	<div class="method-notes">Get all `lab` objects defined in an `OU`.</div>
722
723	<h3 class="field-label">Path parameters</h3>
724	<div class="field-items">
725	<div class="param">ouid (required)</div>
726
727	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
728	</div> <!-- field-items -->
729
730	<h3 class="field-label">Consumes</h3>
731	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
732	<ul>
733	<li><code>application/json</code></li>
734	</ul>
735
736
737
738
739
740	<h3 class="field-label">Return type</h3>
741	<div class="return-type">
742	array[<a href="#inline_response_200_6">inline_response_200_6</a>]
743
744	</div>
745
746	<!--Todo: process Response Object and its headers, schema, examples -->
747
748	<h3 class="field-label">Example data</h3>
749	<div class="example-data-content-type">Content-Type: application/json</div>
750	<pre class="example"><code>[ {
751	"ou" : {
752	"id" : 123
753	},
754	"name" : "aeiou",
755	"id" : 123,
756	"inremotepc" : true
757	} ]</code></pre>
758
759	<h3 class="field-label">Produces</h3>
760	This API call produces the following media types according to the <span class="header">Accept</span> request header;
761	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
762	<ul>
763	<li><code>application/json</code></li>
764	</ul>
765
766	<h3 class="field-label">Responses</h3>
767	<h4 class="field-label">200</h4>
768	Successful response
769
770	</div> <!-- method -->
771	<hr/>
772	<div class="method"><a name="ousOuidLabsLabidGet"/>
773	<div class="method-path">
774	<a class="up" href="#__Methods">Up</a>
775	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></pre></div>
776	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidGet</span>)</div>
777	<div class="method-notes">Get a `lab` object.</div>
778
779	<h3 class="field-label">Path parameters</h3>
780	<div class="field-items">
781	<div class="param">ouid (required)</div>
782
783	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
784
785	<div class="param-desc"><span class="param-type">Path Parameter</span> — laboratory identificator </div>
786	</div> <!-- field-items -->
787
788	<h3 class="field-label">Consumes</h3>
789	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
790	<ul>
791	<li><code>application/json</code></li>
792	</ul>
793
794
795
796
797
798	<h3 class="field-label">Return type</h3>
799	<div class="return-type">
800	<a href="#inline_response_200_7">inline_response_200_7</a>
801
802	</div>
803
804	<!--Todo: process Response Object and its headers, schema, examples -->
805
806	<h3 class="field-label">Example data</h3>
807	<div class="example-data-content-type">Content-Type: application/json</div>
808	<pre class="example"><code>{
809	"image" : "aeiou",
810	"routerip" : "aeiou",
811	"mcastport" : 123,
812	"proxyurl" : "aeiou",
813	"dns" : "aeiou",
814	"mcastmode" : "aeiou",
815	"description" : "aeiou",
816	"inremotepc" : true,
817	"ntp" : "aeiou",
818	"mcastspeed" : 123,
819	"capacity" : 123,
820	"defclients" : 123,
821	"mcastip" : "aeiou",
822	"projector" : true,
823	"netmask" : "aeiou",
824	"p2ptime" : 123,
825	"name" : "aeiou",
826	"p2pmode" : "aeiou",
827	"location" : "aeiou",
828	"id" : 123,
829	"board" : true
830	}</code></pre>
831
832	<h3 class="field-label">Produces</h3>
833	This API call produces the following media types according to the <span class="header">Accept</span> request header;
834	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
835	<ul>
836	<li><code>application/json</code></li>
837	</ul>
838
839	<h3 class="field-label">Responses</h3>
840	<h4 class="field-label">200</h4>
841	Successful response
842	<a href="#inline_response_200_7">inline_response_200_7</a>
843	</div> <!-- method -->
844	<hr/>
845	<div class="method"><a name="ousGet"/>
846	<div class="method-path">
847	<a class="up" href="#__Methods">Up</a>
848	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous</code></pre></div>
849	<div class="method-summary"> (<span class="nickname">ousGet</span>)</div>
850	<div class="method-notes">Gets all `OU` objects.</div>
851
852
853	<h3 class="field-label">Consumes</h3>
854	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
855	<ul>
856	<li><code>application/json</code></li>
857	</ul>
858
859
860
861
862
863	<h3 class="field-label">Return type</h3>
864	<div class="return-type">
865	array[<a href="#inline_response_200_1">inline_response_200_1</a>]
866
867	</div>
868
869	<!--Todo: process Response Object and its headers, schema, examples -->
870
871	<h3 class="field-label">Example data</h3>
872	<div class="example-data-content-type">Content-Type: application/json</div>
873	<pre class="example"><code>[ {
874	"name" : "aeiou",
875	"id" : 123
876	} ]</code></pre>
877
878	<h3 class="field-label">Produces</h3>
879	This API call produces the following media types according to the <span class="header">Accept</span> request header;
880	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
881	<ul>
882	<li><code>application/json</code></li>
883	</ul>
884
885	<h3 class="field-label">Responses</h3>
886	<h4 class="field-label">200</h4>
887	Successful response
888
889	</div> <!-- method -->
890	<hr/>
891	<div class="method"><a name="ousOuidGet"/>
892	<div class="method-path">
893	<a class="up" href="#__Methods">Up</a>
894	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}</code></pre></div>
895	<div class="method-summary"> (<span class="nickname">ousOuidGet</span>)</div>
896	<div class="method-notes">Get an `OU` object.</div>
897
898	<h3 class="field-label">Path parameters</h3>
899	<div class="field-items">
900	<div class="param">ouid (required)</div>
901
902	<div class="param-desc"><span class="param-type">Path Parameter</span> — Organization Unit identificator </div>
903	</div> <!-- field-items -->
904
905	<h3 class="field-label">Consumes</h3>
906	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
907	<ul>
908	<li><code>application/json</code></li>
909	</ul>
910
911
912
913
914
915	<h3 class="field-label">Return type</h3>
916	<div class="return-type">
917	<a href="#inline_response_200_2">inline_response_200_2</a>
918
919	</div>
920
921	<!--Todo: process Response Object and its headers, schema, examples -->
922
923	<h3 class="field-label">Example data</h3>
924	<div class="example-data-content-type">Content-Type: application/json</div>
925	<pre class="example"><code>{
926	"name" : "aeiou",
927	"description" : "aeiou",
928	"id" : ""
929	}</code></pre>
930
931	<h3 class="field-label">Produces</h3>
932	This API call produces the following media types according to the <span class="header">Accept</span> request header;
933	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
934	<ul>
935	<li><code>application/json</code></li>
936	</ul>
937
938	<h3 class="field-label">Responses</h3>
939	<h4 class="field-label">200</h4>
940	Successful response
941	<a href="#inline_response_200_2">inline_response_200_2</a>
942	</div> <!-- method -->
943	<hr/>
944	<div class="method"><a name="ousOuidReposGet"/>
945	<div class="method-path">
946	<a class="up" href="#__Methods">Up</a>
947	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos</code></pre></div>
948	<div class="method-summary"> (<span class="nickname">ousOuidReposGet</span>)</div>
949	<div class="method-notes">Get all `repo` objects defined in an `OU`.</div>
950
951	<h3 class="field-label">Path parameters</h3>
952	<div class="field-items">
953	<div class="param">ouid (required)</div>
954
955	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
956	</div> <!-- field-items -->
957
958	<h3 class="field-label">Consumes</h3>
959	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
960	<ul>
961	<li><code>application/json</code></li>
962	</ul>
963
964
965
966
967
968	<h3 class="field-label">Return type</h3>
969	<div class="return-type">
970	array[<a href="#inline_response_200_13">inline_response_200_13</a>]
971
972	</div>
973
974	<!--Todo: process Response Object and its headers, schema, examples -->
975
976	<h3 class="field-label">Example data</h3>
977	<div class="example-data-content-type">Content-Type: application/json</div>
978	<pre class="example"><code>[ {
979	"ou" : {
980	"id" : 123
981	},
982	"name" : "aeiou",
983	"id" : 123
984	} ]</code></pre>
985
986	<h3 class="field-label">Produces</h3>
987	This API call produces the following media types according to the <span class="header">Accept</span> request header;
988	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
989	<ul>
990	<li><code>application/json</code></li>
991	</ul>
992
993	<h3 class="field-label">Responses</h3>
994	<h4 class="field-label">200</h4>
995	Successful response
996
997	</div> <!-- method -->
998	<hr/>
999	<div class="method"><a name="ousOuidReposRepoidGet"/>
1000	<div class="method-path">
1001	<a class="up" href="#__Methods">Up</a>
1002	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></pre></div>
1003	<div class="method-summary"> (<span class="nickname">ousOuidReposRepoidGet</span>)</div>
1004	<div class="method-notes">Get a `repo` object.</div>
1005
1006	<h3 class="field-label">Path parameters</h3>
1007	<div class="field-items">
1008	<div class="param">ouid (required)</div>
1009
1010	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">repoid (required)</div>
1011
1012	<div class="param-desc"><span class="param-type">Path Parameter</span> — repository identificator </div>
1013	</div> <!-- field-items -->
1014
1015	<h3 class="field-label">Consumes</h3>
1016	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1017	<ul>
1018	<li><code>application/json</code></li>
1019	</ul>
1020
1021
1022
1023
1024
1025	<h3 class="field-label">Return type</h3>
1026	<div class="return-type">
1027	<a href="#inline_response_200_14">inline_response_200_14</a>
1028
1029	</div>
1030
1031	<!--Todo: process Response Object and its headers, schema, examples -->
1032
1033	<h3 class="field-label">Example data</h3>
1034	<div class="example-data-content-type">Content-Type: application/json</div>
1035	<pre class="example"><code>{
1036	"ip" : "aeiou",
1037	"name" : "aeiou",
1038	"description" : "aeiou",
1039	"id" : 123
1040	}</code></pre>
1041
1042	<h3 class="field-label">Produces</h3>
1043	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1044	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1045	<ul>
1046	<li><code>application/json</code></li>
1047	</ul>
1048
1049	<h3 class="field-label">Responses</h3>
1050	<h4 class="field-label">200</h4>
1051	Successful response
1052	<a href="#inline_response_200_14">inline_response_200_14</a>
1053	</div> <!-- method -->
1054	<hr/>
1055	<div class="method"><a name="loginPost"/>
1056	<div class="method-path">
1057	<a class="up" href="#__Methods">Up</a>
1058	<pre class="post"><code class="huge"><span class="http-method">post</span> /login</code></pre></div>
1059	<div class="method-summary"> (<span class="nickname">loginPost</span>)</div>
1060	<div class="method-notes">Check user login and returns his/her API key.</div>
1061
1062
1063	<h3 class="field-label">Consumes</h3>
1064	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1065	<ul>
1066	<li><code>application/json</code></li>
1067	</ul>
1068
1069	<h3 class="field-label">Request body</h3>
1070	<div class="field-items">
1071	<div class="param">authdata (required)</div>
1072
1073	<div class="param-desc"><span class="param-type">Body Parameter</span> — JSON authentication data </div>
1074	</div> <!-- field-items -->
1075
1076
1077
1078
1079	<h3 class="field-label">Return type</h3>
1080	<div class="return-type">
1081	<a href="#inline_response_200">inline_response_200</a>
1082
1083	</div>
1084
1085	<!--Todo: process Response Object and its headers, schema, examples -->
1086
1087	<h3 class="field-label">Example data</h3>
1088	<div class="example-data-content-type">Content-Type: application/json</div>
1089	<pre class="example"><code>{
1090	"apikey" : "aeiou",
1091	"userid" : 123
1092	}</code></pre>
1093
1094	<h3 class="field-label">Produces</h3>
1095	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1096	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1097	<ul>
1098	<li><code>application/json</code></li>
1099	</ul>
1100
1101	<h3 class="field-label">Responses</h3>
1102	<h4 class="field-label">200</h4>
1103	Successful login
1104	<a href="#inline_response_200">inline_response_200</a>
1105	<h4 class="field-label">400</h4>
1106	Missing parameters
1107	<a href="#"></a>
1108	<h4 class="field-label">500</h4>
1109	Authentication error
1110	<a href="#"></a>
1111	</div> <!-- method -->
1112	<hr/>
1113	<div class="method"><a name="ousGet"/>
1114	<div class="method-path">
1115	<a class="up" href="#__Methods">Up</a>
1116	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous</code></pre></div>
1117	<div class="method-summary"> (<span class="nickname">ousGet</span>)</div>
1118	<div class="method-notes">Gets all `OU` objects.</div>
1119
1120
1121	<h3 class="field-label">Consumes</h3>
1122	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1123	<ul>
1124	<li><code>application/json</code></li>
1125	</ul>
1126
1127
1128
1129
1130
1131	<h3 class="field-label">Return type</h3>
1132	<div class="return-type">
1133	array[<a href="#inline_response_200_1">inline_response_200_1</a>]
1134
1135	</div>
1136
1137	<!--Todo: process Response Object and its headers, schema, examples -->
1138
1139	<h3 class="field-label">Example data</h3>
1140	<div class="example-data-content-type">Content-Type: application/json</div>
1141	<pre class="example"><code>[ {
1142	"name" : "aeiou",
1143	"id" : 123
1144	} ]</code></pre>
1145
1146	<h3 class="field-label">Produces</h3>
1147	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1148	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1149	<ul>
1150	<li><code>application/json</code></li>
1151	</ul>
1152
1153	<h3 class="field-label">Responses</h3>
1154	<h4 class="field-label">200</h4>
1155	Successful response
1156
1157	</div> <!-- method -->
1158	<hr/>
1159	<div class="method"><a name="ousOuidGet"/>
1160	<div class="method-path">
1161	<a class="up" href="#__Methods">Up</a>
1162	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}</code></pre></div>
1163	<div class="method-summary"> (<span class="nickname">ousOuidGet</span>)</div>
1164	<div class="method-notes">Get an `OU` object.</div>
1165
1166	<h3 class="field-label">Path parameters</h3>
1167	<div class="field-items">
1168	<div class="param">ouid (required)</div>
1169
1170	<div class="param-desc"><span class="param-type">Path Parameter</span> — Organization Unit identificator </div>
1171	</div> <!-- field-items -->
1172
1173	<h3 class="field-label">Consumes</h3>
1174	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1175	<ul>
1176	<li><code>application/json</code></li>
1177	</ul>
1178
1179
1180
1181
1182
1183	<h3 class="field-label">Return type</h3>
1184	<div class="return-type">
1185	<a href="#inline_response_200_2">inline_response_200_2</a>
1186
1187	</div>
1188
1189	<!--Todo: process Response Object and its headers, schema, examples -->
1190
1191	<h3 class="field-label">Example data</h3>
1192	<div class="example-data-content-type">Content-Type: application/json</div>
1193	<pre class="example"><code>{
1194	"name" : "aeiou",
1195	"description" : "aeiou",
1196	"id" : ""
1197	}</code></pre>
1198
1199	<h3 class="field-label">Produces</h3>
1200	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1201	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1202	<ul>
1203	<li><code>application/json</code></li>
1204	</ul>
1205
1206	<h3 class="field-label">Responses</h3>
1207	<h4 class="field-label">200</h4>
1208	Successful response
1209	<a href="#inline_response_200_2">inline_response_200_2</a>
1210	</div> <!-- method -->
1211	<hr/>
1212	<div class="method"><a name="ousOuidImagesGet"/>
1213	<div class="method-path">
1214	<a class="up" href="#__Methods">Up</a>
1215	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images</code></pre></div>
1216	<div class="method-summary"> (<span class="nickname">ousOuidImagesGet</span>)</div>
1217	<div class="method-notes">Get all `image` objects defined in an `OU`.</div>
1218
1219	<h3 class="field-label">Path parameters</h3>
1220	<div class="field-items">
1221	<div class="param">ouid (required)</div>
1222
1223	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
1224	</div> <!-- field-items -->
1225
1226	<h3 class="field-label">Consumes</h3>
1227	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1228	<ul>
1229	<li><code>application/json</code></li>
1230	</ul>
1231
1232
1233
1234
1235
1236	<h3 class="field-label">Return type</h3>
1237	<div class="return-type">
1238	array[<a href="#inline_response_200_3">inline_response_200_3</a>]
1239
1240	</div>
1241
1242	<!--Todo: process Response Object and its headers, schema, examples -->
1243
1244	<h3 class="field-label">Example data</h3>
1245	<div class="example-data-content-type">Content-Type: application/json</div>
1246	<pre class="example"><code>[ {
1247	"ou" : {
1248	"id" : 123
1249	},
1250	"name" : "aeiou",
1251	"id" : 123,
1252	"inremotepc" : true
1253	} ]</code></pre>
1254
1255	<h3 class="field-label">Produces</h3>
1256	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1257	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1258	<ul>
1259	<li><code>application/json</code></li>
1260	</ul>
1261
1262	<h3 class="field-label">Responses</h3>
1263	<h4 class="field-label">200</h4>
1264	Successful response
1265
1266	</div> <!-- method -->
1267	<hr/>
1268	<div class="method"><a name="ousOuidImagesImageidGet"/>
1269	<div class="method-path">
1270	<a class="up" href="#__Methods">Up</a>
1271	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images/{imageid}</code></pre></div>
1272	<div class="method-summary"> (<span class="nickname">ousOuidImagesImageidGet</span>)</div>
1273	<div class="method-notes">Get an `image` object.</div>
1274
1275	<h3 class="field-label">Path parameters</h3>
1276	<div class="field-items">
1277	<div class="param">ouid (required)</div>
1278
1279	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">imageid (required)</div>
1280
1281	<div class="param-desc"><span class="param-type">Path Parameter</span> — image definition identificator </div>
1282	</div> <!-- field-items -->
1283
1284	<h3 class="field-label">Consumes</h3>
1285	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1286	<ul>
1287	<li><code>application/json</code></li>
1288	</ul>
1289
1290
1291
1292
1293
1294	<h3 class="field-label">Return type</h3>
1295	<div class="return-type">
1296	<a href="#inline_response_200_4">inline_response_200_4</a>
1297
1298	</div>
1299
1300	<!--Todo: process Response Object and its headers, schema, examples -->
1301
1302	<h3 class="field-label">Example data</h3>
1303	<div class="example-data-content-type">Content-Type: application/json</div>
1304	<pre class="example"><code>{
1305	"path" : "aeiou",
1306	"creationdate" : "2000-01-23T04:56:07.000+00:00",
1307	"release" : "aeiou",
1308	"repo" : {
1309	"id" : 123
1310	},
1311	"name" : "aeiou",
1312	"description" : "aeiou",
1313	"client" : {
1314	"disk" : 123,
1315	"partition" : 123,
1316	"id" : 123
1317	},
1318	"id" : 123,
1319	"inremotepc" : true,
1320	"type" : "aeiou",
1321	"baseimg" : "aeiou"
1322	}</code></pre>
1323
1324	<h3 class="field-label">Produces</h3>
1325	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1326	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1327	<ul>
1328	<li><code>application/json</code></li>
1329	</ul>
1330
1331	<h3 class="field-label">Responses</h3>
1332	<h4 class="field-label">200</h4>
1333	Successful response
1334	<a href="#inline_response_200_4">inline_response_200_4</a>
1335	</div> <!-- method -->
1336	<hr/>
1337	<div class="method"><a name="ousOuidLabsGet"/>
1338	<div class="method-path">
1339	<a class="up" href="#__Methods">Up</a>
1340	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs</code></pre></div>
1341	<div class="method-summary"> (<span class="nickname">ousOuidLabsGet</span>)</div>
1342	<div class="method-notes">Get all `lab` objects defined in an `OU`.</div>
1343
1344	<h3 class="field-label">Path parameters</h3>
1345	<div class="field-items">
1346	<div class="param">ouid (required)</div>
1347
1348	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
1349	</div> <!-- field-items -->
1350
1351	<h3 class="field-label">Consumes</h3>
1352	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1353	<ul>
1354	<li><code>application/json</code></li>
1355	</ul>
1356
1357
1358
1359
1360
1361	<h3 class="field-label">Return type</h3>
1362	<div class="return-type">
1363	array[<a href="#inline_response_200_6">inline_response_200_6</a>]
1364
1365	</div>
1366
1367	<!--Todo: process Response Object and its headers, schema, examples -->
1368
1369	<h3 class="field-label">Example data</h3>
1370	<div class="example-data-content-type">Content-Type: application/json</div>
1371	<pre class="example"><code>[ {
1372	"ou" : {
1373	"id" : 123
1374	},
1375	"name" : "aeiou",
1376	"id" : 123,
1377	"inremotepc" : true
1378	} ]</code></pre>
1379
1380	<h3 class="field-label">Produces</h3>
1381	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1382	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1383	<ul>
1384	<li><code>application/json</code></li>
1385	</ul>
1386
1387	<h3 class="field-label">Responses</h3>
1388	<h4 class="field-label">200</h4>
1389	Successful response
1390
1391	</div> <!-- method -->
1392	<hr/>
1393	<div class="method"><a name="ousOuidLabsLabidClientsClientidDiskcfgGet"/>
1394	<div class="method-path">
1395	<a class="up" href="#__Methods">Up</a>
1396	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/diskcfg</code></pre></div>
1397	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidDiskcfgGet</span>)</div>
1398	<div class="method-notes">Get disks configuration of a `client`</div>
1399
1400	<h3 class="field-label">Path parameters</h3>
1401	<div class="field-items">
1402	<div class="param">ouid (required)</div>
1403
1404	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
1405
1406	<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
1407
1408	<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
1409	</div> <!-- field-items -->
1410
1411	<h3 class="field-label">Consumes</h3>
1412	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1413	<ul>
1414	<li><code>application/json</code></li>
1415	</ul>
1416
1417
1418
1419
1420
1421	<h3 class="field-label">Return type</h3>
1422	<div class="return-type">
1423	<a href="#inline_response_200_10">inline_response_200_10</a>
1424
1425	</div>
1426
1427	<!--Todo: process Response Object and its headers, schema, examples -->
1428
1429	<h3 class="field-label">Example data</h3>
1430	<div class="example-data-content-type">Content-Type: application/json</div>
1431	<pre class="example"><code>{
1432	"diskcfg" : [ {
1433	"parttable" : "aeiou",
1434	"image" : {
1435	"deploydate" : "2000-01-23T04:56:07.000+00:00",
1436	"id" : 123,
1437	"updated" : true
1438	},
1439	"disk" : 123,
1440	"partition" : 123,
1441	"size" : 123456789,
1442	"os" : "aeiou",
1443	"usage" : 123,
1444	"parttype" : "aeiou",
1445	"filesystem" : "aeiou"
1446	} ],
1447	"name" : "aeiou",
1448	"id" : 123
1449	}</code></pre>
1450
1451	<h3 class="field-label">Produces</h3>
1452	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1453	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1454	<ul>
1455	<li><code>application/json</code></li>
1456	</ul>
1457
1458	<h3 class="field-label">Responses</h3>
1459	<h4 class="field-label">200</h4>
1460	Successful response
1461	<a href="#inline_response_200_10">inline_response_200_10</a>
1462	</div> <!-- method -->
1463	<hr/>
1464	<div class="method"><a name="ousOuidLabsLabidClientsClientidGet"/>
1465	<div class="method-path">
1466	<a class="up" href="#__Methods">Up</a>
1467	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}</code></pre></div>
1468	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidGet</span>)</div>
1469	<div class="method-notes">Get a `client` object.</div>
1470
1471	<h3 class="field-label">Path parameters</h3>
1472	<div class="field-items">
1473	<div class="param">ouid (required)</div>
1474
1475	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
1476
1477	<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
1478
1479	<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
1480	</div> <!-- field-items -->
1481
1482	<h3 class="field-label">Consumes</h3>
1483	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1484	<ul>
1485	<li><code>application/json</code></li>
1486	</ul>
1487
1488
1489
1490
1491
1492	<h3 class="field-label">Return type</h3>
1493	<div class="return-type">
1494	<a href="#inline_response_200_9">inline_response_200_9</a>
1495
1496	</div>
1497
1498	<!--Todo: process Response Object and its headers, schema, examples -->
1499
1500	<h3 class="field-label">Example data</h3>
1501	<div class="example-data-content-type">Content-Type: application/json</div>
1502	<pre class="example"><code>{
1503	"image" : "aeiou",
1504	"routerip" : "aeiou",
1505	"boottype" : "aeiou",
1506	"ip" : "aeiou",
1507	"repo" : {
1508	"id" : 123
1509	},
1510	"netdriver" : "aeiou",
1511	"netiface" : "aeiou",
1512	"mac" : "aeiou",
1513	"serialno" : "aeiou",
1514	"netmask" : "aeiou",
1515	"name" : "aeiou",
1516	"id" : 123,
1517	"validation" : true
1518	}</code></pre>
1519
1520	<h3 class="field-label">Produces</h3>
1521	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1522	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1523	<ul>
1524	<li><code>application/json</code></li>
1525	</ul>
1526
1527	<h3 class="field-label">Responses</h3>
1528	<h4 class="field-label">200</h4>
1529	Successful response
1530	<a href="#inline_response_200_9">inline_response_200_9</a>
1531	</div> <!-- method -->
1532	<hr/>
1533	<div class="method"><a name="ousOuidLabsLabidClientsClientidHardwareGet"/>
1534	<div class="method-path">
1535	<a class="up" href="#__Methods">Up</a>
1536	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware</code></pre></div>
1537	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidHardwareGet</span>)</div>
1538	<div class="method-notes">Get the hardware definition of a `client` object.</div>
1539
1540	<h3 class="field-label">Path parameters</h3>
1541	<div class="field-items">
1542	<div class="param">ouid (required)</div>
1543
1544	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
1545
1546	<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
1547
1548	<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
1549	</div> <!-- field-items -->
1550
1551	<h3 class="field-label">Consumes</h3>
1552	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1553	<ul>
1554	<li><code>application/json</code></li>
1555	</ul>
1556
1557
1558
1559
1560
1561	<h3 class="field-label">Return type</h3>
1562	<div class="return-type">
1563	<a href="#inline_response_200_11">inline_response_200_11</a>
1564
1565	</div>
1566
1567	<!--Todo: process Response Object and its headers, schema, examples -->
1568
1569	<h3 class="field-label">Example data</h3>
1570	<div class="example-data-content-type">Content-Type: application/json</div>
1571	<pre class="example"><code>{
1572	"name" : "aeiou",
1573	"id" : 123,
1574	"hardware" : [ {
1575	"description" : "aeiou",
1576	"type" : "aeiou"
1577	} ]
1578	}</code></pre>
1579
1580	<h3 class="field-label">Produces</h3>
1581	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1582	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1583	<ul>
1584	<li><code>application/json</code></li>
1585	</ul>
1586
1587	<h3 class="field-label">Responses</h3>
1588	<h4 class="field-label">200</h4>
1589	Successful response
1590	<a href="#inline_response_200_11">inline_response_200_11</a>
1591	</div> <!-- method -->
1592	<hr/>
1593	<div class="method"><a name="ousOuidLabsLabidClientsClientidStatusGet"/>
1594	<div class="method-path">
1595	<a class="up" href="#__Methods">Up</a>
1596	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/status</code></pre></div>
1597	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidStatusGet</span>)</div>
1598	<div class="method-notes">Get execution status of a `client`</div>
1599
1600	<h3 class="field-label">Path parameters</h3>
1601	<div class="field-items">
1602	<div class="param">ouid (required)</div>
1603
1604	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
1605
1606	<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
1607
1608	<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
1609	</div> <!-- field-items -->
1610
1611	<h3 class="field-label">Consumes</h3>
1612	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1613	<ul>
1614	<li><code>application/json</code></li>
1615	</ul>
1616
1617
1618
1619
1620
1621	<h3 class="field-label">Return type</h3>
1622	<div class="return-type">
1623	<a href="#inline_response_200_12">inline_response_200_12</a>
1624
1625	</div>
1626
1627	<!--Todo: process Response Object and its headers, schema, examples -->
1628
1629	<h3 class="field-label">Example data</h3>
1630	<div class="example-data-content-type">Content-Type: application/json</div>
1631	<pre class="example"><code>{
1632	"ip" : "aeiou",
1633	"id" : 123,
1634	"status" : "aeiou"
1635	}</code></pre>
1636
1637	<h3 class="field-label">Produces</h3>
1638	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1639	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1640	<ul>
1641	<li><code>application/json</code></li>
1642	</ul>
1643
1644	<h3 class="field-label">Responses</h3>
1645	<h4 class="field-label">200</h4>
1646	Successful response
1647	<a href="#inline_response_200_12">inline_response_200_12</a>
1648	</div> <!-- method -->
1649	<hr/>
1650	<div class="method"><a name="ousOuidLabsLabidClientsGet"/>
1651	<div class="method-path">
1652	<a class="up" href="#__Methods">Up</a>
1653	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients</code></pre></div>
1654	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsGet</span>)</div>
1655	<div class="method-notes">Get all `client` objects defined in an `lab`.</div>
1656
1657	<h3 class="field-label">Path parameters</h3>
1658	<div class="field-items">
1659	<div class="param">ouid (required)</div>
1660
1661	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
1662
1663	<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div>
1664	</div> <!-- field-items -->
1665
1666	<h3 class="field-label">Consumes</h3>
1667	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1668	<ul>
1669	<li><code>application/json</code></li>
1670	</ul>
1671
1672
1673
1674
1675
1676	<h3 class="field-label">Return type</h3>
1677	<div class="return-type">
1678	array[<a href="#inline_response_200_8">inline_response_200_8</a>]
1679
1680	</div>
1681
1682	<!--Todo: process Response Object and its headers, schema, examples -->
1683
1684	<h3 class="field-label">Example data</h3>
1685	<div class="example-data-content-type">Content-Type: application/json</div>
1686	<pre class="example"><code>[ {
1687	"ou" : {
1688	"id" : 123
1689	},
1690	"name" : "aeiou",
1691	"id" : 123,
1692	"lab" : ""
1693	} ]</code></pre>
1694
1695	<h3 class="field-label">Produces</h3>
1696	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1697	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1698	<ul>
1699	<li><code>application/json</code></li>
1700	</ul>
1701
1702	<h3 class="field-label">Responses</h3>
1703	<h4 class="field-label">200</h4>
1704	Successful response
1705
1706	</div> <!-- method -->
1707	<hr/>
1708	<div class="method"><a name="ousOuidLabsLabidGet"/>
1709	<div class="method-path">
1710	<a class="up" href="#__Methods">Up</a>
1711	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></pre></div>
1712	<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidGet</span>)</div>
1713	<div class="method-notes">Get a `lab` object.</div>
1714
1715	<h3 class="field-label">Path parameters</h3>
1716	<div class="field-items">
1717	<div class="param">ouid (required)</div>
1718
1719	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
1720
1721	<div class="param-desc"><span class="param-type">Path Parameter</span> — laboratory identificator </div>
1722	</div> <!-- field-items -->
1723
1724	<h3 class="field-label">Consumes</h3>
1725	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1726	<ul>
1727	<li><code>application/json</code></li>
1728	</ul>
1729
1730
1731
1732
1733
1734	<h3 class="field-label">Return type</h3>
1735	<div class="return-type">
1736	<a href="#inline_response_200_7">inline_response_200_7</a>
1737
1738	</div>
1739
1740	<!--Todo: process Response Object and its headers, schema, examples -->
1741
1742	<h3 class="field-label">Example data</h3>
1743	<div class="example-data-content-type">Content-Type: application/json</div>
1744	<pre class="example"><code>{
1745	"image" : "aeiou",
1746	"routerip" : "aeiou",
1747	"mcastport" : 123,
1748	"proxyurl" : "aeiou",
1749	"dns" : "aeiou",
1750	"mcastmode" : "aeiou",
1751	"description" : "aeiou",
1752	"inremotepc" : true,
1753	"ntp" : "aeiou",
1754	"mcastspeed" : 123,
1755	"capacity" : 123,
1756	"defclients" : 123,
1757	"mcastip" : "aeiou",
1758	"projector" : true,
1759	"netmask" : "aeiou",
1760	"p2ptime" : 123,
1761	"name" : "aeiou",
1762	"p2pmode" : "aeiou",
1763	"location" : "aeiou",
1764	"id" : 123,
1765	"board" : true
1766	}</code></pre>
1767
1768	<h3 class="field-label">Produces</h3>
1769	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1770	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1771	<ul>
1772	<li><code>application/json</code></li>
1773	</ul>
1774
1775	<h3 class="field-label">Responses</h3>
1776	<h4 class="field-label">200</h4>
1777	Successful response
1778	<a href="#inline_response_200_7">inline_response_200_7</a>
1779	</div> <!-- method -->
1780	<hr/>
1781	<div class="method"><a name="ousOuidReposGet"/>
1782	<div class="method-path">
1783	<a class="up" href="#__Methods">Up</a>
1784	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos</code></pre></div>
1785	<div class="method-summary"> (<span class="nickname">ousOuidReposGet</span>)</div>
1786	<div class="method-notes">Get all `repo` objects defined in an `OU`.</div>
1787
1788	<h3 class="field-label">Path parameters</h3>
1789	<div class="field-items">
1790	<div class="param">ouid (required)</div>
1791
1792	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
1793	</div> <!-- field-items -->
1794
1795	<h3 class="field-label">Consumes</h3>
1796	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1797	<ul>
1798	<li><code>application/json</code></li>
1799	</ul>
1800
1801
1802
1803
1804
1805	<h3 class="field-label">Return type</h3>
1806	<div class="return-type">
1807	array[<a href="#inline_response_200_13">inline_response_200_13</a>]
1808
1809	</div>
1810
1811	<!--Todo: process Response Object and its headers, schema, examples -->
1812
1813	<h3 class="field-label">Example data</h3>
1814	<div class="example-data-content-type">Content-Type: application/json</div>
1815	<pre class="example"><code>[ {
1816	"ou" : {
1817	"id" : 123
1818	},
1819	"name" : "aeiou",
1820	"id" : 123
1821	} ]</code></pre>
1822
1823	<h3 class="field-label">Produces</h3>
1824	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1825	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1826	<ul>
1827	<li><code>application/json</code></li>
1828	</ul>
1829
1830	<h3 class="field-label">Responses</h3>
1831	<h4 class="field-label">200</h4>
1832	Successful response
1833
1834	</div> <!-- method -->
1835	<hr/>
1836	<div class="method"><a name="ousOuidReposRepoidGet"/>
1837	<div class="method-path">
1838	<a class="up" href="#__Methods">Up</a>
1839	<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></pre></div>
1840	<div class="method-summary"> (<span class="nickname">ousOuidReposRepoidGet</span>)</div>
1841	<div class="method-notes">Get a `repo` object.</div>
1842
1843	<h3 class="field-label">Path parameters</h3>
1844	<div class="field-items">
1845	<div class="param">ouid (required)</div>
1846
1847	<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">repoid (required)</div>
1848
1849	<div class="param-desc"><span class="param-type">Path Parameter</span> — repository identificator </div>
1850	</div> <!-- field-items -->
1851
1852	<h3 class="field-label">Consumes</h3>
1853	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1854	<ul>
1855	<li><code>application/json</code></li>
1856	</ul>
1857
1858
1859
1860
1861
1862	<h3 class="field-label">Return type</h3>
1863	<div class="return-type">
1864	<a href="#inline_response_200_14">inline_response_200_14</a>
1865
1866	</div>
1867
1868	<!--Todo: process Response Object and its headers, schema, examples -->
1869
1870	<h3 class="field-label">Example data</h3>
1871	<div class="example-data-content-type">Content-Type: application/json</div>
1872	<pre class="example"><code>{
1873	"ip" : "aeiou",
1874	"name" : "aeiou",
1875	"description" : "aeiou",
1876	"id" : 123
1877	}</code></pre>
1878
1879	<h3 class="field-label">Produces</h3>
1880	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1881	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1882	<ul>
1883	<li><code>application/json</code></li>
1884	</ul>
1885
1886	<h3 class="field-label">Responses</h3>
1887	<h4 class="field-label">200</h4>
1888	Successful response
1889	<a href="#inline_response_200_14">inline_response_200_14</a>
1890	</div> <!-- method -->
1891	<hr/>
1892	<div class="method"><a name="loginPost"/>
1893	<div class="method-path">
1894	<a class="up" href="#__Methods">Up</a>
1895	<pre class="post"><code class="huge"><span class="http-method">post</span> /login</code></pre></div>
1896	<div class="method-summary"> (<span class="nickname">loginPost</span>)</div>
1897	<div class="method-notes">Check user login and returns his/her API key.</div>
1898
1899
1900	<h3 class="field-label">Consumes</h3>
1901	This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
1902	<ul>
1903	<li><code>application/json</code></li>
1904	</ul>
1905
1906	<h3 class="field-label">Request body</h3>
1907	<div class="field-items">
1908	<div class="param">authdata (required)</div>
1909
1910	<div class="param-desc"><span class="param-type">Body Parameter</span> — JSON authentication data </div>
1911	</div> <!-- field-items -->
1912
1913
1914
1915
1916	<h3 class="field-label">Return type</h3>
1917	<div class="return-type">
1918	<a href="#inline_response_200">inline_response_200</a>
1919
1920	</div>
1921
1922	<!--Todo: process Response Object and its headers, schema, examples -->
1923
1924	<h3 class="field-label">Example data</h3>
1925	<div class="example-data-content-type">Content-Type: application/json</div>
1926	<pre class="example"><code>{
1927	"apikey" : "aeiou",
1928	"userid" : 123
1929	}</code></pre>
1930
1931	<h3 class="field-label">Produces</h3>
1932	This API call produces the following media types according to the <span class="header">Accept</span> request header;
1933	the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
1934	<ul>
1935	<li><code>application/json</code></li>
1936	</ul>
1937
1938	<h3 class="field-label">Responses</h3>
1939	<h4 class="field-label">200</h4>
1940	Successful login
1941	<a href="#inline_response_200">inline_response_200</a>
1942	<h4 class="field-label">400</h4>
1943	Missing parameters
1944	<a href="#"></a>
1945	<h4 class="field-label">500</h4>
1946	Authentication error
1947	<a href="#"></a>
1948	</div> <!-- method -->
1949	<hr/>
1950
1951	<div class="up"><a href="#__Models">Up</a></div>
1952	<h2><a name="__Models">Models</a></h2>
1953	[ Jump to <a href="#__Methods">Methods</a> ]
1954
1955	<h2>Table of Contents</h2>
1956	<ol>
1957	<li><a href="#authdata"><code>authdata</code></a></li>
1958	<li><a href="#inline_response_200"><code>inline_response_200</code></a></li>
1959	<li><a href="#inline_response_200_1"><code>inline_response_200_1</code></a></li>
1960	<li><a href="#inline_response_200_10"><code>inline_response_200_10</code></a></li>
1961	<li><a href="#inline_response_200_10_diskcfg"><code>inline_response_200_10_diskcfg</code></a></li>
1962	<li><a href="#inline_response_200_10_image"><code>inline_response_200_10_image</code></a></li>
1963	<li><a href="#inline_response_200_11"><code>inline_response_200_11</code></a></li>
1964	<li><a href="#inline_response_200_11_hardware"><code>inline_response_200_11_hardware</code></a></li>
1965	<li><a href="#inline_response_200_12"><code>inline_response_200_12</code></a></li>
1966	<li><a href="#inline_response_200_13"><code>inline_response_200_13</code></a></li>
1967	<li><a href="#inline_response_200_14"><code>inline_response_200_14</code></a></li>
1968	<li><a href="#inline_response_200_2"><code>inline_response_200_2</code></a></li>
1969	<li><a href="#inline_response_200_3"><code>inline_response_200_3</code></a></li>
1970	<li><a href="#inline_response_200_4"><code>inline_response_200_4</code></a></li>
1971	<li><a href="#inline_response_200_4_client"><code>inline_response_200_4_client</code></a></li>
1972	<li><a href="#inline_response_200_4_repo"><code>inline_response_200_4_repo</code></a></li>
1973	<li><a href="#inline_response_200_5"><code>inline_response_200_5</code></a></li>
1974	<li><a href="#inline_response_200_5_software"><code>inline_response_200_5_software</code></a></li>
1975	<li><a href="#inline_response_200_6"><code>inline_response_200_6</code></a></li>
1976	<li><a href="#inline_response_200_7"><code>inline_response_200_7</code></a></li>
1977	<li><a href="#inline_response_200_8"><code>inline_response_200_8</code></a></li>
1978	<li><a href="#inline_response_200_9"><code>inline_response_200_9</code></a></li>
1979	<li><a href="#ousouidimages_ou"><code>ousouidimages_ou</code></a></li>
1980	<li><a href="#ousouidlabs_ou"><code>ousouidlabs_ou</code></a></li>
1981	</ol>
1982
1983	<div class="model">
1984	<h3 class="field-label"><a name="authdata">authdata</a> <a class="up" href="#__Models">Up</a></h3>
1985	<div class="field-items">
1986	<div class="param">username (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
1987	<div class="param">password (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> format: password</div>
1988	</div> <!-- field-items -->
1989	</div>
1990	<div class="model">
1991	<h3 class="field-label"><a name="inline_response_200">inline_response_200</a> <a class="up" href="#__Models">Up</a></h3>
1992	<div class="field-items">
1993	<div class="param">userid (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> user identificator format: int32</div>
1994	<div class="param">apikey (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> API key to include in ``Authorization`` header </div>
1995	</div> <!-- field-items -->
1996	</div>
1997	<div class="model">
1998	<h3 class="field-label"><a name="inline_response_200_1">inline_response_200_1</a> <a class="up" href="#__Models">Up</a></h3>
1999	<div class="field-items">
2000	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> Organization Unit identificator format: int32</div>
2001	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Organization Unit name </div>
2002	</div> <!-- field-items -->
2003	</div>
2004	<div class="model">
2005	<h3 class="field-label"><a name="inline_response_200_10">inline_response_200_10</a> <a class="up" href="#__Models">Up</a></h3>
2006	<div class="field-items">
2007	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> client id format: int32</div>
2008	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client name </div>
2009	<div class="param">diskcfg (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_10_diskcfg">array[inline_response_200_10_diskcfg]</a></span> array of disk configuration data, including general disk information and partition/filesystem information (if not specified in paratmeter description, it is only valid in partition configuration). </div>
2010	</div> <!-- field-items -->
2011	</div>
2012	<div class="model">
2013	<h3 class="field-label"><a name="inline_response_200_10_diskcfg">inline_response_200_10_diskcfg</a> <a class="up" href="#__Models">Up</a></h3>
2014	<div class="field-items">
2015	<div class="param">disk (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> disk number (only for disks configurations) format: int32</div>
2016	<div class="param">parttable (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> partition table type (only for disks configurations) </div>
2017	<div class="param-enum-header">Enum:</div>
2018	<div class="param-enum">MSDOS</div><div class="param-enum">GPT</div><div class="param-enum">LVM</div><div class="param-enum">ZVOL</div>
2019	<div class="param">partition (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> partition number format: int32</div>
2020	<div class="param">parttype (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> partition type </div>
2021	<div class="param">size (optional)</div><div class="param-desc"><span class="param-type"><a href="#long">Long</a></span> disk size (used in both, disk and partition configuration) format: int64</div>
2022	<div class="param">filesystem (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> filesystem type </div>
2023	<div class="param">usage (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> data usage percentage in a formated filesystem format: int32</div>
2024	<div class="param">os (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> installed operating system </div>
2025	<div class="param">image (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_10_image">inline_response_200_10_image</a></span> </div>
2026	</div> <!-- field-items -->
2027	</div>
2028	<div class="model">
2029	<h3 class="field-label"><a name="inline_response_200_10_image">inline_response_200_10_image</a> <a class="up" href="#__Models">Up</a></h3>
2030	<div class="field-items">
2031	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
2032	<div class="param">deploydate (optional)</div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> image restauration/deploying date format: date-time</div>
2033	<div class="param">updated (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> flag to check if the restaured image is updated </div>
2034	</div> <!-- field-items -->
2035	</div>
2036	<div class="model">
2037	<h3 class="field-label"><a name="inline_response_200_11">inline_response_200_11</a> <a class="up" href="#__Models">Up</a></h3>
2038	<div class="field-items">
2039	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> client id format: int32</div>
2040	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client name </div>
2041	<div class="param">hardware (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_11_hardware">array[inline_response_200_11_hardware]</a></span> hardware components </div>
2042	</div> <!-- field-items -->
2043	</div>
2044	<div class="model">
2045	<h3 class="field-label"><a name="inline_response_200_11_hardware">inline_response_200_11_hardware</a> <a class="up" href="#__Models">Up</a></h3>
2046	<div class="field-items">
2047	<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> hardware component type </div>
2048	<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> hardware component description </div>
2049	</div> <!-- field-items -->
2050	</div>
2051	<div class="model">
2052	<h3 class="field-label"><a name="inline_response_200_12">inline_response_200_12</a> <a class="up" href="#__Models">Up</a></h3>
2053	<div class="field-items">
2054	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> client id format: int32</div>
2055	<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client IP address </div>
2056	<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> execution status </div>
2057	<div class="param-enum-header">Enum:</div>
2058	<div class="param-enum">nodata</div><div class="param-enum">off</div><div class="param-enum">ogclient</div><div class="param-enum">busy</div><div class="param-enum">linux</div><div class="param-enum">windows</div><div class="param-enum">unknown</div>
2059	</div> <!-- field-items -->
2060	</div>
2061	<div class="model">
2062	<h3 class="field-label"><a name="inline_response_200_13">inline_response_200_13</a> <a class="up" href="#__Models">Up</a></h3>
2063	<div class="field-items">
2064	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
2065	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2066	<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span> </div>
2067	</div> <!-- field-items -->
2068	</div>
2069	<div class="model">
2070	<h3 class="field-label"><a name="inline_response_200_14">inline_response_200_14</a> <a class="up" href="#__Models">Up</a></h3>
2071	<div class="field-items">
2072	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> repository id format: int32</div>
2073	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository name </div>
2074	<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository description </div>
2075	<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository IP address </div>
2076	</div> <!-- field-items -->
2077	</div>
2078	<div class="model">
2079	<h3 class="field-label"><a name="inline_response_200_2">inline_response_200_2</a> <a class="up" href="#__Models">Up</a></h3>
2080	<div class="field-items">
2081	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> OU identificator </div>
2082	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> OU name </div>
2083	<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> OU description </div>
2084	</div> <!-- field-items -->
2085	</div>
2086	<div class="model">
2087	<h3 class="field-label"><a name="inline_response_200_3">inline_response_200_3</a> <a class="up" href="#__Models">Up</a></h3>
2088	<div class="field-items">
2089	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
2090	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2091	<div class="param">inremotepc (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
2092	<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span> </div>
2093	</div> <!-- field-items -->
2094	</div>
2095	<div class="model">
2096	<h3 class="field-label"><a name="inline_response_200_4">inline_response_200_4</a> <a class="up" href="#__Models">Up</a></h3>
2097	<div class="field-items">
2098	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> image id format: int32</div>
2099	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image name </div>
2100	<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image description </div>
2101	<div class="param">inremotepc (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> image usable in Remote PC Project flag </div>
2102	<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image type (``monolithic``, ``basic``, ``incremental``) </div>
2103	<div class="param">baseimg (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> base image for an incremental image (if ``type`` is ``incremental``) </div>
2104	<div class="param">path (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image path (if ``type`` is ``incremental``) </div>
2105	<div class="param">repo (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_4_repo">inline_response_200_4_repo</a></span> </div>
2106	<div class="param">client (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_4_client">inline_response_200_4_client</a></span> </div>
2107	<div class="param">creationdate (optional)</div><div class="param-desc"><span class="param-type"><a href="#DateTime">Date</a></span> image creation date format: date-time</div>
2108	<div class="param">release (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image creation release </div>
2109	</div> <!-- field-items -->
2110	</div>
2111	<div class="model">
2112	<h3 class="field-label"><a name="inline_response_200_4_client">inline_response_200_4_client</a> <a class="up" href="#__Models">Up</a></h3>
2113	<div class="field-items">
2114	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> model client's id. format: int32</div>
2115	<div class="param">disk (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> source disk number format: int32</div>
2116	<div class="param">partition (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> source partition number format: int32</div>
2117	</div> <!-- field-items -->
2118	</div>
2119	<div class="model">
2120	<h3 class="field-label"><a name="inline_response_200_4_repo">inline_response_200_4_repo</a> <a class="up" href="#__Models">Up</a></h3>
2121	<div class="field-items">
2122	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
2123	</div> <!-- field-items -->
2124	</div>
2125	<div class="model">
2126	<h3 class="field-label"><a name="inline_response_200_5">inline_response_200_5</a> <a class="up" href="#__Models">Up</a></h3>
2127	<div class="field-items">
2128	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> image id format: int32</div>
2129	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image name </div>
2130	<div class="param">os (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> installed operating system </div>
2131	<div class="param">software (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_5_software">array[inline_response_200_5_software]</a></span> array of installed applications </div>
2132	</div> <!-- field-items -->
2133	</div>
2134	<div class="model">
2135	<h3 class="field-label"><a name="inline_response_200_5_software">inline_response_200_5_software</a> <a class="up" href="#__Models">Up</a></h3>
2136	<div class="field-items">
2137	<div class="param">application (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> application name and version </div>
2138	</div> <!-- field-items -->
2139	</div>
2140	<div class="model">
2141	<h3 class="field-label"><a name="inline_response_200_6">inline_response_200_6</a> <a class="up" href="#__Models">Up</a></h3>
2142	<div class="field-items">
2143	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> laboratory identificator format: int32</div>
2144	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory name </div>
2145	<div class="param">inremotepc (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> laboratory usable in Remote PC Project flag </div>
2146	<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidlabs_ou">ousouidlabs_ou</a></span> </div>
2147	</div> <!-- field-items -->
2148	</div>
2149	<div class="model">
2150	<h3 class="field-label"><a name="inline_response_200_7">inline_response_200_7</a> <a class="up" href="#__Models">Up</a></h3>
2151	<div class="field-items">
2152	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> laboratory identificator format: int32</div>
2153	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory name </div>
2154	<div class="param">location (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory location </div>
2155	<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory description </div>
2156	<div class="param">inremotepc (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> check if this lab can be included in Remote PC Project </div>
2157	<div class="param">capacity (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> maximum number of people in the lab format: int32</div>
2158	<div class="param">defclients (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> number of defined clients in the lab format: int32</div>
2159	<div class="param">projector (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> check if this lab has a projector </div>
2160	<div class="param">board (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> check if this lab has an electronic board </div>
2161	<div class="param">routerip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> lab router IP address </div>
2162	<div class="param">netmask (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> network mask to use in the lab </div>
2163	<div class="param">ntp (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> NTP server IP address </div>
2164	<div class="param">dns (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> DNS server IP address </div>
2165	<div class="param">proxyurl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Proxy server URL </div>
2166	<div class="param">mcastmode (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Multicast protocol mode (full-duplex, half-duplex). </div>
2167	<div class="param-enum-header">Enum:</div>
2168	<div class="param-enum">full-duplex</div><div class="param-enum">half-duplex</div>
2169	<div class="param">mcastip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Multicast IP address </div>
2170	<div class="param">mcastport (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> Multicast port format: int32</div>
2171	<div class="param">mcastspeed (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> Multicast speed (in Mbps) format: int32</div>
2172	<div class="param">p2pmode (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Bittorrent connection type (\"peer\", \"leecher\". \"seeder\"). </div>
2173	<div class="param">p2ptime (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> Bittorrent connection extra time (in s.) format: int32</div>
2174	<div class="param">image (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Lab's picture file </div>
2175	</div> <!-- field-items -->
2176	</div>
2177	<div class="model">
2178	<h3 class="field-label"><a name="inline_response_200_8">inline_response_200_8</a> <a class="up" href="#__Models">Up</a></h3>
2179	<div class="field-items">
2180	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
2181	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
2182	<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span> </div>
2183	<div class="param">lab (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span> </div>
2184	</div> <!-- field-items -->
2185	</div>
2186	<div class="model">
2187	<h3 class="field-label"><a name="inline_response_200_9">inline_response_200_9</a> <a class="up" href="#__Models">Up</a></h3>
2188	<div class="field-items">
2189	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> client id format: int32</div>
2190	<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client name </div>
2191	<div class="param">serialno (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client serial number </div>
2192	<div class="param">netiface (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> main network interface </div>
2193	<div class="param">netdriver (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client MAC address (kernel module) </div>
2194	<div class="param">mac (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client MAC address </div>
2195	<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client IP address </div>
2196	<div class="param">netmask (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> subnet mask address </div>
2197	<div class="param">routerip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> network router IP address </div>
2198	<div class="param">repo (optional)</div><div class="param-desc"><span class="param-type"><a href="#inline_response_200_4_repo">inline_response_200_4_repo</a></span> </div>
2199	<div class="param">validation (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> boot validation flag </div>
2200	<div class="param">boottype (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> boot template type </div>
2201	<div class="param">image (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client's picture file </div>
2202	</div> <!-- field-items -->
2203	</div>
2204	<div class="model">
2205	<h3 class="field-label"><a name="ousouidimages_ou">ousouidimages_ou</a> <a class="up" href="#__Models">Up</a></h3>
2206	<div class="field-items">
2207	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
2208	</div> <!-- field-items -->
2209	</div>
2210	<div class="model">
2211	<h3 class="field-label"><a name="ousouidlabs_ou">ousouidlabs_ou</a> <a class="up" href="#__Models">Up</a></h3>
2212	<div class="field-items">
2213	<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> OU identificator format: int32</div>
2214	</div> <!-- field-items -->
2215	</div>
2216	</body>
2217	</html>

Note: See TracBrowser for help on using the repository browser.

Context Navigation

source: admin/WebConsole/rest/opengnsys-api.html @ df81ab78

Download in other formats: