VagrantBoxRunner Class

Summary

Wrapper around the vagrant box subcommands
Assembly
Cake.Vagrant.dll
Namespace
Cake.Vagrant.Commands
Base Types
graph BT Type-->Base0["VagrantCommandRunner"] click Base0 "/api/Cake.Vagrant.Commands/VagrantCommandRunner" Base0-->Base1["Object"] Type["VagrantBoxRunner"] class Type type-node

Syntax

public class VagrantBoxRunner : VagrantCommandRunner

Properties

Name Value Summary
Log ICakeLog
Logging output
Inherited from VagrantCommandRunner
Runner Action<VagrantSettings, ProcessArgumentBuilder>
Action to trigger invocation of the CLI
Inherited from VagrantCommandRunner
Settings VagrantSettings
Settings for invocation of the Vagrant CLI
Inherited from VagrantCommandRunner

Methods

Name Value Summary
Add(string, Action<VagrantBoxAddSettings>) void
This adds a box with the given address to Vagrant.
List() void
Lists all installed boxes
Outdated(bool) void
This command tells you whether or not the box you are using in your current Vagrant environment is outdated.
Remove(string, Action<VagrantBoxRemoveSettings>) void
This command removes a box from Vagrant that matches the given name.
Repackage(string, string, string) void
This command repackages the given box and puts it in the current directory so you can redistribute it.
Update(Action<VagrantBoxUpdateSettings>) void
This command updates the box for the current Vagrant environment if there are updates available

Extension Methods

Name Value Summary
Dump<VagrantBoxRunner>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<VagrantBoxRunner>(VagrantBoxRunner[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<VagrantBoxRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<VagrantBoxRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<VagrantBoxRunner>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<VagrantBoxRunner>(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
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin