Adding or Deleting Listeners

You can add one or more listeners to a load balancer and remove them at any time if you no longer need them. Adding a listener to a load balancer enables it to listen to inbound flows on a specified port and in a specified protocol, and to send the traffic load to back-end instances using a specified port and protocol.

As you can configure only one health checks type per load balancer specifying the back-end instances port and protocol to check, we strongly recommend to create one load balancer per service to avoid any undetected failure, meaning that your listeners should all send the traffic load to back-end instances using the same port and protocol.

You cannot modify an existing listener. The only way to modify the port and protocol on the load balancer’s side or on the back-end instances' one is to add a listener with the corresponding configuration, and remove the former one if needed.

Adding or Deleting Listeners Using Cockpit v1

Adding a Listener to a Load Balancer

  1. Click Services > Load Balancers.

  2. Click the load balancer you want to add a listener to.
    The load balancer is selected and its details appear.

  3. Click Listeners.
    A panel with information about the listeners of the load balancer appears.

  4. Click Create Listener .

    The CREATE LISTENER dialog box appears.

  5. Configure your listener:

    1. From the Protocol list, select the routing protocol.

    2. In the Load Balancer Port field, type the port on which the load balancer is listening (between 1 and 65535 both included).

    3. In the Instance Port field, type the port on which back-end instances are listening (between 1 and 65535 both included).

    4. (optional) From the Certificate list, select the server certificate you want to use to create a load balancer with SSL termination.

      For more information about how to configure your listener when using SSL certificates, see Configuring a Load Balancer for SSL Termination or SSL Passthrough.

  6. Click Create to validate.
    The listener is added to your load balancer and appears in the panel.

Deleting a Listener from a Load Balancer

  1. Click Load Balancers.

  2. Click the load balancer you want to remove a listener from.
    The load balancer is selected and its details appear.

  3. Click Listeners.
    A panel with information about the listeners of the load balancer appears.

  4. Click the listener you want to remove from the load balancer.

    Multiselection is available.

    The listener is selected.

  5. Click Delete Listener .
    A confirmation dialog box appears.

  6. Click Delete to validate.
    The listener is removed from the load balancer and no longer appears in the panel.

Adding or Deleting Listeners Using OSC CLI

See the CreateLoadBalancerListeners or DeleteLoadBalancerListeners command samples in the documentation of the OUTSCALE API.

Adding or Deleting Listeners Using AWS CLI

Adding a Listener to a Load Balancer

To add one or more listeners to a load balancer, use the create-load-balancer-listeners command following this syntax:

Request sample
$ aws elb create-load-balancer-listeners \
    --profile YOUR_PROFILE \
     --load-balancer-name my-load-balancer \
    --listeners Protocol=TCP,LoadBalancerPort=62,InstanceProtocol=TCP,InstancePort=58 \
    --endpoint https://lbu.eu-west-2.outscale.com

This command contains the following attributes that you need to specify:

  • (optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.

  • load-balancer-name: The name of the load balancer.

  • listeners: One or more listeners for the load balancer. This attribute requires the following elements for each listener:

    To add several listeners, separate each of them with a space.

    • Protocol: The routing protocol of the load balancer (HTTP, HTTPS, TCP ou SSL).

    • LoadBalancerPort: The port on which the load balancer is listening (between 1 and 65535, both included).

    • InstancePort: The port on which the back-end instances are listening (between 1 and 65535, both included).

    • (optional) SSLCertificateId: The OUTSCALE Resource Name (ORN) of an SSL certificate. For more information, see Getting Information About a Server Certificate.

      An SSL certificate is required only if the load balancer protocol is HTTPS or SSL.

      For more information about how to configure your listener when using SSL certificates, see Configuring a Load Balancer for SSL Termination or SSL Passthrough.

  • endpoint: The endpoint corresponding to the Region you want to send the request to.

The specified listeners are added to the specified load balancer.

Deleting a Listener from a Load Balancer

To remove one or more listeners from a load balancer, use the delete-load-balancer-listeners command following this syntax:

Request sample
$ aws elb delete-load-balancer-listeners \
    --profile YOUR_PROFILE \
    --load-balancer-name LOAD_BALANCER-NAME \
    --load-balancer-ports 80 44 \
    --endpoint https://lbu.eu-west-2.outscale.com

This command contains the following attributes that you need to specify:

  • (optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.

  • load-balancer-name: The name of the load balancer.

  • load-balancer-ports: One or more load balancer ports corresponding to the listeners you want to remove.

    To remove several listeners from the load balancer, separate them with a space.

  • endpoint: The endpoint corresponding to the Region you want to send the request to.

The specified listeners are removed from the specified load balancer.

Related Pages

Corresponding API Methods

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.