2221 lines
92 KiB
HTML
2221 lines
92 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<title>OpenGnsys REST API definition</title>
|
|
<style type="text/css">
|
|
body {
|
|
font-family: Trebuchet MS, sans-serif;
|
|
font-size: 15px;
|
|
color: #444;
|
|
margin-right: 24px;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 25px;
|
|
}
|
|
h2 {
|
|
font-size: 20px;
|
|
}
|
|
h3 {
|
|
font-size: 16px;
|
|
font-weight: bold;
|
|
}
|
|
hr {
|
|
height: 1px;
|
|
border: 0;
|
|
color: #ddd;
|
|
background-color: #ddd;
|
|
display: none;
|
|
}
|
|
|
|
.app-desc {
|
|
clear: both;
|
|
margin-left: 20px;
|
|
}
|
|
.param-name {
|
|
width: 100%;
|
|
}
|
|
.license-info {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.license-url {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.model {
|
|
margin: 0 0 0px 20px;
|
|
}
|
|
|
|
.method {
|
|
margin-left: 20px;
|
|
}
|
|
|
|
.method-notes {
|
|
margin: 10px 0 20px 0;
|
|
font-size: 90%;
|
|
color: #555;
|
|
}
|
|
|
|
pre {
|
|
padding: 10px;
|
|
margin-bottom: 2px;
|
|
}
|
|
|
|
.http-method {
|
|
text-transform: uppercase;
|
|
}
|
|
|
|
pre.get {
|
|
background-color: #0f6ab4;
|
|
}
|
|
|
|
pre.post {
|
|
background-color: #10a54a;
|
|
}
|
|
|
|
pre.put {
|
|
background-color: #c5862b;
|
|
}
|
|
|
|
pre.delete {
|
|
background-color: #a41e22;
|
|
}
|
|
|
|
.huge {
|
|
color: #fff;
|
|
}
|
|
|
|
pre.example {
|
|
background-color: #f3f3f3;
|
|
padding: 10px;
|
|
border: 1px solid #ddd;
|
|
}
|
|
|
|
code {
|
|
white-space: pre;
|
|
}
|
|
|
|
.nickname {
|
|
font-weight: bold;
|
|
}
|
|
|
|
.method-path {
|
|
font-size: 1.5em;
|
|
background-color: #0f6ab4;
|
|
}
|
|
|
|
.up {
|
|
float:right;
|
|
}
|
|
|
|
.parameter {
|
|
width: 500px;
|
|
}
|
|
|
|
.param {
|
|
width: 500px;
|
|
padding: 10px 0 0 20px;
|
|
font-weight: bold;
|
|
}
|
|
|
|
.param-desc {
|
|
width: 700px;
|
|
padding: 0 0 0 20px;
|
|
color: #777;
|
|
}
|
|
|
|
.param-type {
|
|
font-style: italic;
|
|
}
|
|
|
|
.param-enum-header {
|
|
width: 700px;
|
|
padding: 0 0 0 60px;
|
|
color: #777;
|
|
font-weight: bold;
|
|
}
|
|
|
|
.param-enum {
|
|
width: 700px;
|
|
padding: 0 0 0 80px;
|
|
color: #777;
|
|
font-style: italic;
|
|
}
|
|
|
|
.field-label {
|
|
padding: 0;
|
|
margin: 0;
|
|
clear: both;
|
|
}
|
|
|
|
.field-items {
|
|
padding: 0 0 15px 0;
|
|
margin-bottom: 15px;
|
|
}
|
|
|
|
.return-type {
|
|
clear: both;
|
|
padding-bottom: 10px;
|
|
}
|
|
|
|
.param-header {
|
|
font-weight: bold;
|
|
}
|
|
|
|
.method-tags {
|
|
text-align: right;
|
|
}
|
|
|
|
.method-tag {
|
|
background: none repeat scroll 0% 0% #24A600;
|
|
border-radius: 3px;
|
|
padding: 2px 10px;
|
|
margin: 2px;
|
|
color: #FFF;
|
|
display: inline-block;
|
|
text-decoration: none;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<h1>OpenGnsys REST API definition</h1>
|
|
<div class="app-desc">Information about the OpenGnsys REST API functions (including Server and Repository Manager). </div>
|
|
<div class="app-desc">More information: <a href="http://opengnsys.es/">http://opengnsys.es/</a></div>
|
|
<div class="app-desc">Contact Info: <a href="opengnsys-devel@listas.unizar.es">opengnsys-devel@listas.unizar.es</a></div>
|
|
<div class="app-desc">Version: 1.1.0</div>
|
|
<div class="app-desc">BasePath:/opengnsys/rest</div>
|
|
<div class="license-info">Creative Commons 4.0 International</div>
|
|
<div class="license-url">http://creativecommons.org/licenses/by/4.0/</div>
|
|
<h2>Access</h2>
|
|
<ol>
|
|
<li>APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true</li>
|
|
</ol>
|
|
|
|
<h2><a name="__Methods">Methods</a></h2>
|
|
[ Jump to <a href="#__Models">Models</a> ]
|
|
|
|
<h2>Table of Contents </h2>
|
|
<div class="method-summary"></div>
|
|
<ol>
|
|
<li><a href="#ousGet"><code><span class="http-method">get</span> /ous</code></a></li>
|
|
<li><a href="#ousOuidGet"><code><span class="http-method">get</span> /ous/{ouid}</code></a></li>
|
|
<li><a href="#ousOuidImagesGet"><code><span class="http-method">get</span> /ous/{ouid}/images</code></a></li>
|
|
<li><a href="#ousOuidImagesImageidGet"><code><span class="http-method">get</span> /ous/{ouid}/images/{imageid}</code></a></li>
|
|
<li><a href="#ousOuidImagesImageidSoftwareGet"><code><span class="http-method">get</span> /ous/{ouid}/images/{imageid}/software</code></a></li>
|
|
<li><a href="#ousOuidLabsGet"><code><span class="http-method">get</span> /ous/{ouid}/labs</code></a></li>
|
|
<li><a href="#ousOuidLabsLabidClientsClientidDiskcfgGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/diskcfg</code></a></li>
|
|
<li><a href="#ousOuidLabsLabidClientsClientidGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}</code></a></li>
|
|
<li><a href="#ousOuidLabsLabidClientsClientidHardwareGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware</code></a></li>
|
|
<li><a href="#ousOuidLabsLabidClientsClientidStatusGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/status</code></a></li>
|
|
<li><a href="#ousOuidLabsLabidClientsGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients</code></a></li>
|
|
<li><a href="#ousOuidLabsLabidGet"><code><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></a></li>
|
|
<li><a href="#ousOuidReposGet"><code><span class="http-method">get</span> /ous/{ouid}/repos</code></a></li>
|
|
<li><a href="#ousOuidReposRepoidGet"><code><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></a></li>
|
|
<li><a href="#loginPost"><code><span class="http-method">post</span> /login</code></a></li>
|
|
</ol>
|
|
|
|
<div class="method"><a name="ousOuidLabsLabidClientsClientidDiskcfgGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/diskcfg</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidDiskcfgGet</span>)</div>
|
|
<div class="method-notes">Get disks configuration of a `client`</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_10">inline_response_200_10</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"diskcfg" : [ {
|
|
"parttable" : "aeiou",
|
|
"image" : {
|
|
"deploydate" : "2000-01-23T04:56:07.000+00:00",
|
|
"id" : 123,
|
|
"updated" : true
|
|
},
|
|
"disk" : 123,
|
|
"partition" : 123,
|
|
"size" : 123456789,
|
|
"os" : "aeiou",
|
|
"usage" : 123,
|
|
"parttype" : "aeiou",
|
|
"filesystem" : "aeiou"
|
|
} ],
|
|
"name" : "aeiou",
|
|
"id" : 123
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_10">inline_response_200_10</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsLabidClientsClientidGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidGet</span>)</div>
|
|
<div class="method-notes">Get a `client` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_9">inline_response_200_9</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"image" : "aeiou",
|
|
"routerip" : "aeiou",
|
|
"boottype" : "aeiou",
|
|
"ip" : "aeiou",
|
|
"repo" : {
|
|
"id" : 123
|
|
},
|
|
"netdriver" : "aeiou",
|
|
"netiface" : "aeiou",
|
|
"mac" : "aeiou",
|
|
"serialno" : "aeiou",
|
|
"netmask" : "aeiou",
|
|
"name" : "aeiou",
|
|
"id" : 123,
|
|
"validation" : true
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_9">inline_response_200_9</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsLabidClientsClientidHardwareGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidHardwareGet</span>)</div>
|
|
<div class="method-notes">Get the hardware definition of a `client` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_11">inline_response_200_11</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"name" : "aeiou",
|
|
"id" : 123,
|
|
"hardware" : [ {
|
|
"description" : "aeiou",
|
|
"type" : "aeiou"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_11">inline_response_200_11</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsLabidClientsClientidStatusGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/status</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidStatusGet</span>)</div>
|
|
<div class="method-notes">Get execution status of a `client`</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_12">inline_response_200_12</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"ip" : "aeiou",
|
|
"loggedin" : true,
|
|
"id" : 123,
|
|
"status" : "aeiou"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_12">inline_response_200_12</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsLabidClientsGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsGet</span>)</div>
|
|
<div class="method-notes">Get all `client` objects defined in an `lab`.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_8">inline_response_200_8</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"ou" : {
|
|
"id" : 123
|
|
},
|
|
"name" : "aeiou",
|
|
"id" : 123,
|
|
"lab" : ""
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidImagesImageidSoftwareGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images/{imageid}/software</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidImagesImageidSoftwareGet</span>)</div>
|
|
<div class="method-notes">Get software inventory store into an `image`</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">imageid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — image definition identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_5">inline_response_200_5</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"os" : "aeiou",
|
|
"software" : [ {
|
|
"application" : "aeiou"
|
|
} ],
|
|
"name" : "aeiou",
|
|
"id" : 123
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_5">inline_response_200_5</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidImagesGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidImagesGet</span>)</div>
|
|
<div class="method-notes">Get all `image` objects defined in an `OU`.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_3">inline_response_200_3</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"ou" : {
|
|
"id" : 123
|
|
},
|
|
"name" : "aeiou",
|
|
"id" : 123,
|
|
"inremotepc" : true
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidImagesImageidGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images/{imageid}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidImagesImageidGet</span>)</div>
|
|
<div class="method-notes">Get an `image` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">imageid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — image definition identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_4">inline_response_200_4</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"path" : "aeiou",
|
|
"creationdate" : "2000-01-23T04:56:07.000+00:00",
|
|
"release" : "aeiou",
|
|
"repo" : {
|
|
"id" : 123
|
|
},
|
|
"name" : "aeiou",
|
|
"description" : "aeiou",
|
|
"client" : {
|
|
"disk" : 123,
|
|
"partition" : 123,
|
|
"id" : 123
|
|
},
|
|
"id" : 123,
|
|
"inremotepc" : true,
|
|
"type" : "aeiou",
|
|
"baseimg" : "aeiou"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_4">inline_response_200_4</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsGet</span>)</div>
|
|
<div class="method-notes">Get all `lab` objects defined in an `OU`.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_6">inline_response_200_6</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"ou" : {
|
|
"id" : 123
|
|
},
|
|
"name" : "aeiou",
|
|
"id" : 123,
|
|
"inremotepc" : true
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsLabidGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidGet</span>)</div>
|
|
<div class="method-notes">Get a `lab` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — laboratory identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_7">inline_response_200_7</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"image" : "aeiou",
|
|
"routerip" : "aeiou",
|
|
"mcastport" : 123,
|
|
"proxyurl" : "aeiou",
|
|
"dns" : "aeiou",
|
|
"mcastmode" : "aeiou",
|
|
"description" : "aeiou",
|
|
"inremotepc" : true,
|
|
"ntp" : "aeiou",
|
|
"mcastspeed" : 123,
|
|
"capacity" : 123,
|
|
"defclients" : 123,
|
|
"mcastip" : "aeiou",
|
|
"projector" : true,
|
|
"netmask" : "aeiou",
|
|
"p2ptime" : 123,
|
|
"name" : "aeiou",
|
|
"p2pmode" : "aeiou",
|
|
"location" : "aeiou",
|
|
"id" : 123,
|
|
"board" : true
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_7">inline_response_200_7</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousGet</span>)</div>
|
|
<div class="method-notes">Gets all `OU` objects.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_1">inline_response_200_1</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"name" : "aeiou",
|
|
"id" : 123
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidGet</span>)</div>
|
|
<div class="method-notes">Get an `OU` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Organization Unit identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_2">inline_response_200_2</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"name" : "aeiou",
|
|
"description" : "aeiou",
|
|
"id" : ""
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_2">inline_response_200_2</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidReposGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidReposGet</span>)</div>
|
|
<div class="method-notes">Get all `repo` objects defined in an `OU`.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_13">inline_response_200_13</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"ou" : {
|
|
"id" : 123
|
|
},
|
|
"name" : "aeiou",
|
|
"id" : 123
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidReposRepoidGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidReposRepoidGet</span>)</div>
|
|
<div class="method-notes">Get a `repo` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">repoid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — repository identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_14">inline_response_200_14</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"ip" : "aeiou",
|
|
"name" : "aeiou",
|
|
"description" : "aeiou",
|
|
"id" : 123
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_14">inline_response_200_14</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="loginPost"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /login</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">loginPost</span>)</div>
|
|
<div class="method-notes">Check user login and returns his/her API key.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">authdata (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — JSON authentication data </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200">inline_response_200</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"apikey" : "aeiou",
|
|
"userid" : 123
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful login
|
|
<a href="#inline_response_200">inline_response_200</a>
|
|
<h4 class="field-label">400</h4>
|
|
Missing parameters
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
Authentication error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousGet</span>)</div>
|
|
<div class="method-notes">Gets all `OU` objects.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_1">inline_response_200_1</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"name" : "aeiou",
|
|
"id" : 123
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidGet</span>)</div>
|
|
<div class="method-notes">Get an `OU` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Organization Unit identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_2">inline_response_200_2</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"name" : "aeiou",
|
|
"description" : "aeiou",
|
|
"id" : ""
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_2">inline_response_200_2</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidImagesGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidImagesGet</span>)</div>
|
|
<div class="method-notes">Get all `image` objects defined in an `OU`.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_3">inline_response_200_3</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"ou" : {
|
|
"id" : 123
|
|
},
|
|
"name" : "aeiou",
|
|
"id" : 123,
|
|
"inremotepc" : true
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidImagesImageidGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/images/{imageid}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidImagesImageidGet</span>)</div>
|
|
<div class="method-notes">Get an `image` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">imageid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — image definition identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_4">inline_response_200_4</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"path" : "aeiou",
|
|
"creationdate" : "2000-01-23T04:56:07.000+00:00",
|
|
"release" : "aeiou",
|
|
"repo" : {
|
|
"id" : 123
|
|
},
|
|
"name" : "aeiou",
|
|
"description" : "aeiou",
|
|
"client" : {
|
|
"disk" : 123,
|
|
"partition" : 123,
|
|
"id" : 123
|
|
},
|
|
"id" : 123,
|
|
"inremotepc" : true,
|
|
"type" : "aeiou",
|
|
"baseimg" : "aeiou"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_4">inline_response_200_4</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsGet</span>)</div>
|
|
<div class="method-notes">Get all `lab` objects defined in an `OU`.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_6">inline_response_200_6</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"ou" : {
|
|
"id" : 123
|
|
},
|
|
"name" : "aeiou",
|
|
"id" : 123,
|
|
"inremotepc" : true
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsLabidClientsClientidDiskcfgGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/diskcfg</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidDiskcfgGet</span>)</div>
|
|
<div class="method-notes">Get disks configuration of a `client`</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_10">inline_response_200_10</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"diskcfg" : [ {
|
|
"parttable" : "aeiou",
|
|
"image" : {
|
|
"deploydate" : "2000-01-23T04:56:07.000+00:00",
|
|
"id" : 123,
|
|
"updated" : true
|
|
},
|
|
"disk" : 123,
|
|
"partition" : 123,
|
|
"size" : 123456789,
|
|
"os" : "aeiou",
|
|
"usage" : 123,
|
|
"parttype" : "aeiou",
|
|
"filesystem" : "aeiou"
|
|
} ],
|
|
"name" : "aeiou",
|
|
"id" : 123
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_10">inline_response_200_10</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsLabidClientsClientidGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidGet</span>)</div>
|
|
<div class="method-notes">Get a `client` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_9">inline_response_200_9</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"image" : "aeiou",
|
|
"routerip" : "aeiou",
|
|
"boottype" : "aeiou",
|
|
"ip" : "aeiou",
|
|
"repo" : {
|
|
"id" : 123
|
|
},
|
|
"netdriver" : "aeiou",
|
|
"netiface" : "aeiou",
|
|
"mac" : "aeiou",
|
|
"serialno" : "aeiou",
|
|
"netmask" : "aeiou",
|
|
"name" : "aeiou",
|
|
"id" : 123,
|
|
"validation" : true
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_9">inline_response_200_9</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsLabidClientsClientidHardwareGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/hardware</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidHardwareGet</span>)</div>
|
|
<div class="method-notes">Get the hardware definition of a `client` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_11">inline_response_200_11</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"name" : "aeiou",
|
|
"id" : 123,
|
|
"hardware" : [ {
|
|
"description" : "aeiou",
|
|
"type" : "aeiou"
|
|
} ]
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_11">inline_response_200_11</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsLabidClientsClientidStatusGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients/{clientid}/status</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsClientidStatusGet</span>)</div>
|
|
<div class="method-notes">Get execution status of a `client`</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div><div class="param">clientid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Client identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_12">inline_response_200_12</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"ip" : "aeiou",
|
|
"loggedin" : true,
|
|
"id" : 123,
|
|
"status" : "aeiou"
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_12">inline_response_200_12</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsLabidClientsGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}/clients</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidClientsGet</span>)</div>
|
|
<div class="method-notes">Get all `client` objects defined in an `lab`.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — Lab identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_8">inline_response_200_8</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"ou" : {
|
|
"id" : 123
|
|
},
|
|
"name" : "aeiou",
|
|
"id" : 123,
|
|
"lab" : ""
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidLabsLabidGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/labs/{labid}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidLabsLabidGet</span>)</div>
|
|
<div class="method-notes">Get a `lab` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">labid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — laboratory identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_7">inline_response_200_7</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"image" : "aeiou",
|
|
"routerip" : "aeiou",
|
|
"mcastport" : 123,
|
|
"proxyurl" : "aeiou",
|
|
"dns" : "aeiou",
|
|
"mcastmode" : "aeiou",
|
|
"description" : "aeiou",
|
|
"inremotepc" : true,
|
|
"ntp" : "aeiou",
|
|
"mcastspeed" : 123,
|
|
"capacity" : 123,
|
|
"defclients" : 123,
|
|
"mcastip" : "aeiou",
|
|
"projector" : true,
|
|
"netmask" : "aeiou",
|
|
"p2ptime" : 123,
|
|
"name" : "aeiou",
|
|
"p2pmode" : "aeiou",
|
|
"location" : "aeiou",
|
|
"id" : 123,
|
|
"board" : true
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_7">inline_response_200_7</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidReposGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidReposGet</span>)</div>
|
|
<div class="method-notes">Get all `repo` objects defined in an `OU`.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
array[<a href="#inline_response_200_13">inline_response_200_13</a>]
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>[ {
|
|
"ou" : {
|
|
"id" : 123
|
|
},
|
|
"name" : "aeiou",
|
|
"id" : 123
|
|
} ]</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="ousOuidReposRepoidGet"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="get"><code class="huge"><span class="http-method">get</span> /ous/{ouid}/repos/{repoid}</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">ousOuidReposRepoidGet</span>)</div>
|
|
<div class="method-notes">Get a `repo` object.</div>
|
|
|
|
<h3 class="field-label">Path parameters</h3>
|
|
<div class="field-items">
|
|
<div class="param">ouid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — OU identificator </div><div class="param">repoid (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Path Parameter</span> — repository identificator </div>
|
|
</div> <!-- field-items -->
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200_14">inline_response_200_14</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"ip" : "aeiou",
|
|
"name" : "aeiou",
|
|
"description" : "aeiou",
|
|
"id" : 123
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful response
|
|
<a href="#inline_response_200_14">inline_response_200_14</a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
<div class="method"><a name="loginPost"/>
|
|
<div class="method-path">
|
|
<a class="up" href="#__Methods">Up</a>
|
|
<pre class="post"><code class="huge"><span class="http-method">post</span> /login</code></pre></div>
|
|
<div class="method-summary"> (<span class="nickname">loginPost</span>)</div>
|
|
<div class="method-notes">Check user login and returns his/her API key.</div>
|
|
|
|
|
|
<h3 class="field-label">Consumes</h3>
|
|
This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Request body</h3>
|
|
<div class="field-items">
|
|
<div class="param">authdata (required)</div>
|
|
|
|
<div class="param-desc"><span class="param-type">Body Parameter</span> — JSON authentication data </div>
|
|
</div> <!-- field-items -->
|
|
|
|
|
|
|
|
|
|
<h3 class="field-label">Return type</h3>
|
|
<div class="return-type">
|
|
<a href="#inline_response_200">inline_response_200</a>
|
|
|
|
</div>
|
|
|
|
<!--Todo: process Response Object and its headers, schema, examples -->
|
|
|
|
<h3 class="field-label">Example data</h3>
|
|
<div class="example-data-content-type">Content-Type: application/json</div>
|
|
<pre class="example"><code>{
|
|
"apikey" : "aeiou",
|
|
"userid" : 123
|
|
}</code></pre>
|
|
|
|
<h3 class="field-label">Produces</h3>
|
|
This API call produces the following media types according to the <span class="header">Accept</span> request header;
|
|
the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
|
|
<ul>
|
|
<li><code>application/json</code></li>
|
|
</ul>
|
|
|
|
<h3 class="field-label">Responses</h3>
|
|
<h4 class="field-label">200</h4>
|
|
Successful login
|
|
<a href="#inline_response_200">inline_response_200</a>
|
|
<h4 class="field-label">400</h4>
|
|
Missing parameters
|
|
<a href="#"></a>
|
|
<h4 class="field-label">500</h4>
|
|
Authentication error
|
|
<a href="#"></a>
|
|
</div> <!-- method -->
|
|
<hr/>
|
|
|
|
<div class="up"><a href="#__Models">Up</a></div>
|
|
<h2><a name="__Models">Models</a></h2>
|
|
[ Jump to <a href="#__Methods">Methods</a> ]
|
|
|
|
<h2>Table of Contents</h2>
|
|
<ol>
|
|
<li><a href="#authdata"><code>authdata</code></a></li>
|
|
<li><a href="#inline_response_200"><code>inline_response_200</code></a></li>
|
|
<li><a href="#inline_response_200_1"><code>inline_response_200_1</code></a></li>
|
|
<li><a href="#inline_response_200_10"><code>inline_response_200_10</code></a></li>
|
|
<li><a href="#inline_response_200_10_diskcfg"><code>inline_response_200_10_diskcfg</code></a></li>
|
|
<li><a href="#inline_response_200_10_image"><code>inline_response_200_10_image</code></a></li>
|
|
<li><a href="#inline_response_200_11"><code>inline_response_200_11</code></a></li>
|
|
<li><a href="#inline_response_200_11_hardware"><code>inline_response_200_11_hardware</code></a></li>
|
|
<li><a href="#inline_response_200_12"><code>inline_response_200_12</code></a></li>
|
|
<li><a href="#inline_response_200_13"><code>inline_response_200_13</code></a></li>
|
|
<li><a href="#inline_response_200_14"><code>inline_response_200_14</code></a></li>
|
|
<li><a href="#inline_response_200_2"><code>inline_response_200_2</code></a></li>
|
|
<li><a href="#inline_response_200_3"><code>inline_response_200_3</code></a></li>
|
|
<li><a href="#inline_response_200_4"><code>inline_response_200_4</code></a></li>
|
|
<li><a href="#inline_response_200_4_client"><code>inline_response_200_4_client</code></a></li>
|
|
<li><a href="#inline_response_200_4_repo"><code>inline_response_200_4_repo</code></a></li>
|
|
<li><a href="#inline_response_200_5"><code>inline_response_200_5</code></a></li>
|
|
<li><a href="#inline_response_200_5_software"><code>inline_response_200_5_software</code></a></li>
|
|
<li><a href="#inline_response_200_6"><code>inline_response_200_6</code></a></li>
|
|
<li><a href="#inline_response_200_7"><code>inline_response_200_7</code></a></li>
|
|
<li><a href="#inline_response_200_8"><code>inline_response_200_8</code></a></li>
|
|
<li><a href="#inline_response_200_9"><code>inline_response_200_9</code></a></li>
|
|
<li><a href="#ousouidimages_ou"><code>ousouidimages_ou</code></a></li>
|
|
<li><a href="#ousouidlabs_ou"><code>ousouidlabs_ou</code></a></li>
|
|
</ol>
|
|
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="authdata">authdata</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<div class="param">username (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">password (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> format: password</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200">inline_response_200</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
<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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_1">inline_response_200_1</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Organization Unit name </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_10">inline_response_200_10</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client name </div>
|
|
<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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<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>
|
|
<div class="field-items">
|
|
<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>
|
|
<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>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">MSDOS</div><div class="param-enum">GPT</div><div class="param-enum">LVM</div><div class="param-enum">ZVOL</div>
|
|
<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>
|
|
<div class="param">parttype (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> partition type </div>
|
|
<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>
|
|
<div class="param">filesystem (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> filesystem type </div>
|
|
<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>
|
|
<div class="param">os (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> installed operating system </div>
|
|
<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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<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>
|
|
<div class="field-items">
|
|
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<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>
|
|
<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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_11">inline_response_200_11</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client name </div>
|
|
<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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<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>
|
|
<div class="field-items">
|
|
<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> hardware component type </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> hardware component description </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_12">inline_response_200_12</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client IP address </div>
|
|
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> execution status </div>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<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>
|
|
<div class="param">loggedin (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> flag to check if an user is logged in </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_13">inline_response_200_13</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_14">inline_response_200_14</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository name </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository description </div>
|
|
<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> repository IP address </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_2">inline_response_200_2</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> OU identificator </div>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> OU name </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> OU description </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_3">inline_response_200_3</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">inremotepc (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
|
|
<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_4">inline_response_200_4</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image name </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image description </div>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<div class="param">release (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image creation release </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<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>
|
|
<div class="field-items">
|
|
<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>
|
|
<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>
|
|
<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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<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>
|
|
<div class="field-items">
|
|
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_5">inline_response_200_5</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> image name </div>
|
|
<div class="param">os (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> installed operating system </div>
|
|
<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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<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>
|
|
<div class="field-items">
|
|
<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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_6">inline_response_200_6</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory name </div>
|
|
<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>
|
|
<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidlabs_ou">ousouidlabs_ou</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_7">inline_response_200_7</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory name </div>
|
|
<div class="param">location (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory location </div>
|
|
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> laboratory description </div>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<div class="param">proxyurl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Proxy server URL </div>
|
|
<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>
|
|
<div class="param-enum-header">Enum:</div>
|
|
<div class="param-enum">full-duplex</div><div class="param-enum">half-duplex</div>
|
|
<div class="param">mcastip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Multicast IP address </div>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_8">inline_response_200_8</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
|
|
<div class="param">ou (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span> </div>
|
|
<div class="param">lab (optional)</div><div class="param-desc"><span class="param-type"><a href="#ousouidimages_ou">ousouidimages_ou</a></span> </div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="inline_response_200_9">inline_response_200_9</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client name </div>
|
|
<div class="param">serialno (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client serial number </div>
|
|
<div class="param">netiface (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> main network interface </div>
|
|
<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>
|
|
<div class="param">mac (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client MAC address </div>
|
|
<div class="param">ip (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> client IP address </div>
|
|
<div class="param">netmask (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> subnet mask address </div>
|
|
<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>
|
|
<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>
|
|
<div class="param">validation (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> boot validation flag </div>
|
|
<div class="param">boottype (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> boot template type </div>
|
|
<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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="ousouidimages_ou">ousouidimages_ou</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<div class="param">id (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> format: int32</div>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
<div class="model">
|
|
<h3 class="field-label"><a name="ousouidlabs_ou">ousouidlabs_ou</a> <a class="up" href="#__Models">Up</a></h3>
|
|
<div class="field-items">
|
|
<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>
|
|
</div> <!-- field-items -->
|
|
</div>
|
|
</body>
|
|
</html>
|