Oracle Cloud Infrastructure Documentation

Creating am NLB Listener

On a Roving Edge device, you can create a listener for an existing network load balancer (NLB).

A listener waits for traffic to arrive for an IP address and distributes the traffic to the backend set servers of the NLB. Configure at least one listener for each traffic type. Ensure that your VCN security rules allow the listener to accept traffic.

    1. In the Roving Edge Device Console navigation menu, select Networking, then select Network Load Balancers.

    2. At the top of the page, select the compartment that contains the load balancer.

    3. Select the name of the Network Load Balancer for which you want to create the listener.

    4. On the network load balancer's details page, under Resources, select Listeners.

    5. Select Create Listener.

    6. Enter the following information:

      • Name: Enter a descriptive name for the Listener. Avoid entering confidential information.

      • Protocol: Select TCP, UDP, or TCP_AND_UDP from the drop-down list.

      • Port: Enter the port you want to use. For TCP, the default port value 22 is preselected. Use the up or down arrows to change the port value, or enter a value between 1 and 65,535.

      • Backend Set: Select the backend set for the listener from the drop-down list. If the value is None Available, then you haven't yet created any NLB backend sets and must do so before this parameter can be configured.

      • IP Version: The default IP Version 4 is preselected.

    7. Select Create Listener.

      To display the details of the listener, you view the details for the network load balancer. See Viewing NLB Details.

  • Use the oci nlb listener create command and required parameters to add a listener to a network load balancer.

    oci nlb listener create --default-backend-set-name backend-set-name \
--network-load-balancer-id network-load-balancer_OCID \  
--name listener-name --port listener-port \
--protocol listener-protocol  [OPTIONS]

    Procedure

    1. Gather the information you need to run the command:

      • Compartment OCID (oci iam compartment list)

      • NLB OCID (oci nlb network-load-balancer list)

      • NLB accepted protocol list (oci nlb protocol list)

    2. Run the create listener command.

      Syntax:

      oci nlb listener create --default-backend-set-name backend-set-name \
--network-load-balancer-id network-load-balancer_OCID \  
--name listener-name --port listener-port \
--protocol listener-protocol

      Where:

      • backend-set-name is the name of the associated backend set.

      • network-load-balancer_OCID is the OCID of the load balancer on which to add a listener.

      • listener-name is a user-friendly name for the listener. It must be unique and it cannot be changed.

      • listener-port is the communication port integer for the listener.

      • listener-protocol is the protocol on which the listener accepts connection requests: TCP, UDP, or TCP_AND_UDP.

      For information about optional parameters, use oci nlb listener create -h.

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

  • Use the CreateListener operation to add a listener to a network load balancer.

    For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.