WebFarmManager Class

Summary

Class for managing IIS WebFarms
Assembly
Cake.IIS.dll
Namespace
Cake.IIS
Base Types
graph BT Type-->Base0["BaseManager"] click Base0 "/api/Cake.IIS/BaseManager" Base0-->Base1["Object"] Type["WebFarmManager"] class Type type-node

Syntax

public class WebFarmManager : BaseManager

Constructors

Name Summary
WebFarmManager(ICakeEnvironment, ICakeLog) Initializes a new instance of the WebFarmManager class.

Fields

Name Constant Value Summary
_Environment
Cake environment
Inherited from BaseManager
_Log
Cake log
Inherited from BaseManager
_Server
IIS server manager
Inherited from BaseManager

Methods

Name Value Summary
AddServer(string, string) bool
Adds a server to the WebFarm
AddServer(string, WebFarmServerSettings) bool
Adds a server to the WebFarm
BringServerOnline(string, string) void
Marks a server as Online (enabled)
Connect(string) ServerManager
Creates a IIS ServerManager
Inherited from BaseManager
static
Create(WebFarmSettings) void
Creates a WebFarm
Delete(string) bool
Delete an WebFarm
Exists(string) bool
Checks if a WebFarm exists
GetPhysicalDirectory(IDirectorySettings) string
Gets the physical directory from the working directory
Inherited from BaseManager
GetServerIsHealthy(string, string) bool
Checks if a server is healthy
GetServerState(string, string) string
Gets the state of a server in a WebFarm
RemoveServer(string, string) bool
Removes a server to the WebFarm
ServerExists(string, string) bool
Checks if a server belongs to the WebFarm
SetServer() void
Set the IIS ServerManager
Inherited from BaseManager
SetServer(ServerManager) void
Set the IIS ServerManager
Inherited from BaseManager
SetServer(string) void
Set the IIS ServerManager
Inherited from BaseManager
SetServerAvailable(string, string) void
Marks a server as available
SetServerHealthy(string, string) void
Marks a server as healthy
SetServerUnavailableGracefully(string, string) void
Marks a server as unavailable gracefully
SetServerUnavailableImmediately(string, string) void
Marks a server as unavailable immediately
SetServerUnhealthy(string, string) void
Marks a server as unhealthy
TakeServerOffline(string, string) void
Marks a server as Offline (disabled)
Using(ICakeEnvironment, ICakeLog, ServerManager) WebFarmManager
Creates a new instance of the WebFarmManager class.
static

Extension Methods

Name Value Summary
Dump<WebFarmManager>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<WebFarmManager>(WebFarmManager[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<WebFarmManager>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<WebFarmManager>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<WebFarmManager>(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
ThrowIfNull<WebFarmManager>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin