PowershellSettings Class

Assembly
Cake.Powershell.dll
Namespace
Cake.Powershell
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["PowershellSettings"] class Type type-node

Syntax

public class PowershellSettings

Constructors

Name Summary
PowershellSettings()

Properties

Name Value Summary
Arguments ProcessArgumentBuilder
AuthenticationMechanism AuthenticationMechanism
ComputerName string
ExceptionOnScriptError bool
FormatOutput bool
LogOutput bool
Modules IList<string>
OutputToAppConsole bool
Password string
Port int
Timeout Nullable<int>
UseDotSourcing bool
Username string
WorkingDirectory DirectoryPath

Extension Methods

Name Value Summary
Dump<PowershellSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<PowershellSettings>(PowershellSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<PowershellSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<PowershellSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
OutputToAppConsole(bool) PowershellSettings
Requires the Cake.Powershell addin
SetFormatOutput(bool) PowershellSettings
Requires the Cake.Powershell addin
SetLogOutput(bool) PowershellSettings
Requires the Cake.Powershell addin
SetTimeout(int) PowershellSettings
Requires the Cake.Powershell addin
ThrowIfNull<PowershellSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<PowershellSettings>(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
UseAuthenticationMechanism(AuthenticationMechanism) PowershellSettings
Requires the Cake.Powershell addin
UseComputerName(string) PowershellSettings
Requires the Cake.Powershell addin
UsePassword(string) PowershellSettings
Requires the Cake.Powershell addin
UsePort(int) PowershellSettings
Requires the Cake.Powershell addin
UseUsername(string) PowershellSettings
Requires the Cake.Powershell addin
UseWorkingDirectory(DirectoryPath) PowershellSettings
Requires the Cake.Powershell addin
WithArguments(Action<ProcessArgumentBuilder>) PowershellSettings
Requires the Cake.Powershell addin
WithDotSourcing() PowershellSettings
Requires the Cake.Powershell addin
WithModule(string) PowershellSettings
Requires the Cake.Powershell addin