-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathactuator.exec_agents.ansible.agent.TaskProcessor-class.html
395 lines (370 loc) · 15.7 KB
/
actuator.exec_agents.ansible.agent.TaskProcessor-class.html
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
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
204
205
206
207
208
209
210
211
212
213
214
215
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>actuator.exec_agents.ansible.agent.TaskProcessor</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="actuator-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>Actuator</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="actuator-module.html">Package actuator</a> ::
<a href="actuator.exec_agents-module.html">Package exec_agents</a> ::
<a href="actuator.exec_agents.ansible-module.html">Package ansible</a> ::
<a href="actuator.exec_agents.ansible.agent-module.html">Module agent</a> ::
Class TaskProcessor
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="actuator.exec_agents.ansible.agent.TaskProcessor-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class TaskProcessor</h1><p class="nomargin-top"><span class="codelink"><a href="actuator.exec_agents.ansible.agent-pysrc.html#TaskProcessor">source code</a></span></p>
<pre class="base-tree">
object --+
|
<strong class="uidshort">TaskProcessor</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="actuator.exec_agents.ansible.agent.ScriptProcessor-class.html">ScriptProcessor</a></li><li>, <a href="actuator.exec_agents.ansible.agent.CopyFileProcessor-class.html">CopyFileProcessor</a></li><li>, <a href="actuator.exec_agents.ansible.agent.PingProcessor-class.html">PingProcessor</a></li> </ul>
</dd></dl>
<hr />
<p>Base class for all Ansible task processing classes. Establishes the
protocol for naming modules, making argument structures, and checking
results.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="actuator.exec_agents.ansible.agent.TaskProcessor-class.html#module_name" class="summary-sig-name">module_name</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns the name of the Ansible module to use.</td>
<td align="right" valign="top">
<span class="codelink"><a href="actuator.exec_agents.ansible.agent-pysrc.html#TaskProcessor.module_name">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="actuator.exec_agents.ansible.agent.TaskProcessor-class.html#make_args" class="summary-sig-name">make_args</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">task</span>,
<span class="summary-sig-arg">hlist</span>)</span><br />
Make the genericargument structure to use with the Ansible Runner
object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="actuator.exec_agents.ansible.agent-pysrc.html#TaskProcessor.make_args">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="actuator.exec_agents.ansible.agent.TaskProcessor-class.html#_make_args" class="summary-sig-name" onclick="show_private();">_make_args</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">task</span>)</span><br />
Supplies the module-specific arguments for the processor.</td>
<td align="right" valign="top">
<span class="codelink"><a href="actuator.exec_agents.ansible.agent-pysrc.html#TaskProcessor._make_args">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="actuator.exec_agents.ansible.agent.TaskProcessor-class.html#result_check" class="summary-sig-name">result_check</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">task</span>,
<span class="summary-sig-arg">result</span>,
<span class="summary-sig-arg">logfile</span>=<span class="summary-sig-default">None</span>)</span><br />
Checks the result of a Ansible Runner invocation.</td>
<td align="right" valign="top">
<span class="codelink"><a href="actuator.exec_agents.ansible.agent-pysrc.html#TaskProcessor.result_check">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__init__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="module_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">module_name</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="actuator.exec_agents.ansible.agent-pysrc.html#TaskProcessor.module_name">source code</a></span>
</td>
</tr></table>
<p>Returns the name of the Ansible module to use. The derived class must
implement this and return a suitable string with the module name in
it.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="make_args"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">make_args</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">task</span>,
<span class="sig-arg">hlist</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="actuator.exec_agents.ansible.agent-pysrc.html#TaskProcessor.make_args">source code</a></span>
</td>
</tr></table>
<p>Make the genericargument structure to use with the Ansible Runner
object.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>task</code></strong> - the task object to process</li>
<li><strong class="pname"><code>hlist</code></strong> - A list of host names/IPs to apply the task to.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="_make_args"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_make_args</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">task</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="actuator.exec_agents.ansible.agent-pysrc.html#TaskProcessor._make_args">source code</a></span>
</td>
</tr></table>
<p>Supplies the module-specific arguments for the processor. Must return
a dict of Ansible Runner keyword args that are relevant to the module the
class is for. The derived class must override this method.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="result_check"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">result_check</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">task</span>,
<span class="sig-arg">result</span>,
<span class="sig-arg">logfile</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="actuator.exec_agents.ansible.agent-pysrc.html#TaskProcessor.result_check">source code</a></span>
</td>
</tr></table>
<p>Checks the result of a Ansible Runner invocation. If there is a
problem, raise ExecutionException with helpful data in the response.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>task</code></strong> - the Task that was performed</li>
<li><strong class="pname"><code>result</code></strong> - The result dict returned from the Runner</li>
<li><strong class="pname"><code>logfile</code></strong> - If present, a file-like object that log messages will be written,
regardless of the log level.</li>
</ul></dd>
<dt>Raises:</dt>
<dd><ul class="nomargin-top">
<li><code><strong class='fraise'><a href="actuator.exec_agents.core.ExecutionException-class.html">ExecutionException</a></strong></code> - Raised if the result looks bad; the result itself will be formatted
and added to the exception in the exception's 'response' attribute.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="actuator-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>Actuator</th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Feb 9 18:19:52 2015
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>