@@ -298,6 +298,11 @@ <h2>Shell control & features<a class="headerlink" href="#shell-control-featu
298298< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> Union[str,</ span > < span class ="pre "> Iterable]</ span > </ code > </ p > </ td >
299299< td > </ td >
300300</ tr >
301+ < tr class ="row-odd "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _temp_dir</ span > </ code > </ p > </ td >
302+ < td > < p > Temporary directory on the remote host for file operations.</ p > </ td >
303+ < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> str</ span > </ code > </ p > </ td >
304+ < td > </ td >
305+ </ tr >
301306</ tbody >
302307</ table >
303308< p > < strong > Examples:</ strong > </ p >
@@ -320,29 +325,29 @@ <h2>Operation meta & callbacks<a class="headerlink" href="#operation-meta-ca
320325< col style ="width: 15.0% " />
321326</ colgroup >
322327< thead >
323- < tr class ="row-odd "> < th class ="head "> < p > Key</ p > </ th >
328+ < tr class ="row-even "> < th class ="head "> < p > Key</ p > </ th >
324329< th class ="head "> < p > Description</ p > </ th >
325330< th class ="head "> < p > Type</ p > </ th >
326331< th class ="head "> < p > Default</ p > </ th >
327332</ tr >
328333</ thead >
329334< tbody >
330- < tr class ="row-even "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> name</ span > </ code > </ p > </ td >
335+ < tr class ="row-odd "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> name</ span > </ code > </ p > </ td >
331336< td > < p > Name of the operation.</ p > </ td >
332337< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> str</ span > </ code > </ p > </ td >
333338< td > </ td >
334339</ tr >
335- < tr class ="row-odd "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _ignore_errors</ span > </ code > </ p > </ td >
340+ < tr class ="row-even "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _ignore_errors</ span > </ code > </ p > </ td >
336341< td > < p > Ignore errors when executing the operation.</ p > </ td >
337342< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> bool</ span > </ code > </ p > </ td >
338343< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> False</ span > </ code > </ p > </ td >
339344</ tr >
340- < tr class ="row-even "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _continue_on_error</ span > </ code > </ p > </ td >
345+ < tr class ="row-odd "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _continue_on_error</ span > </ code > </ p > </ td >
341346< td > < p > Continue executing operation commands after error. Only applies when < code class ="docutils literal notranslate "> < span class ="pre "> _ignore_errors</ span > </ code > is true.</ p > </ td >
342347< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> bool</ span > </ code > </ p > </ td >
343348< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> False</ span > </ code > </ p > </ td >
344349</ tr >
345- < tr class ="row-odd "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _if</ span > </ code > </ p > </ td >
350+ < tr class ="row-even "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _if</ span > </ code > </ p > </ td >
346351< td > < p > Only run this operation if these functions return True</ p > </ td >
347352< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> Union[List,</ span > < span class ="pre "> Callable,</ span > < span class ="pre "> NoneType]</ span > </ code > </ p > </ td >
348353< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> []</ span > </ code > </ p > </ td >
@@ -360,24 +365,24 @@ <h2>Execution strategy<a class="headerlink" href="#execution-strategy" title="Li
360365< col style ="width: 15.0% " />
361366</ colgroup >
362367< thead >
363- < tr class ="row-even "> < th class ="head "> < p > Key</ p > </ th >
368+ < tr class ="row-odd "> < th class ="head "> < p > Key</ p > </ th >
364369< th class ="head "> < p > Description</ p > </ th >
365370< th class ="head "> < p > Type</ p > </ th >
366371< th class ="head "> < p > Default</ p > </ th >
367372</ tr >
368373</ thead >
369374< tbody >
370- < tr class ="row-odd "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _parallel</ span > </ code > </ p > </ td >
375+ < tr class ="row-even "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _parallel</ span > </ code > </ p > </ td >
371376< td > < p > Run this operation in batches of hosts.</ p > </ td >
372377< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> int</ span > </ code > </ p > </ td >
373378< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> 0</ span > </ code > </ p > </ td >
374379</ tr >
375- < tr class ="row-even "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _run_once</ span > </ code > </ p > </ td >
380+ < tr class ="row-odd "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _run_once</ span > </ code > </ p > </ td >
376381< td > < p > Only execute this operation once, on the first host to see it.</ p > </ td >
377382< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> bool</ span > </ code > </ p > </ td >
378383< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> False</ span > </ code > </ p > </ td >
379384</ tr >
380- < tr class ="row-odd "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _serial</ span > </ code > </ p > </ td >
385+ < tr class ="row-even "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _serial</ span > </ code > </ p > </ td >
381386< td > < p > Run this operation host by host, rather than in parallel.</ p > </ td >
382387< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> bool</ span > </ code > </ p > </ td >
383388< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> False</ span > </ code > </ p > </ td >
@@ -398,24 +403,24 @@ <h2>Retry behavior<a class="headerlink" href="#retry-behavior" title="Link to th
398403< col style ="width: 15.0% " />
399404</ colgroup >
400405< thead >
401- < tr class ="row-even "> < th class ="head "> < p > Key</ p > </ th >
406+ < tr class ="row-odd "> < th class ="head "> < p > Key</ p > </ th >
402407< th class ="head "> < p > Description</ p > </ th >
403408< th class ="head "> < p > Type</ p > </ th >
404409< th class ="head "> < p > Default</ p > </ th >
405410</ tr >
406411</ thead >
407412< tbody >
408- < tr class ="row-odd "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _retries</ span > </ code > </ p > </ td >
413+ < tr class ="row-even "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _retries</ span > </ code > </ p > </ td >
409414< td > < p > Number of times to retry failed operations.</ p > </ td >
410415< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> int</ span > </ code > </ p > </ td >
411416< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> 0</ span > </ code > </ p > </ td >
412417</ tr >
413- < tr class ="row-even "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _retry_delay</ span > </ code > </ p > </ td >
418+ < tr class ="row-odd "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _retry_delay</ span > </ code > </ p > </ td >
414419< td > < p > Delay in seconds between retry attempts.</ p > </ td >
415420< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> Union[int,</ span > < span class ="pre "> float]</ span > </ code > </ p > </ td >
416421< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> 5</ span > </ code > </ p > </ td >
417422</ tr >
418- < tr class ="row-odd "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _retry_until</ span > </ code > </ p > </ td >
423+ < tr class ="row-even "> < td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> _retry_until</ span > </ code > </ p > </ td >
419424< td > < p > Callable taking output data that returns True to continue retrying.</ p > </ td >
420425< td > < p > < code class ="docutils literal notranslate "> < span class ="pre "> Optional[Callable,</ span > < span class ="pre "> NoneType]</ span > </ code > </ p > </ td >
421426< td > </ td >
0 commit comments