Merge pull request #9266 from sjahl/step-start-docs

Documents the --step and --start-at options to ansible-playbook.

1 files changed, 19 insertions, 0 deletions

diff --git a/docsite/rst/playbooks_intro.rst b/docsite/rst/playbooks_intro.rst
index 4bc3bccf2d..cc55f28261 100644
--- a/docsite/rst/playbooks_intro.rst
+++ b/docsite/rst/playbooks_intro.rst
@@ -335,6 +335,25 @@ Let's run a playbook using a parallelism level of 10::
 
     ansible-playbook playbook.yml -f 10
 
+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.
+
+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".
+
 .. _ansible-pull:
 
 Ansible-Pull