beckermj/vaguerent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
vaguerent/website/source/docs/triggers/configuration.html.md
Milan Stovicek 3ce7c0cf3f
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 18:51:45 +02:00

2.0 KiB
Raw Blame History

layout page_title sidebar_current description
docs Vagrant Triggers Configuration triggers-configuration 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.

  • run (hash) - A collection of settings to run a inline or remote script on the host. These settings correspond to the shell provisioner. 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.