VagrantPackageSettings Class

This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Vagrant.

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

Name	Summary
VagrantPackageSettings()

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. From LoggingExtensions Requires the Cake.Incubator addin
IncludeInPackage(FilePath[])	VagrantPackageSettings	Adds extra files to be included with the box From VagrantPackageSettingsExtensions Requires the Cake.Vagrant addin
IncludeVagrantFile(FilePath)	VagrantPackageSettings	Includes an additional Vagrantfile with the packaged box From VagrantPackageSettingsExtensions Requires the Cake.Vagrant addin
IsIn<VagrantPackageSettings>(VagrantPackageSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<VagrantPackageSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<VagrantPackageSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
OutputToFile(FilePath)	VagrantPackageSettings	Sets the filename for the package output From VagrantPackageSettingsExtensions Requires the Cake.Vagrant addin
ThrowIfNull<VagrantPackageSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<VagrantPackageSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin
UseBaseImage(string)	VagrantPackageSettings	Sets the base image to use when packaging the machine From VagrantPackageSettingsExtensions Requires the Cake.Vagrant addin