json_AnsibleResult.html 6.2 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: AnsibleResult</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: AnsibleResult</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_AnsibleResult.html">AnsibleResult</a></li>
        </ol>

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

Spiros Koulouzis's avatar
Spiros Koulouzis committed
67 68 69
      <p>This class represents an ansible execution result. This can be used as a
archive / log of ansible executions for example how much time it took for
execution, errors etc.</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

      <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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
85
          <td>  <span class="property-name">msg</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
86
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
87
          <td>  <span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
88 89 90 91 92 93
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
94
          <td>  <span class="property-name">changed</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
95
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
96
          <td>  <span class="datatype-reference">boolean
Spiros Koulouzis's avatar
Spiros Koulouzis committed
97 98 99 100 101 102
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
103
          <td>  <span class="property-name">end</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
104
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
105
          <td>  <span class="datatype-reference">number
Spiros Koulouzis's avatar
Spiros Koulouzis committed
106 107 108 109 110 111
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
112
          <td>  <span class="property-name">stdout</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
113
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
114
          <td>  <span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
115 116 117 118 119 120
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
121
          <td>  <span class="property-name">cmd</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
122
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
123
          <td>  <span class="datatype-reference">array of string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
124 125 126 127 128 129
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
130
          <td>  <span class="property-name">start</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
131
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
132
          <td>  <span class="datatype-reference">number
Spiros Koulouzis's avatar
Spiros Koulouzis committed
133 134 135 136 137 138
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
139
          <td>  <span class="property-name">stderr</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
140
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
141
          <td>  <span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
142 143 144 145 146 147
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
148
          <td>  <span class="property-name">delta</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
149
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
150
          <td>  <span class="datatype-reference">number
Spiros Koulouzis's avatar
Spiros Koulouzis committed
151 152 153 154 155 156 157 158 159 160 161
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-js example">{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
162
  &quot;msg&quot; : &quot;...&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
163
  &quot;changed&quot; : true,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
164
  &quot;end&quot; : 12345,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
165
  &quot;stdout&quot; : &quot;...&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
166
  &quot;cmd&quot; : [ &quot;...&quot;, &quot;...&quot; ],
Spiros Koulouzis's avatar
Spiros Koulouzis committed
167 168 169
  &quot;start&quot; : 12345,
  &quot;stderr&quot; : &quot;...&quot;,
  &quot;delta&quot; : 12345
Spiros Koulouzis's avatar
Spiros Koulouzis committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
}</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>