ICMP Responses Based on a Load Balancer's Backend Set Health

Use ICMP to monitor a load balancer's backend set health.

ICMP is used to monitor infrastructure resources in a network, such as routers, switches, and compute hosts. ICMP-based monitoring tests network reachability and detects liveness at the infrastructure level without including higher-layer application factors. By default, the load balancer responds to ICMP Echo Requests independently of backend health.

You can enable ICMP monitoring of the backend sets when you create a load balancer, or update an existing load balancer to use it.

ICMP ping response uses these response rules:

  • If the backend set has at least one healthy backend server (one that's not drained and isn't set to offline), the load balancer responds to ping requests.
  • If the backend set has zero healthy backend servers, the load balancer doesn't respond to ping requests.
Note

You can only use ICMP monitoring for a single backend set in a load balancer.

Configuring ICMP Monitoring When Creating the Load Balancer

You can enable ICMP ping response when you're creating the load balancer. ICMP monitoring is an option in the Choose backends configuration. For more information, see Creating a Load Balancer.

Configuring ICMP Monitoring for an Existing Load Balancer

You can enable ICMP ping response on an existing load balancer.
  1. Go to the details page of the load balancer.
    For more information, see Getting a Load Balancer's Details.
  2. Find the ICMP backend set name entry under Load balancer information and select Edit.
    The Edit ICMP backend set name panel opens.
  3. If ICMP ping response isn't enabled, turn on the switch.
    A list containing all the eligible backend sets appears.
  4. Select the name of the backend set you want from the list.
  5. Select Save changes.
The Edit ICMP backend set name panel closes. ICMP ping response for this backend set is now enabled. The backend set you selected for ICMP ping response now appears as the value for the ICMP backend set name entry.

Using the CLI

  • Only one backend set name is supported at a time.
  • The backend set must exist and be reachable through at least one listener's effective traffic path (includes a listener's default backend set, path route set, or routing policy).
  • [] explicitly clears the configuration and returns the behavior to VIP.

Enabling ICMP-Based Monitoring

To enable ICMP-based monitoring when creating a load balancer, use the oci lb load-balancer create command and include the --icmp-backend-set-names parameter and the backend set name in JSON. For example:

oci lb load-balancer create ... --icmp-backend-set-names '["myBackendSet"]'

For more information, see Creating a Load Balancer.

Changing the Backend Set

To change the backend set being used, use the oci lb load-balancer update-icmp-config command and include the new backend set's name with the --icmp-backend-set-names option. For example:

oci lb load-balancer update-icmp-config ... --icmp-backend-set-names '["myUpdatedBackendSet"]'

Viewing ICMP-Based Monitoring Details

To see ICMP monitoring in the load balancer's details, run oci lb load-balancer get as described in Getting a Load Balancer's Details. The output contains the following information related to ICMP monitoring:

{"icmp-response-based-on":"BACKEND_SET" ,"icmp-backend-set-names":["myBackendSet"]}

For VIP behavior, you see the following:

{"icmp-response-based-on":"VIP"}

Disabling ICMP-Based Monitoring

To disable ICMP monitoring in a load balancer, use the oci lb load-balancer update-icmp-config command and include the value '[]'. For example:

oci lb load-balancer update-icmp-config ... --icmp-backend-set-names '[]'

Using the API

  • Only one backend set name is supported at a time.
  • The backend set must exist and be reachable through at least one listener's effective traffic path.
  • [] explicitly clears the configuration and returns the behavior to VIP.

Enabling ICMP-Based Monitoring

Run the CreateLoadBalancer operation to create the load balancer. Include the icmpBackendSetNames parameter and the backend set name when creating a load balancer to use ICMP-based monitoring. For example:

{
  "icmpBackendSetNames": ["myBackendSet"]
}

Changing the Backend Set

Run the icmpConfig operation to update a backend set. Include the icmpBackendSetNames parameter. For example:

{
  "icmpBackendSetNames": ["myUpdatedBackendSet"]
}

Disabling ICMP-Based Monitoring

To disable ICMP monitoring in a load balancer, set icmpBackendSetNames to an empty array ([]). For example:
{
  "icmpBackendSetNames": []
}