VagrantBoxAddSettings Class

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

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