Running a runbook

How to run a runbook in Octopus Deploy

  1. Navigate to your project and select Runbooks.
  2. Select the runbook you want to run.
  3. Click RUN….

    run runbook basic options

  4. Select one more more environments for the execution.
  5. Click RUN to run now, or select Show advanced to display advanced configuration options.

Schedule a runbook run

  1. After expanding the advanced options on your runbook run, expand the WHEN section and select later.
  2. Specify the time and date you would like the runbook to run.
  3. Click RUN.

Exclude steps from runbook runs

  1. After expanding the advanced options on your runbook run, expand the Excluded steps section and use the check-box to select steps to exclude from the runbook run.
  2. Click RUN.

Modify the guided failure mode

Guided failure mode asks for users to intervene when a runbook encounters an error. Learn more about guided failures.

  1. After expanding the advanced options on your runbook run, expand the Failure mode section, and select the mode you want to use.
  2. Click RUN.

Run on a specific subset of deployment targets

You can run a runbook on a specific subset of deployment targets.

  1. After expanding the advanced options on your runbook run, expand the Preview and customize section.
  2. Expand the Deployment Targets section.
  3. Select your target selection method:
    • Include all applicable deployment targets (default)
    • Include specific deployment targets: Choose individual targets to include
    • Exclude specific deployment targets: Choose individual targets to exclude
    • Include specific target tags: Include targets with selected tags
    • Exclude specific target tags: Exclude targets with selected tags
  4. Click RUN.

Further reading

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Thursday, April 16, 2026