Class BackendSummary

The configuration of a backend server that is a member of a network load balancer backend set. For more information, see Backend Servers for Network Load Balancers.

Inheritance
object
BackendSummary
Inherited Members
Namespace: Oci.NetworkloadbalancerService.Models
Assembly: OCI.DotNetSDK.Networkloadbalancer.dll
Syntax
public class BackendSummary

Properties

IpAddress

Declaration
[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

IsBackup

Declaration
[JsonProperty(PropertyName = "isBackup")]
public bool? IsBackup { get; set; }
Property Value
Type Description
bool?

Whether the network load balancer should treat this server as a backup unit. If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy.
Example: false

IsDrain

Declaration
[JsonProperty(PropertyName = "isDrain")]
public bool? IsDrain { get; set; }
Property Value
Type Description
bool?

Whether the network load balancer should drain this server. Servers marked "isDrain" stop receiving new connections but will continue to receive traffic on existing connections until the connection is terminated or times out.
Example: false

IsOffline

Declaration
[JsonProperty(PropertyName = "isOffline")]
public bool? IsOffline { get; set; }
Property Value
Type Description
bool?

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

Name

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

A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set.
Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<unique_ID>:443 or 10.0.0.3:0

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

TargetId

Declaration
[JsonProperty(PropertyName = "targetId")]
public string TargetId { get; set; }
Property Value
Type Description
string

The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<unique_ID>

Weight

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

The network 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 three times the number of new connections as a server weighted '1'. For more information about network load balancing policies, see Network Load Balancer Policies.
Example: 3