Search

Oracle Cloud Infrastructure Documentation

Help us improve this site Try Free Tier

Infrastructure Services Network Load Balancer Backend Sets

All Pages

Creating a Network Load Balancer Backend

Set
Describes how to create a backend set for a network load balancer.

Using the Console

1. Open the navigation menu, click
Networking, and then click Load
Balancers.

2. Select the Compartment from the list.

All load balancers and network load balancers in that compartment are listed
in tabular form.

3. (optional) Select a State from the list to limit the

load balancers displayed to that state.

4. (optional) Uncheck Load Balancer under

Type to only display network load balancers.

5. Select the network load balancer for which you want to create a backend
set.

The Network Load Balancer Details dialog box appears.

6. Click Backend Sets under

Resources.

The Backend Sets list appears. All backend sets are

listed in tabular form.

7. Click Create Backend Set.

The Create backend set dialog box appears.

8. Enter the following:

Name: Required. Specify a friendly name
for the backend set. It must be unique within the
load balancer,
and it cannot be changed.
Valid backend set names include only alphanumeric characters,
dashes, and underscores.
Backend set names cannot contain
spaces. Avoid entering confidential information.

IP Protocol Version: The load balancer

listener and backend set must use the same IP
protocol version.

Preserve Source ID: Optional. Check to

preserve the original source and destination header
(IP
addresses and ports) of each incoming packet all the way to the
backend server.

Health Check:
Required. Specify the test parameters to confirm the health of
backend
servers.

Protocol: Required. Specify the

protocol:

HTTP

HTTPS

TCP

UDP

Configure your health check protocol to match your

application or service. See Health
Check Policies for Network Load Balancers. The Network Load Balancer service
supports HTTP, HTTPS, TCP, and UDP as
protocols for the backend health check.

When using TCP as the protocol, you can optionally

provide the request data and the
response data.

When using UDP as the protocol, the request and response

data are required.

For both TCP and UDP options, the provided data must be
base64 encoded. Use any
base64 encoding tool to convert
your plain text strings to based64 encoded strings,
and
use the encoded strings for the health check
configuration.

For example, the following plain text string:

this is the request data for my NLB backend health check

is encoded as:

dGhpcyBpcyB0aGUgcmVxdWVzdCBkYXRhIGZvciBteSBOTEIgYmFja2VuZCBoZWFsdGggY2hlY2s

The encoded string is what undergoes the health check

configuration.

The supported maximum length of the string before base64

encoding is 1024 bytes. If
the string exceeds the limit,
the configuration call fails with an HTTP status code
400.

Port: Optional. Specify the

backend server port against which to run the health
check.
 Tip

You can enter the value '0' to have the health check
use the backend server's
traffic port.

Interval in MS: Optional. Specify

how frequently to run the health check, in
milliseconds.
The default is 10000 (10 seconds).

Timeout in MS: Optional. Specify

the maximum time in milliseconds to wait for a reply
to
a health check. A health check is successful only if a
reply returns within this timeout
period. The default is
3000 (3 seconds).

Number of retries: Optional.

Specify the number of retries to attempt before a
backend server is considered "unhealthy." This number
also applies when recovering a
server to the
"healthy" state. The default is 3.

Status Code: (HTTP and HTTPS only)

Optional. Specify the status code a healthy
backend
server must return.

URL Path (URI): (HTTP and HTTPS

only) Required. Specify a URL endpoint against
which to
run the health check.

Response Body Regex: (HTTP and

HTTPS only) Optional. Provide a regular expression
for
parsing the response body from the backend server.

Request Data: (TCP and UDP only)

Required for UDP, optional for TCP.

Response Data: (TCP and UDP only)

Required for UDP, optional for TCP.

Show Advanced Options: Click this link to

access more options. Select the tab for the
corresponding
functionality:

Load Balancing Policy: Select one

of the following load balancing policies:

5-Tuple Hash: This policy

distributes incoming traffic based on 5-Tuple
(source IP
and port, destination IP and port,
protocol) Hash.

3-Tuple Hash: This policy

ensures that requests from a particular client are
always directed to the same backend server based
on 3-Tuple (source IP,
destination IP, protocol)
Hash.

2-Tuple Hash: This policy

routes incoming traffic to the same backend server
based on 2-Tuple (Source/Destination) Hash.

9. Click Create Backend Set.

The backend set you created appears in the Backend Set

list.
Using the CLI
Use the oci nlb backend-set create command and
required parameters to create a network load balancer
backend set:

Command Copy _ Try It

oci nlb backend-set create --name name --network-load-balancer-id network_load_balancer_id --hea

For a complete list of flags and variable options for CLI commands, see the Command Line Reference.

Using the API

Run the CreateBackendSet
operation to create a backend set for a network load balancer.

Was this article helpful?

Copyright © 2022, Oracle and/or its affiliates. About Oracle Contact Us Legal Notices Terms of Use & Privacy
Document Conventions Cookie Preferences