VagrantUpSettings Class

Summary

Additional settings for the vagrant up command
Assembly
Cake.Vagrant.dll
Namespace
Cake.Vagrant.Settings
Interfaces
  • IVagrantCommandSettings
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IVagrantCommandSettings"] Type["VagrantUpSettings"] class Type type-node

Syntax

public class VagrantUpSettings : IVagrantCommandSettings

Constructors

Name Summary
VagrantUpSettings()

Properties

Name Value Summary
DestroyOnError Nullable<bool>
Destroy the newly created machine if a fatal, unexpected error occurs. This will only happen on the first vagrant up. By default this is set.
InstallProvider Nullable<bool>
If the requested provider is not installed, Vagrant will attempt to automatically install it if it can. By default this is enabled.
Parallel Nullable<bool>
Bring multiple machines up in parallel if the provider supports it. Please consult the provider documentation to see if this feature is supported.
Provider string
Bring the machine up with the given provider. By default this is "virtualbox".
Provisioners IEnumerable<string>
This will only run the given provisioners.
RunProvisioners Nullable<bool>
Force the provisioners to run.

Methods

Name Value Summary
GetToolArguments() Action<ProcessArgumentBuilder>
Gets the command arguments corresponding to the specified IVagrantCommandSettings

Extension Methods

Name Value Summary
DestroyOnError(bool) VagrantUpSettings
Destroy the newly created machine if a fatal, unexpected error occurs. This will only happen on the first vagrant up.
Requires the Cake.Vagrant addin
Dump<VagrantUpSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
EnableParallel() VagrantUpSettings
Bring multiple machines up in parallel if the provider supports it.
Requires the Cake.Vagrant addin
InstallProvider(bool) VagrantUpSettings
Instructs Vagrant to attempt to install the chosen provider if it is not installed.
Requires the Cake.Vagrant addin
IsIn<VagrantUpSettings>(VagrantUpSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<VagrantUpSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<VagrantUpSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
RunProvisioners(bool) VagrantUpSettings
Force the provisioners to run when bringing up the machine
Requires the Cake.Vagrant addin
ThrowIfNull<VagrantUpSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<VagrantUpSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
UseProvider(string) VagrantUpSettings
Bring the machine up with the given provider. By default this is "virtualbox".
Requires the Cake.Vagrant addin
WithProvisioners(IEnumerable<string>) VagrantUpSettings
This will only run the given provisioners when bringing up the machine
Requires the Cake.Vagrant addin
WithProvisioners(string[]) VagrantUpSettings
This will only run the given provisioners when bringing up the machine
Requires the Cake.Vagrant addin