VagrantBoxAddSettings 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 vagrant box add command

Assembly

Cake.Vagrant.dll

Namespace

Cake.Vagrant.Settings

Interfaces

IVagrantCommandSettings

Base Types

Object

graph BT Type-->Base0["Object"] Type-.->Interface0["IVagrantCommandSettings"] Type["VagrantBoxAddSettings"] class Type type-node

Syntax

public class VagrantBoxAddSettings : IVagrantCommandSettings

Constructors

Name	Summary
VagrantBoxAddSettings()

Properties

Name	Value	Summary
CACertificate	string	The certificate for the CA used to verify the peer. This should be used if the remote end does not use a standard root CA.
CAPath	string	The certificate directory for the CA used to verify the peer. This should be used if the remote end does not use a standard root CA.
CertificatePath	string	A client certificate to use when downloading the box, if necessary.
Clean	Nullable<bool>	Gets or sets a value indicating whether to clean any existing temporary files before downloading
Force	Nullable<bool>	When present, the box will be downloaded and overwrite any existing box with this name.
Insecure	Nullable<bool>	When present, SSL certificates will not be verified if the URL is an HTTPS URL.
Provider	string	If given, Vagrant will verify the box you are adding is for the given provider.
Version	string	The version of the box you want to add.

Methods

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

Extension Methods

Name	Value	Summary
AllowInsecure(bool)	VagrantBoxAddSettings	Enables unverified/untrusted SSL certificates when using HTTPS URLs. From VagrantBoxAddSettingsExtensions Requires the Cake.Vagrant addin
CleanFirst(bool)	VagrantBoxAddSettings	Enables cleaning any temporary or partial download files first. From VagrantBoxAddSettingsExtensions Requires the Cake.Vagrant addin
ConstrainVersion(string)	VagrantBoxAddSettings	Sets the version or version constraint to use when downloading the box From VagrantBoxAddSettingsExtensions Requires the Cake.Vagrant addin
Dump<VagrantBoxAddSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
Force(bool)	VagrantBoxAddSettings	Forces downloading and overwriting any box with the same name From VagrantBoxAddSettingsExtensions Requires the Cake.Vagrant addin
IsIn<VagrantBoxAddSettings>(VagrantBoxAddSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<VagrantBoxAddSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<VagrantBoxAddSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<VagrantBoxAddSettings>(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<VagrantBoxAddSettings>(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
UseCertificateAuthority(FilePath)	VagrantBoxAddSettings	Sets the `CACertificate` property for the CA certificate used to verify the peer From VagrantBoxAddSettingsExtensions Requires the Cake.Vagrant addin
UseCertificateAuthority(IDirectory)	VagrantBoxAddSettings	Sets the `CAPath` property for the CA used to verify the peer From VagrantBoxAddSettingsExtensions Requires the Cake.Vagrant addin
UseProvider(string)	VagrantBoxAddSettings	Requests a specific provider as per the `Provider` property From VagrantBoxAddSettingsExtensions Requires the Cake.Vagrant addin
WithClientCertificate(FilePath)	VagrantBoxAddSettings	Sets the `CertificatePath` property for a client certificate to use when downloading the box, if necessary. From VagrantBoxAddSettingsExtensions Requires the Cake.Vagrant addin