Show / Hide Table of Contents

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.

Inheritance
object
CreateBackendSetDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
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. The standby backend takes over the traffic when the active node fails, and continues to serve the traffic even when the old active node is back healthy.

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?

If enabled along with instant failover, the network load balancer will send TCP RST to the clients for the existing connections instead of failing over to a healthy backend. This only applies when using the instant failover. 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.
Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.
Example: example_backend_set

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.
Example: FIVE_TUPLE

Remarks

Required

In this article
Back to top