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