WebFarmAliases Class

Summary

Contains aliases for working with IIS web farms.
Assembly
Cake.IIS.dll
Namespace
Cake.IIS
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["WebFarmAliases"] class Type type-node

Syntax

public static class WebFarmAliases

Attributes

Type Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Methods

Name Value Summary
AddServer(ICakeContext, string, string, string) bool
Add a server to a web farm on remote IIS.
static
AddServer(ICakeContext, string, string, WebFarmServerSettings) bool
Add a server to a web farm on remote IIS.
static
AddServer(ICakeContext, string, string) bool
Add a server to a web farm on local IIS.
static
AddServer(ICakeContext, string, WebFarmServerSettings) bool
Add a server to a web farm on local IIS.
static
BringServerOnline(ICakeContext, string, string, string) void
Sets server to Online in a web farm on remote IIS.
static
BringServerOnline(ICakeContext, string, string) void
Sets server to Online in a web farm on local IIS.
static
CreateWebFarm(ICakeContext, string, WebFarmSettings) void
Creates a web farm on remote IIS.
static
CreateWebFarm(ICakeContext, WebFarmSettings) void
Creates a web farm on local IIS.
static
DeleteWebFarm(ICakeContext, string, string) bool
Deletes a web farm from remote IIS.
static
DeleteWebFarm(ICakeContext, string) bool
Deletes a web farm from local IIS.
static
GetServerIsHealthy(ICakeContext, string, string, string) bool
Gets if server is healthy in a web farm on remote IIS.
static
GetServerIsHealthy(ICakeContext, string, string) bool
Gets if server is healthy in a web farm on local IIS.
static
GetServerState(ICakeContext, string, string, string) string
Gets server state in a web farm on remote IIS.
static
GetServerState(ICakeContext, string, string) string
Gets server state in a web farm on local IIS.
static
RemoveServer(ICakeContext, string, string, string) bool
Remove a server from a web farm on remote IIS.
static
RemoveServer(ICakeContext, string, string) bool
Remove a server to from web farm on local IIS.
static
ServerExists(ICakeContext, string, string, string) bool
Checks if server exists in a web farm on remote IIS.
static
ServerExists(ICakeContext, string, string) bool
Checks if server exists in a web farm on local IIS.
static
SetServerAvailable(ICakeContext, string, string, string) void
Sets server to available in a web farm on remote IIS.
static
SetServerAvailable(ICakeContext, string, string) void
Sets server to available in a web farm on local IIS.
static
SetServerHealthy(ICakeContext, string, string, string) void
Sets server to healthy in a web farm on remote IIS.
static
SetServerHealthy(ICakeContext, string, string) void
Sets server to healthy in a web farm on local IIS.
static
SetServerUnavailable(ICakeContext, string, string, string) void
Sets server to unavailable immediately in a web farm on remote IIS.
static
SetServerUnavailable(ICakeContext, string, string) void
Sets server to unavailable immediately in a web farm on local IIS.
static
SetServerUnavailableGracefully(ICakeContext, string, string, string) void
Sets server to unavailable gracefully in a web farm on remote IIS.
static
SetServerUnavailableGracefully(ICakeContext, string, string) void
Sets server to unavailable gracefully in a web farm on local IIS.
static
SetServerUnavailableImmediately(ICakeContext, string, string, string) void
Sets server to unavailable immediately in a web farm on remote IIS.
static
SetServerUnavailableImmediately(ICakeContext, string, string) void
Sets server to unavailable immediately in a web farm on local IIS.
static
SetServerUnhealthy(ICakeContext, string, string, string) void
Sets server to unhealthy in a web farm on remote IIS.
static
SetServerUnhealthy(ICakeContext, string, string) void
Sets server to unhealthy in a web farm on local IIS.
static
TakeServerOffline(ICakeContext, string, string, string) void
Sets server to Offline in a web farm on remote IIS.
static
TakeServerOffline(ICakeContext, string, string) void
Sets server to Offline in a web farm on local IIS.
static
WebFarmExists(ICakeContext, string, string) bool
Checks if web farm exists on remote IIS.
static
WebFarmExists(ICakeContext, string) bool
Checks if web farm exists on local IIS.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin