diff options
| -rw-r--r-- | docsite/rst/playbooks_special_topics.rst | 1 | ||||
| -rw-r--r-- | docsite/rst/playbooks_startnstep.rst | 38 |
2 files changed, 39 insertions, 0 deletions
diff --git a/docsite/rst/playbooks_special_topics.rst b/docsite/rst/playbooks_special_topics.rst index 078b27f253..c57f5796c9 100644 --- a/docsite/rst/playbooks_special_topics.rst +++ b/docsite/rst/playbooks_special_topics.rst @@ -17,3 +17,4 @@ and adopt these only if they seem relevant or useful to your environment. playbooks_prompts playbooks_tags playbooks_vault + playbooks_startnstep diff --git a/docsite/rst/playbooks_startnstep.rst b/docsite/rst/playbooks_startnstep.rst new file mode 100644 index 0000000000..1238a710d8 --- /dev/null +++ b/docsite/rst/playbooks_startnstep.rst @@ -0,0 +1,38 @@ +Start and Step +====================== +.. versionadded:: 1.8 + +.. contents:: Topics + +This shows a few special ways to run playbooks, very useful for testing and debugging. + + +Start-at-task +````````````` +.. versionadded:: 1.2 + +If you want to start executing your playbook at a particular task, you can do so +with the ``--start-at`` option:: + + ansible-playbook playbook.yml --start-at="install packages" + +The above will start executing your playbook at a task named "install packages". + + +Step +```` +.. versionadded:: 1.1 + + +Playbooks can also be executed interactively with ``--step``:: + + ansible-playbook playbook.yml --step + +This will cause ansible to stop on each task, and ask if it should execute that task. +Say you had a task called "configure ssh", the playbook run will stop and ask:: + + Perform task: configure ssh (y/n/c): + +Answering "y" will execute the task, answering "n" will skip the task, and answering "c" +will continue executing all the remaining tasks without asking. + |