Editing a Load Balancer Backend Server

Update a backend server for a load balancer.

    1. Open the navigation menu, click Networking, and then click Load balancers. Click Load balancer. The Load balancers page appears.

    2. Select the Compartment from the list. All load balancers in that compartment are listed in tabular form.

    3. Select a State from the list to limit the load balancers displayed to that state.

    4. Select the load balancer containing the backend server that you want to edit. Its Details page appears.

    5. Click Backend sets under Resources. The Backend sets list appears. All backend sets are listed in tabular form.

    6. Click the backend set whose backend server you want to edit. Its Details page appears.

    7. Click Backends under Resources. The Backends list appears. All backend servers are listed in tabular form.

    8. Select (check) the row corresponding to the backend server you want to edit.

    9. Choose an action from the Actions button list. The available actions include:

      • Edit: Opens a single dialog box in which you can edit the port, weight, drain, offline, and backup settings.

      • Edit port: Opens a dialog box in which you can change the application port setting.

      • Edit weight: Opens a dialog box in which you can change the load balancing weight.

      • Edit drain state: Opens a dialog box in which you can change the drain state. If you set the server's drain status to true, the load balancer stops forwarding new TCP connections and new non-sticky HTTP requests to this backend server. This setting allows an administrator to take the server out of rotation for maintenance purposes.

      • Edit offline state: Opens a dialog box in which you can change the offline status. If you set the server's offline status to true, the load balance forwards no ingress traffic to this backend server.

      • Edit backup state: Opens a dialog box in which you can change the backup status. If you set the server's backup status to true, the load balancer forwards ingress traffic to this backend server only when all other backend servers not marked as backup fail the health check policy. This configuration is useful for handling disaster recovery scenarios. Backend servers marked as Backup are not compatible with a load balancer that uses the IP Hash policy.

      • Delete: Removes the server from the backend set.

      You can select multiple servers to apply the same action to each one.

    10. Click Save changes.

  • Use the oci lb backend get command and required parameters to edit a load balancer's backend server:

    oci lb backend update --backend-name backend_name --backend-set-name backend_set_name --load-balancer-id load_balancer_id --backup [true|false] --drain [true|false] --offline [true|false] --weight weight [OPTIONS]

    The backup parameter indicates whether (true) or not (false) the load balancer treats this server as a backup unit. If the value is 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. You cannot add a backend server marked as backup to a backend set that uses the IP Hash policy.

    The drain parameter indicates whether (true) or not (false) the load balancer drains this backend server. If the value is true, the backend server receives no new incoming traffic.

    The weight parameter indicates 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 three times the number of new connections as a server weighted '1.' For more information on load balancing policies, see How Load Balancing Policies Work.

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Run the UpdateBackend operation to get the details of a backend contained within a backend set for a load balancer.