VagrantPackageSettings Class

Summary

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

Syntax

public class VagrantPackageSettings : IVagrantCommandSettings

Constructors

Properties

Name Value Summary
AdditionalFilePaths IEnumerable<string>
Additional files to be packaged with the box.
BaseImageName string
Name or UUID of a VirtualBox VM to package
OutputFile string
File name for the output package. Defaults to package.box
VagrantFile string
Packages a Vagrantfile with the box, that is loaded as part of the Vagrantfile load order when the resulting box is used.

Methods

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

Extension Methods

Name Value Summary
Dump<VagrantPackageSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IncludeInPackage(FilePath[]) VagrantPackageSettings
Adds extra files to be included with the box
Requires the Cake.Vagrant addin
IncludeVagrantFile(FilePath) VagrantPackageSettings
Includes an additional Vagrantfile with the packaged box
Requires the Cake.Vagrant addin
IsIn<VagrantPackageSettings>(VagrantPackageSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<VagrantPackageSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<VagrantPackageSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
OutputToFile(FilePath) VagrantPackageSettings
Sets the filename for the package output
Requires the Cake.Vagrant addin
ThrowIfNull<VagrantPackageSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<VagrantPackageSettings>(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
UseBaseImage(string) VagrantPackageSettings
Sets the base image to use when packaging the machine
Requires the Cake.Vagrant addin