GuideReference
TrainingSupportCommunity
Guide

application_​load_​balancer


Enables the Application Load Balancer Cloudlet, which automates load balancing based on configurable criteria. To configure this behavior, use either the Cloudlets Policy Manager or the Cloudlets API to set up a policy.

OptionTypeDescriptionRequires
enabledboolean

Activates the Application Load Balancer Cloudlet.

{"displayType":"boolean","tag":"input","type":"checkbox"}
cloudlet_​policyobject

Identifies the Cloudlet policy.

{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"enabled","op":"eq","value":true}}
cloudlet_​policy.idnumber

Identifies the Cloudlet.

cloudlet_​policy.namestring

The Cloudlet's descriptive name.

labelstring

A label to distinguish this Application Load Balancer policy from any others within the same property.

{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
NONE

Dynamically reassigns different load-balanced origins for each request.

NEVER

Preserves the cookie indefinitely.

ON_​BROWSER_​CLOSE

Limit the cookie duration to browser sessions.

FIXED_​DATE

Specify a specific time for when the cookie expires.

DURATION

Specify a delay for when the cookie expires.

ORIGIN_​SESSION

Limit the cookie duration to when the ORIGIN_​SESSION terminates. (After the cookie expires, the cookie type re-evaluates.)

stickiness_​expiration_​datestring (epoch timestamp)

Specifies when the cookie expires.

stickiness_​cookie_​type is FIXED_​DATE
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"stickinessCookieType","op":"eq","value":"FIXED_DATE"}]}}
stickiness_​durationstring (duration)

Sets how long it is before the cookie expires.

stickiness_​cookie_​type is DURATION
{"displayType":"string","tag":"input","type":"text"}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"stickinessCookieType","op":"eq","value":"DURATION"}]}}
stickiness_​refreshboolean

Extends the duration of the cookie with each new request. When enabled, the DURATION thus specifies the latency between requests that would cause the cookie to expire.

stickiness_​cookie_​type is DURATION
{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"stickinessCookieType","op":"eq","value":"DURATION"}]}}
all_​down_​net_​storageobject

Specifies a Net​Storage account for a static maintenance page as a fallback when no origins are available.

{"displayType":"object","tag":"input","todo":true}
{"if":{"attribute":"enabled","op":"eq","value":true}}
all_​down_​net_​storage.cp​Codeinteger

Identifies a CP code assigned to this storage group.

all_​down_​net_​storage.download​Domain​Namestring

Domain name from which content can be downloaded.

all_​down_​net_​storage.g2o​Tokenstring

Signature Header Authentication key.

all_​down_​net_​storage.idinteger

Unique identifier for the storage group.

all_​down_​net_​storage.namestring

Name of the storage group.

all_​down_​net_​storage​Filestring

Specifies the fallback maintenance page's filename, expressed as a full path from the root of the Net​Storage server.

{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
all_​down_​status_​codestring

Specifies the HTTP response code when all load-balancing origins are unavailable.

{"displayType":"string","tag":"input","type":"text"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
failover_​status_​codesstring array

Specifies a set of HTTP status codes that signal a failure on the origin, in which case the cookie that binds the client to that origin is invalidated and the client is rerouted to another available origin.

{"displayType":"string array","tag":"input","todo":true}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true}]}}
failover_​modeenum

Determines what to do if an origin fails.

{"displayType":"enum","options":["AUTOMATIC","MANUAL","DISABLED"],"tag":"select"}
{"if":{"attribute":"enabled","op":"eq","value":true}}
AUTOMATIC

Automatically determines which origin in the policy to try next.

MANUAL

You define a sequence of failover origins. (If failover runs out of origins, requests are sent to Net​Storage.)

DISABLED

Turns off failover, but maintains origin stickiness even when the origin goes down.

failover_​origin_​mapobject array

Specifies a fixed set of failover mapping rules.

failover_​mode is MANUAL
{"displayType":"object array","tag":"input","todo":true}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"failoverMode","op":"eq","value":"MANUAL"}]}}
failover_​origin_​map[].from_​origin_​idstring

Specifies the origin whose failure triggers the mapping rule.

{"displayType":"string","tag":"input","type":"text"}
failover_​origin_​map[].to_​origin_​idsstring array

Requests stuck to the from_​origin_​id origin retry for each alternate origin to_​origin_​ids, until one succeeds.

{"displayType":"string array","tag":"input","todo":true}
failover_​attempts_​thresholdnumber

Sets the number of failed requests that would trigger the failover process.

failover_​mode is either: MANUAL, AUTOMATIC
{"displayType":"number","tag":"input","type":"number"}
{"if":{"op":"and","params":[{"attribute":"enabled","op":"eq","value":true},{"attribute":"failoverMode","op":"in","value":["MANUAL","AUTOMATIC"]}]}}
allow_​cache_​prefreshboolean

Allows the cache to prefresh. Only appropriate if all origins serve the same content for the same URL.

{"displayType":"boolean","tag":"input","type":"checkbox"}
{"if":{"attribute":"enabled","op":"eq","value":true}}

Did this page help you?