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
-
- I
Vagrant Command Settings
- I
- 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 |
---|---|
Vagrant |
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 |
Gets or sets a value indicating whether to clean any existing temporary files before downloading
|
Force | Nullable |
When present, the box will be downloaded and overwrite any existing box with this name.
|
Insecure | Nullable |
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 |
Gets the command arguments corresponding to the specified settings
|
Extension Methods
Name | Value | Summary |
---|---|---|
AllowInsecure |
Vagrant |
Enables unverified/untrusted SSL certificates when using HTTPS URLs.
Requires the Cake.Vagrant addin
|
CleanFirst |
Vagrant |
Enables cleaning any temporary or partial download files first.
Requires the Cake.Vagrant addin
|
ConstrainVersion |
Vagrant |
Sets the version or version constraint to use when downloading the box
Requires the Cake.Vagrant addin
|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
Force |
Vagrant |
Forces downloading and overwriting any box with the same name
Requires the Cake.Vagrant addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
From StringExtensions
Requires the Cake.Issues addin
|
Use |
Vagrant |
Sets the
CACertificate property for the CA certificate used to verify the peer
Requires the Cake.Vagrant addin
|
Use |
Vagrant |
Sets the
CAPath property for the CA used to verify the peer
Requires the Cake.Vagrant addin
|
UseProvider |
Vagrant |
Requests a specific provider as per the
Provider property
Requires the Cake.Vagrant addin
|
With |
Vagrant |
Sets the
CertificatePath property for a client certificate to use when
downloading the box, if necessary.
Requires the Cake.Vagrant addin
|