VagrantSSHSettings 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 ssh command

Assembly

Cake.Vagrant.dll

Namespace

Cake.Vagrant.Settings

Interfaces

IVagrantCommandSettings

Base Types

Object

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

Syntax

public class VagrantSSHSettings : IVagrantCommandSettings

Constructors

Name	Summary
VagrantSSHSettings()

Properties

Name	Value	Summary
Command	string	The command to run on your machine.
DoNotAuthenticate	Nullable<bool>	OBSOLETE: Setting this will cause unexpected results and may block scripts.
ExtraSSHArguments	string	Extra arguments to provide directly to the SSH command

Methods

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

Extension Methods

Name	Value	Summary
Dump<VagrantSSHSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<VagrantSSHSettings>(VagrantSSHSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<VagrantSSHSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<VagrantSSHSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
RunCommand(string)	VagrantSSHSettings	Sets the command to run in the SSH session From VagrantSSHSettingsExtensions Requires the Cake.Vagrant addin
ThrowIfNull<VagrantSSHSettings>(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<VagrantSSHSettings>(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
WithArguments(string[])	VagrantSSHSettings	Sets any additional arguments to pass directly to the SSH invocation From VagrantSSHSettingsExtensions Requires the Cake.Vagrant addin