resource_AnsibleOutputController.html 24.8 KB
Newer Older
Spiros Koulouzis's avatar
Spiros Koulouzis committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->

  <title>drip-api: AnsibleOutputController</title>

  <!-- Mobile viewport optimized: j.mp/bplateviewport -->
  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <!-- Bootstrap core CSS -->
  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">

  <!--custom css for these pages-->
  <link rel="stylesheet" href="css/style.css">

  <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  <!--[if lt IE 9]>
  <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
  <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  <![endif]-->
</head>

<body data-spy="scroll" data-target="#apinav">

  <nav class="navbar navbar-inverse navbar-fixed-top">
    <div class="container-fluid">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="index.html">drip-api: AnsibleOutputController</a>
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
          <li><a href="resources.html">Resources</a></li>
          <li><a href="data.html">Data Types</a></li>
          <li><a href="downloads.html">Files and Libraries</a></li>
        </ul>
      </div>
    </div>
  </nav>

  <div class="container-fluid">
    <div class="row">
      <div class="col-sm-3 col-md-2 sidebar" id="apinav">
        <ul class="nav nav-sidebar">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
54
          <li><a href="#resource_AnsibleOutputController_getByCommand_GET"><abbr title="GET /user/v1.0/deployer/ansible/">GET /user/v1.0/deployer/ansibl...</abbr></a></li>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
          <li><a href="#resource_AnsibleOutputController_deleteAll_DELETE"><abbr title="DELETE /user/v1.0/deployer/ansible/all">DELETE /user/v1.0/deployer/ans...</abbr></a></li>
          <li><a href="#resource_AnsibleOutputController_getCommands_GET"><abbr title="GET /user/v1.0/deployer/ansible/commands">GET /user/v1.0/deployer/ansibl...</abbr></a></li>
          <li><a href="#resource_AnsibleOutputController_getIds_GET"><abbr title="GET /user/v1.0/deployer/ansible/ids">GET /user/v1.0/deployer/ansibl...</abbr></a></li>
          <li><a href="#resource_AnsibleOutputController_delete_DELETE"><abbr title="DELETE /user/v1.0/deployer/ansible/{id}">DELETE /user/v1.0/deployer/ans...</abbr></a></li>
          <li><a href="#resource_AnsibleOutputController_get_GET"><abbr title="GET /user/v1.0/deployer/ansible/{id}">GET /user/v1.0/deployer/ansibl...</abbr></a></li>
          <li class="divider"></li>
          <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
        </ul>
      </div>

      <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
        <ol class="breadcrumb" id="top">
          <li class="active dropdown"><a href="index.html">Home</a></li>
          <li class="active dropdown"><a href="resources.html">Resources</a></li>
          <li class="dropdown"><a href="resource_AnsibleOutputController.html">AnsibleOutputController</a></li>
        </ol>

      <h1 class="page-header">AnsibleOutputController <small>Resource</small></h1>

Spiros Koulouzis's avatar
Spiros Koulouzis committed
74
      <p>This controller is responsible for showing the output from ansible executions</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
75 76

      <div id="resource_AnsibleOutputController_getByCommand_GET">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
77
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/ansible/ <a href="./user/v1.0/deployer/ansible/" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
78

Spiros Koulouzis's avatar
Spiros Koulouzis committed
79
        <p>Query AnsibleOutput by executing command.</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
80 81 82 83 84 85 86 87 88 89 90 91 92

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-parameters">
          <caption>Request Parameters</caption>
          <thead>
          <tr>
            <th>name</th>
            <th>type</th>
            <th>description</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
93
            <th>constraints</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
94 95 96 97 98 99 100
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="parameter-name">command</span></td>
            <td>query</td>
            <td><span class="parameter-description">&nbsp;</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
101
            <td><span class="parameter-constraints">required</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
102 103 104 105 106 107 108 109 110 111 112 113 114
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
115 116 117 118
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Successful query</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">array of <a href="json_AnsibleOutput.html">AnsibleOutput</a>
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">list of <a href="xml_ns0_ansibleOutput.html">ansibleOutput</a>
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
154
GET /user/v1.0/deployer/ansible/
Spiros Koulouzis's avatar
Spiros Koulouzis committed
155 156 157 158 159 160 161 162 163 164 165 166
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-js">
[ {
Spiros Koulouzis's avatar
Spiros Koulouzis committed
167
  &quot;host&quot; : &quot;147.228.242.58&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
168
  &quot;result&quot; : {
Spiros Koulouzis's avatar
Spiros Koulouzis committed
169
    &quot;msg&quot; : &quot;...&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
170
    &quot;changed&quot; : true,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
171
    &quot;end&quot; : 12345,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
172
    &quot;stdout&quot; : &quot;...&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
173
    &quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ],
Spiros Koulouzis's avatar
Spiros Koulouzis committed
174 175 176
    &quot;start&quot; : 12345,
    &quot;stderr&quot; : &quot;...&quot;,
    &quot;delta&quot; : 12345
Spiros Koulouzis's avatar
Spiros Koulouzis committed
177
  },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
178 179 180 181
  &quot;cloudDeploymentDomain&quot; : &quot;https://carach5.ics.muni.cz:11443&quot;,
  &quot;vmType&quot; : &quot;medium&quot;,
  &quot;provisionID&quot; : &quot;59172db6e452f1b9b666a621&quot;,
  &quot;cloudProvider&quot; : &quot;ec2&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
182
  &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
183
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
184
  &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
185 186 187 188 189 190 191 192 193
} ]
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_AnsibleOutputController_deleteAll_DELETE">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
194
        <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/deployer/ansible/all <a href="./user/v1.0/deployer/ansible/all" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
195

Spiros Koulouzis's avatar
Spiros Koulouzis committed
196
        <p>Deletes all entries. Use with caution !</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN</dd>
        </dl>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
212 213 214 215
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Successful delete</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">string
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
DELETE /user/v1.0/deployer/ansible/all
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
259
HTTP/1.1 200 Looks Good
Spiros Koulouzis's avatar
Spiros Koulouzis committed
260 261 262 263 264 265 266 267 268 269 270 271
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_AnsibleOutputController_getCommands_GET">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
272
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/ansible/commands <a href="./user/v1.0/deployer/ansible/commands" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
273

Spiros Koulouzis's avatar
Spiros Koulouzis committed
274
        <p>Query for used (unique) commands</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
290 291 292 293
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Successful query</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">array of string
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">list of string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
GET /user/v1.0/deployer/ansible/commands
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_AnsibleOutputController_getIds_GET">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
350
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/ansible/ids <a href="./user/v1.0/deployer/ansible/ids" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
351

Spiros Koulouzis's avatar
Spiros Koulouzis committed
352
        <p>Returns the ids of stored objects. Empty list if non stored</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
368 369 370 371
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Successful query</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">array of string
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">list of string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
GET /user/v1.0/deployer/ansible/ids
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_AnsibleOutputController_delete_DELETE">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
428
        <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/deployer/ansible/{id} <a href="./user/v1.0/deployer/ansible/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
429

Spiros Koulouzis's avatar
Spiros Koulouzis committed
430
        <p>Deletes object</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
431 432 433 434 435 436 437 438 439 440 441 442 443

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-parameters">
          <caption>Request Parameters</caption>
          <thead>
          <tr>
            <th>name</th>
            <th>type</th>
            <th>description</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
444
            <th>constraints</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
445 446 447 448 449 450 451
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="parameter-name">id</span></td>
            <td>path</td>
            <td><span class="parameter-description">&nbsp;</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
452
            <td><span class="parameter-constraints">required</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
453 454 455 456 457 458 459 460 461 462 463 464 465
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
466 467 468 469 470 471 472 473
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">Successful delete</span></td>
          </tr>
          <tr>
            <td><span class="label label-warning response-code">404</span></td>
            <td><span class="response-condition">Non existing id</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference">string
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference">string
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
DELETE /user/v1.0/deployer/ansible/{id}
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
517
HTTP/1.1 200 Looks Good
Spiros Koulouzis's avatar
Spiros Koulouzis committed
518 519 520 521 522 523 524 525 526 527 528 529
Content-Type: application/json

                <code class="prettyprint language-txt">
...
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

      <div id="resource_AnsibleOutputController_get_GET">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
530
        <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/deployer/ansible/{id} <a href="./user/v1.0/deployer/ansible/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
531

Spiros Koulouzis's avatar
Spiros Koulouzis committed
532
        <p>Returns an AnsibleOutput.</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
533 534 535 536 537 538 539 540 541 542 543 544 545

        <dl class="dl-horizontal">
          <dt>Security Roles Allowed</dt>
          <dd>ADMIN, USER</dd>
        </dl>

        <table class="table resource-parameters">
          <caption>Request Parameters</caption>
          <thead>
          <tr>
            <th>name</th>
            <th>type</th>
            <th>description</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
546
            <th>constraints</th>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
547 548 549 550 551 552 553
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><span class="parameter-name">id</span></td>
            <td>path</td>
            <td><span class="parameter-description">&nbsp;</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
554
            <td><span class="parameter-constraints">required</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
555 556 557 558 559 560 561 562 563 564 565 566 567
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-codes">
          <caption>Response Codes</caption>
          <thead>
          <tr>
            <th>code</th>
            <th>condition</th>
          </tr>
          </thead>
          <tbody>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
568 569 570 571 572 573 574 575
          <tr>
            <td><span class="label label-warning response-code">404</span></td>
            <td><span class="response-condition">AnsibleOutput not found</span></td>
          </tr>
          <tr>
            <td><span class="label label-success response-code">200</span></td>
            <td><span class="response-condition">AnsibleOutput exists</span></td>
          </tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
          <tr>
            <td><span class="label label-warning response-code">401</span></td>
            <td><span class="response-condition">Bad credentials</span></td>
          </tr>
          </tbody>
        </table>

        <table class="table resource-response-body">
          <caption>Response Body</caption>
          <thead>
          <tr>
            <th>media type</th>
            <th>data type</th>
          </tr>
          </thead>
          <tbody>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/json&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
            <td><span class="datatype-reference"><a href="json_AnsibleOutput.html">AnsibleOutput</a>
 (JSON)</span></td>
          </tr>
          <tr>
            <td><abbr data-toggle="tooltip" data-placement="top" title="Use the &quot;Accept: application/xml&quot; HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
            <td><span class="datatype-reference"><a href="xml_ns0_ansibleOutput.html">ansibleOutput</a>
 (XML)</span></td>
          </tr>
          </tbody>
        </table>
        <h4>Example</h4>

        <div class="container-fluid example panel">
          <div class="row panel-body">
            <div class="col-md-6">
              <h5>Request</h5>
              <pre>
GET /user/v1.0/deployer/ansible/{id}
Accept: application/json

              </pre>
            </div>
            <div class="col-md-6">
              <h5>Response</h5>
              <pre>
HTTP/1.1 200 Looks Good
Content-Type: application/json

                <code class="prettyprint language-js">
{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
624
  &quot;host&quot; : &quot;147.228.242.58&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
625
  &quot;result&quot; : {
Spiros Koulouzis's avatar
Spiros Koulouzis committed
626
    &quot;msg&quot; : &quot;...&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
627
    &quot;changed&quot; : true,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
628
    &quot;end&quot; : 12345,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
629
    &quot;stdout&quot; : &quot;...&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
630
    &quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ],
Spiros Koulouzis's avatar
Spiros Koulouzis committed
631 632 633
    &quot;start&quot; : 12345,
    &quot;stderr&quot; : &quot;...&quot;,
    &quot;delta&quot; : 12345
Spiros Koulouzis's avatar
Spiros Koulouzis committed
634
  },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
635 636 637 638
  &quot;cloudDeploymentDomain&quot; : &quot;https://carach5.ics.muni.cz:11443&quot;,
  &quot;vmType&quot; : &quot;medium&quot;,
  &quot;provisionID&quot; : &quot;59172db6e452f1b9b666a621&quot;,
  &quot;cloudProvider&quot; : &quot;ec2&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
639
  &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
640
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
641
  &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
}
                </code>
              </pre>
            </div>
          </div>
        </div>
      </div>

        <footer class="footer">
          <div class="container">
            <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
          </div>
        </footer>

      </div>
    </div>
  </div>


  <!-- JavaScript placed at the end of the document so the pages load faster. -->
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>

  <!-- Bootstrap core JavaScript
  ================================================== -->
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>

  <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
  <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
  <script>
    $(function() {
      $(".clickable-row").click(function() {
        window.document.location = $(this).data("href");
      });

      $('[data-toggle="tooltip"]').tooltip()
    });
  </script>

</body>
</html>