Class CreateBackendSetDetails
The configuration details for creating a backend set in a network load balancer.
For more information about backend set configuration, see
Backend Sets for Network Load Balancers.
Caution: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Inherited Members
Namespace: Oci.NetworkloadbalancerService.Models
Assembly: OCI.DotNetSDK.Networkloadbalancer.dll
Syntax
public class CreateBackendSetDetails
Properties
AreOperationallyActiveBackendsPreferred
Declaration
[JsonProperty(PropertyName = "areOperationallyActiveBackendsPreferred")]
public bool? AreOperationallyActiveBackendsPreferred { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend. The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. |
Backends
Declaration
[JsonProperty(PropertyName = "backends")]
public List<BackendDetails> Backends { get; set; }
Property Value
| Type | Description |
|---|---|
| List<BackendDetails> | An array of backends to be associated with the backend set. |
HealthChecker
Declaration
[Required(ErrorMessage = "HealthChecker is required.")]
[JsonProperty(PropertyName = "healthChecker")]
public HealthCheckerDetails HealthChecker { get; set; }
Property Value
| Type | Description |
|---|---|
| HealthCheckerDetails |
Remarks
Required
IpVersion
Declaration
[JsonProperty(PropertyName = "ipVersion")]
[JsonConverter(typeof(StringEnumConverter))]
public IpVersion? IpVersion { get; set; }
Property Value
| Type | Description |
|---|---|
| IpVersion? | IP version associated with the backend set. |
IsFailOpen
Declaration
[JsonProperty(PropertyName = "isFailOpen")]
public bool? IsFailOpen { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy. The value is false by default. |
IsInstantFailoverEnabled
Declaration
[JsonProperty(PropertyName = "isInstantFailoverEnabled")]
public bool? IsInstantFailoverEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy. |
IsInstantFailoverTcpResetEnabled
Declaration
[JsonProperty(PropertyName = "isInstantFailoverTcpResetEnabled")]
public bool? IsInstantFailoverTcpResetEnabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | This only applies when using instant failover. If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. If disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled. |
IsPreserveSource
Declaration
[JsonProperty(PropertyName = "isPreserveSource")]
public bool? IsPreserveSource { get; set; }
Property Value
| Type | Description |
|---|---|
| bool? | If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends. Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default. |
Name
Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A user-friendly name for the backend set that must be unique and cannot be changed.
|
Remarks
Required
Policy
Declaration
[Required(ErrorMessage = "Policy is required.")]
[JsonProperty(PropertyName = "policy")]
[JsonConverter(typeof(StringEnumConverter))]
public NetworkLoadBalancingPolicy? Policy { get; set; }
Property Value
| Type | Description |
|---|---|
| NetworkLoadBalancingPolicy? | The network load balancer policy for the backend set.
|
Remarks
Required