vagrant/website/source/docs/triggers/configuration.html.md

---
layout: "docs"
page_title: "Vagrant Triggers Configuration"
sidebar_current: "triggers-configuration"
description: |-
  Documentation of various configuration options for Vagrant Triggers
---

# Configuration

Vagrant Triggers has a few options to define trigger behavior.

## Options

The trigger class takes various options.

* `action` (symbol, array) - Expected to be a single symbol value, an array of symbols, or a _splat_ of symbols. The first argument that comes after either __before__ or __after__ when defining a new trigger. Can be any valid Vagrant command. It also accepts a special value `:all` which will make the trigger fire for every action. An action can be ignored with the `ignore` setting if desired. These are the valid action commands for triggers:

  - `destroy`
  - `halt`
  - `provision`
  - `reload`
  - `resume`
  - `suspend`
  - `up`

* `ignore` (symbol, array) - Symbol or array of symbols corresponding to the action that a trigger should not fire on.

* `info` (string) - A message that will be printed at the beginning of a trigger.

* `name` (string) - The name of the trigger. If set, the name will be displayed when firing the trigger.

* `on_error` (symbol) - Defines how the trigger should behave if it encounters an error. By default this will be `:halt`, but can be configured to ignore failures and continue on with `:continue`.

* `only_on` (string, regex, array) - Limit the trigger to these guests. Values can be a string or regex that matches a guest name.

* `run_remote` (hash) - A collection of settings to run a inline or remote script with on the guest. These settings correspond to the [shell provisioner](/docs/provisioning/shell.html).

* `run` (hash) - A collection of settings to run a inline or remote script on the host. These settings correspond to the [shell provisioner](/docs/provisioning/shell.html). However, at the moment the only settings `run` takes advantage of are:
  + `args`
  + `inline`
  + `path`

* `warn` (string) - A warning message that will be printed at the beginning of a trigger.

* `exit_codes` (integer, array) - A set of acceptable exit codes to continue on. Defaults to `0` if option is absent. For now only valid with the `run` option.

* `abort` (integer,boolean) - An option that will exit the running Vagrant process once the trigger fires. If set to `true`, Vagrant will use exit code 1. Otherwise, an integer can be provided and Vagrant will it as its exit code when aborting.
Add basic website pages for triggers 2018-03-29 16:08:25 +00:00			`---`
			`layout: "docs"`
			`page_title: "Vagrant Triggers Configuration"`
			`sidebar_current: "triggers-configuration"`
			`description: \|-`
Website updates based on feedback 2018-04-23 16:14:31 +00:00			`Documentation of various configuration options for Vagrant Triggers`
Add basic website pages for triggers 2018-03-29 16:08:25 +00:00			`---`

Update trigger config docs 2018-03-30 22:37:43 +00:00			`# Configuration`
Add basic website pages for triggers 2018-03-29 16:08:25 +00:00
Website updates based on feedback 2018-04-23 16:14:31 +00:00			`Vagrant Triggers has a few options to define trigger behavior.`
Add trigger documentation 2018-04-04 22:00:26 +00:00
Update trigger config docs 2018-03-30 22:37:43 +00:00			`## Options`

			`The trigger class takes various options.`

Document valid trigger commands 2018-04-24 18:07:37 +00:00			* `action` (symbol, array) - Expected to be a single symbol value, an array of symbols, or a _splat_ of symbols. The first argument that comes after either __before__ or __after__ when defining a new trigger. Can be any valid Vagrant command. It also accepts a special value `:all` which will make the trigger fire for every action. An action can be ignored with the `ignore` setting if desired. These are the valid action commands for triggers:

			- `destroy`
			- `halt`
			- `provision`
			- `reload`
			- `resume`
Add `suspend` into a list of available actions `suspend` action is not listed, even though it can be used and it works. ``` $ vagrant --version Vagrant 2.1.1 ``` ``` config.trigger.before [:suspend] do \|trigger\| trigger.name = "Before suspend" trigger.run = {inline: "..."} end ```` 2018-06-13 16:51:45 +00:00			- `suspend`
Document valid trigger commands 2018-04-24 18:07:37 +00:00			- `up`
Update trigger config docs 2018-03-30 22:37:43 +00:00
			* `ignore` (symbol, array) - Symbol or array of symbols corresponding to the action that a trigger should not fire on.

			* `info` (string) - A message that will be printed at the beginning of a trigger.

Add trigger documentation 2018-04-04 22:00:26 +00:00			* `name` (string) - The name of the trigger. If set, the name will be displayed when firing the trigger.
Update trigger config docs 2018-03-30 22:37:43 +00:00
			* `on_error` (symbol) - Defines how the trigger should behave if it encounters an error. By default this will be `:halt`, but can be configured to ignore failures and continue on with `:continue`.

reword the triggers only_on documentation 2018-05-06 19:25:46 +00:00			* `only_on` (string, regex, array) - Limit the trigger to these guests. Values can be a string or regex that matches a guest name.
Update trigger config docs 2018-03-30 22:37:43 +00:00
Update configuration.html.md fix typos 2018-05-06 19:23:20 +00:00			* `run_remote` (hash) - A collection of settings to run a inline or remote script with on the guest. These settings correspond to the [shell provisioner](/docs/provisioning/shell.html).
Update trigger config docs 2018-03-30 22:37:43 +00:00
Update configuration.html.md fix typos 2018-05-06 19:23:20 +00:00			* `run` (hash) - A collection of settings to run a inline or remote script on the host. These settings correspond to the [shell provisioner](/docs/provisioning/shell.html). However, at the moment the only settings `run` takes advantage of are:
Use args setting for run option in trigger 2018-04-05 16:08:09 +00:00			+ `args`
			+ `inline`
			+ `path`
Update trigger config docs 2018-03-30 22:37:43 +00:00
			* `warn` (string) - A warning message that will be printed at the beginning of a trigger.
(#9997) Catch and allow for non-standard exit codes Prior to this commit, the run trigger option wouldn't catch for failures outside of the #Subprocess.execute raising exceptions. This commit fixes that by inspecting the exit code result of the subprocess and using the new `exit_codes` option to determine how to move forward with the trigger. 2018-07-09 22:19:13 +00:00
			* `exit_codes` (integer, array) - A set of acceptable exit codes to continue on. Defaults to `0` if option is absent. For now only valid with the `run` option.
Add abort option to core triggers This commit adds a new option `abort`, which when configured, will exit the Vagrant process completely. If set to `true`, it will exit cleanly with exit code 0. Otherwise, the exit code can be configured. 2018-09-22 00:08:26 +00:00
			* `abort` (integer,boolean) - An option that will exit the running Vagrant process once the trigger fires. If set to `true`, Vagrant will use exit code 1. Otherwise, an integer can be provided and Vagrant will it as its exit code when aborting.