Adding a listener to a network load balancer

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To add a listener to a network load balancer, run this command:

yc load-balancer network-load-balancer add-listener <load_balancer_name_or_ID> \
   --listener name=<listener_name>,`
             `port=<port>,`
             `target-port=<target_port>,`
             `protocol=<protocol>,`
             `external-address=<external_IP_address>,`
             `external-ip-version=<IP_address_version>

Where:

• --listener: Listener settings:
  • name: Listener name.
  • port: Port on which the load balancer will listen to incoming traffic. The possible values range from 1 to 32767.
  • target-port: Port to which the load balancer will redirect traffic. The possible values range from 1 to 32767.
  • protocol: Protocol the listener will use, tcp or udp.
  • external-address: External IP address of the listener.
  • external-ip-version: External IP address version, ipv4 or ipv6.

You can get the load balancer ID and name with the list of network load balancers in the folder.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the relevant documentation on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

1. Open the Terraform configuration file and add the listener section to the network load balancer description:

   resource "yandex_lb_network_load_balancer" "foo" {
     name = "<load_balancer_name>"
     ...
     listener {
       name = "<listener_name>"
       port = <port_number>
       external_address_spec {
         ip_version = "<IP_address_version>"
       }
     }
     ...
   }
   

   Where:

   • name: Name of the network load balancer.
   • listener: Listener settings:
     • name: Listener name.
     • port: Port in the range from 1 to 32767 the network load balancer will receive incoming traffic at.
     • external_address_spec: Specification of the listener for the external load balancer settings:
       • ip_version: External IP address specification. Specify the IP address version, ipv4 or ipv6. The default is ipv4.

   For more information about yandex_lb_network_load_balancer settings, see this Terraform article.

2. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

3. Add a listener.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

To add a listener to a network load balancer, use the addListener REST API method for the NetworkLoadBalancer resource or the NetworkLoadBalancerService/AddListener gRPC API call.

1. Open the Terraform configuration file and add the listener section to the network load balancer description:

   resource "yandex_lb_network_load_balancer" "foo" {
     name = "test-load-balancer"
     listener {
       name        = "test-listener"
       port        = 80
       target_port = 81
       protocol    = "tcp"
       external_address_spec {
         ip_version = "ipv4"
       }
     }
   }
   

   For more information about the resources you can create with Terraform, see this provider guide.

2. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

3. Create a network load balancer.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

Use the addListener API method, providing the following in the request body:

{
  "listenerSpec": {
    "name": "test-listener",
    "port": "80",
    "protocol": "TCP",
    "targetPort": "81",
    "externalAddressSpec": {
      "ipVersion": "ipv4"
    }
  }
}