From 1d05be82f004f28e76df39d46bad1a2aa899ef89 Mon Sep 17 00:00:00 2001 From: Stephen Jahl Date: Fri, 3 Oct 2014 19:45:35 -0400 Subject: [PATCH] Documents the --step and --start-at options to ansible-playbook. Fixes #9041. --- docsite/rst/playbooks_intro.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docsite/rst/playbooks_intro.rst b/docsite/rst/playbooks_intro.rst index 70db3f7fe27..c93cf7f9838 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