Class Backend

The configuration of a backend server that is a member of a load balancer backend set. For more information, see Managing Backend Servers.

Inheritance
object
Backend
Inherited Members
Namespace: Oci.LoadbalancerService.Models
Assembly: OCI.DotNetSDK.Loadbalancer.dll
Syntax
public class Backend

Properties

Backup

Declaration
[Required(ErrorMessage = "Backup is required.")]
[JsonProperty(PropertyName = "backup")]
public bool? Backup { get; set; }
Property Value
Type Description
bool?

Whether the load balancer should treat this server as a backup unit. If true, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
Note: You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.
Example: false
Remarks

Required

Drain

Declaration
[Required(ErrorMessage = "Drain is required.")]
[JsonProperty(PropertyName = "drain")]
public bool? Drain { get; set; }
Property Value
Type Description
bool?

Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic.
Example: false
Remarks

Required

IpAddress

Declaration
[Required(ErrorMessage = "IpAddress is required.")]
[JsonProperty(PropertyName = "ipAddress")]
public string IpAddress { get; set; }
Property Value
Type Description
string

The IP address of the backend server.
Example: 10.0.0.3
Remarks

Required

MaxConnections

Declaration
[JsonProperty(PropertyName = "maxConnections")]
public int? MaxConnections { get; set; }
Property Value
Type Description
int?

The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited.
Example: 300

Name

Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

A read-only field showing the IP address and port that uniquely identify this backend server in the backend set.
Example: 10.0.0.3:8080
Remarks

Required

Offline

Declaration
[Required(ErrorMessage = "Offline is required.")]
[JsonProperty(PropertyName = "offline")]
public bool? Offline { get; set; }
Property Value
Type Description
bool?

Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic.
Example: false
Remarks

Required

Port

Declaration
[Required(ErrorMessage = "Port is required.")]
[JsonProperty(PropertyName = "port")]
public int? Port { get; set; }
Property Value
Type Description
int?

The communication port for the backend server.
Example: 8080
Remarks

Required

Weight

Declaration
[Required(ErrorMessage = "Weight is required.")]
[JsonProperty(PropertyName = "weight")]
public int? Weight { get; set; }
Property Value
Type Description
int?

The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work.
Example: 3
Remarks

Required