VagrantInitSettings Class

Summary

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

Syntax

public class VagrantInitSettings : IVagrantCommandSettings

Constructors

Name Summary
VagrantInitSettings()

Properties

Name Value Summary
Force Nullable<bool>
Gets or sets a value indicating whether to force initialization, even if an existing Vagrantfile is found
Minimal Nullable<bool>
This enables the creation of a more minimal Vagrantfile that does not contain the instructional comments the normal Vagrantfile contains
OutputFile string
Gets or sets the file to output the Vagrantfile to
VersionConstraint string
The box version or box version constraint to add to the Vagrantfile

Methods

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

Extension Methods

Name Value Summary
ConstrainVersion(string) VagrantInitSettings
Sets the box version or box version constraint to add to the Vagrantfile
Requires the Cake.Vagrant addin
CreateMinimal() VagrantInitSettings
Enables creation of a more minimal Vagrantfile without instructional comments
Requires the Cake.Vagrant addin
Dump<VagrantInitSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
Force(bool) VagrantInitSettings
Enables overwriting any existing Vagrantfile
Requires the Cake.Vagrant addin
IsIn<VagrantInitSettings>(VagrantInitSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<VagrantInitSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<VagrantInitSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
OutputToFile(FilePath) VagrantInitSettings
Sets the FilePath to output the new Vagrantfile to
Requires the Cake.Vagrant addin
ThrowIfNull<VagrantInitSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<VagrantInitSettings>(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