json_AnsibleOutput.html 7.58 KB
Newer Older
Spiros Koulouzis's avatar
Spiros Koulouzis committed
1 2 3 4 5 6 7 8
<!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 -->

Spiros Koulouzis's avatar
Spiros Koulouzis committed
9
  <title>drip-api: AnsibleOutput</title>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
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

  <!-- 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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
38
        <a class="navbar-brand" href="index.html">drip-api: AnsibleOutput</a>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
39 40 41
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
42
          <li><a href="resources.html">Resources</a></li>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
          <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">
          <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="syntax_json.html">JSON</a></li>
          <li class="dropdown"><a href="json_AnsibleOutput.html">AnsibleOutput</a></li>
        </ol>

      <h1 class="page-header">AnsibleOutput <small>Data Type</small></h1>

Spiros Koulouzis's avatar
Spiros Koulouzis committed
67 68
      <p>This class represents the the ansible out put for a specific VM. This can be
used as a archive / log of ansible executions</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88

      <dl class="dl-horizontal">
      </dl>

      <table class="table datatype-properties">
        <caption>Properties</caption>
        <thead>
        <tr>
          <th>name</th>
          <th>data type</th>
          <th>description</th>
        </tr>
        </thead>
        <tbody>
        <tr>
          <td>  <span class="property-name">host</span>
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
89
          <td>  <span class="property-description">The host (IP) of the VM that executed the playbook</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
90 91 92 93 94 95 96 97
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">result</span>
</td>
          <td>  <span class="datatype-reference"><a href="json_AnsibleResult.html">AnsibleResult</a>
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
98
          <td>  <span class="property-description">The output of the playbook execution</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
99 100 101
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
102
          <td>  <span class="property-name">cloudDeploymentDomain</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
103 104 105 106
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
107
          <td>  <span class="property-description">The cloud domain where the VM that run the playbook</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
108 109 110
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
111
          <td>  <span class="property-name">vmType</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
112 113 114 115
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
116
          <td>  <span class="property-description">The type of VM that run the playbook</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
117 118 119
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
120
          <td>  <span class="property-name">provisionID</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
121 122 123 124
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
125
          <td>  <span class="property-description">The provision used to spawn the VM for this playbook execution</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
126 127 128
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
129
          <td>  <span class="property-name">cloudProvider</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
130 131 132 133
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
134
          <td>  <span class="property-description">The cloud provider</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
135 136 137 138 139 140 141 142
</td>
        </tr>
        </tbody>
        <tr>
          <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_OwnedObject.html">OwnedObject</a></h5></td>
        </tr>
        <tbody>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
143
          <td><span class="property-name">owner</span></td>
144
          <td><span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
145
</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
146 147
          <td><span class="property-description">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
148 149
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
150 151
          <td><span class="property-name">id</span></td>
          <td><span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
152 153 154 155 156 157 158
</span></td>
          <td><span class="property-description">The UID of this object. This value is auto generated by the DAO when the
object is saved.</span></td>
        </tr>
        <tr>
          <td><span class="property-name">timestamp</span></td>
          <td><span class="datatype-reference">number
Spiros Koulouzis's avatar
Spiros Koulouzis committed
159
</span></td>
160
          <td><span class="property-description">The object's creation date in unix time stamp</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
161 162 163 164 165 166 167
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-js example">{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
168
  &quot;host&quot; : &quot;147.228.242.58&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
169
  &quot;result&quot; : {
Spiros Koulouzis's avatar
Spiros Koulouzis committed
170
    &quot;msg&quot; : &quot;...&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
171
    &quot;changed&quot; : true,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
172
    &quot;end&quot; : 12345,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
173
    &quot;stdout&quot; : &quot;...&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
174
    &quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ],
Spiros Koulouzis's avatar
Spiros Koulouzis committed
175 176 177
    &quot;start&quot; : 12345,
    &quot;stderr&quot; : &quot;...&quot;,
    &quot;delta&quot; : 12345
Spiros Koulouzis's avatar
Spiros Koulouzis committed
178
  },
Spiros Koulouzis's avatar
Spiros Koulouzis committed
179 180 181 182
  &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
183
  &quot;owner&quot; : &quot;user1&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
184
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
185
  &quot;timestamp&quot; : 1499793079011
Spiros Koulouzis's avatar
Spiros Koulouzis committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
}</pre>

        <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>