Contact UsGet started

Changing network load balancer settings

Written by
Updated at July 1, 2024

Note

You can only set the load balancer type (internal or external) when creating it. You cannot update its type afterwards.

After you create a network load balancer, you can:

Changing a load balancer's name and description

  1. Go to the folder page and select Network Load Balancer.
  2. Select a load balancer and click Edit at the top of the page.
  3. Enter a new name and description for the load balancer.
  4. Click Edit.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To change the name and description of a load balancer:

  1. Find out the ID or name of the load balancer by getting a list of network load balancers in the folder.

  2. View the current name and description of the load balancer:

    yc load-balancer network-load-balancer get <load_balancer_name_or_ID>

  3. View a description of the update load balancer configuration CLI command:

    yc load-balancer network-load-balancer update --help

  4. Enter a new name and description for the load balancer:

    yc load-balancer network-load-balancer update <load_balancer_name_or_ID> \
   --new-name=<new_load_balancer_name> \
   --description=<new_load_balancer_description>

  1. Open the current Terraform configuration file with an infrastructure plan.

    For more information about creating this file, see Creating a network load balancer.

    For a complete list of updatable configuration fields of a network load balancer, see the provider documentation.

  2. In the network load balancer description, change the name and description parameter values:

    resource "yandex_lb_network_load_balancer" "foo" {
  name        = "<load_balancer_name>"
  description = "<load_balancer_description>"
  ...

  3. Make sure the settings are correct.

    1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

    2. Run the command:

      terraform validate

      If there are errors in the configuration files, Terraform will point to them.

  4. Confirm updating the resources.

    1. Run the command to view planned changes:

      terraform plan

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

    2. If you are happy with the planned changes, apply them:

      1. Run the command:

        terraform apply

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

Use the update API method and include the following in the request:

  • Load balancer ID in the networkLoadBalancerId parameter. To find out the ID, get a list of network load balancers in the folder.
  • A new name in the name parameter.
  • A new description in the description parameter.
  • List of cluster configuration fields to update in the updateMask parameter (in this case, name and description).

Warning

This API method overrides all parameters of the object being modified that were not explicitly passed in the request to the default values. To avoid this, list the settings you want to change in the updateMask parameter (one line separated by commas).

Changing load balancer labels

  1. Go to the folder page and select Network Load Balancer.
  2. Select a load balancer and click Edit at the top of the page.
  3. Change load balancer labels.
  4. Click Edit.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To update the labels of a network load balancer:

  1. View the current load balancer's labels and their values:

    yc load-balancer network-load-balancer get <load_balancer_name_or_ID>

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

  2. View a description of the update load balancer configuration CLI command:

    yc load-balancer network-load-balancer update --help

  3. Set new values for the load balancer labels:

    yc load-balancer network-load-balancer update <load_balancer_name_or_ID> \
   --labels <key_1>=<value_1>,<key_2>=<value_2>,...

  1. Open the current Terraform configuration file with an infrastructure plan.

    For more information about creating this file, see Creating a network load balancer.

    For a complete list of updatable configuration fields of a network load balancer, see the provider documentation.

  2. In the network load balancer description, change the name and description parameter values:

    resource "yandex_lb_network_load_balancer" "foo" {
  ...
  labels = {
    <key_1> = "<value_1>"
    <key_2> = "<value_2>"
    ...
  }
  ...

  3. Make sure the settings are correct.

    1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

    2. Run the command:

      terraform validate

      If there are errors in the configuration files, Terraform will point to them.

  4. Confirm updating the resources.

    1. Run the command to view planned changes:

      terraform plan

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

    2. If you are happy with the planned changes, apply them:

      1. Run the command:

        terraform apply

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

Use the update API method and include the following in the request:

  • Load balancer ID in the networkLoadBalancerId parameter. To find out the ID, get a list of network load balancers in the folder.
  • New label values in the labels parameter.
  • List of cluster configuration fields to update in the updateMask parameter (in this case, labels).

Warning

This API method overrides all parameters of the object being modified that were not explicitly passed in the request to the default values. To avoid this, list the settings you want to change in the updateMask parameter (one line separated by commas).

Changing a target group or its health check settings

  1. Go to the folder page and select Network Load Balancer.
  2. Select a load balancer and click Edit at the top of the page.
  3. Under Target groups, select a new target group from the drop-down list or create a new one.
  4. To change target group health check settings:
    1. In the section of the appropriate target group, click Configure.
    2. Set up new target group health check parameters.
    3. Click Apply.
  5. Click Edit.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To update a target group or its health check settings:

  1. View a description of the update load balancer configuration CLI command:

    yc load-balancer network-load-balancer update --help

  2. Specify the target group's new ID and health check settings:

    yc load-balancer network-load-balancer update <load_balancer_name_or_ID> \
   --target-group target-group-id=<target_group_ID>,`
                 `healthcheck-name=<health_check_name>,`
                 `healthcheck-interval=<health_check_interval>s,`
                 `healthcheck-timeout=<response_timeout>s,`
                 `healthcheck-unhealthythreshold=<number_of_failed_health_checks_for_Unhealthy_status>,`
                 `healthcheck-healthythreshold=<number_of_successful_health_checks_for_Healthy_status>,`
                 `healthcheck-tcp-port=<TCP_port>,`
                 `healthcheck-http-port=<HTTP_port>,`
                 `healthcheck-http-path=<URL>

    Where:

    • --target-group: Target group parameters and settings of its resource health checks:

      • target-group-id: Target group ID.

        To find out the ID, get a list of target groups in the folder.

      • healthcheck-name: Resource health check name.

      • healthcheck-interval: Health check interval in seconds. The possible values are from 1s to 60s. The interval must be at least 1 second longer than the waiting time.

      • healthcheck-timeout: Response timeout in seconds. The possible values are from 1s to 60s.

      • healthcheck-unhealthythreshold: Number of failed checks after which no traffic will be routed to a virtual machine. The possible values are from 2 to 10.

      • healthcheck-healthythreshold: Number of successful checks required to consider a virtual machine ready to receive traffic. The possible values are from 2 to 10.

      • healthcheck-tcp-port: Port for health checks via TCP. The possible values are from 1 to 32,767.

      • healthcheck-http-port: Port for health checks via HTTP. The possible values are from 1 to 32,767.

      • healthcheck-http-path: URL to perform health checks via HTTP.

      You cannot specify healthcheck-tcp-port and healthcheck-http-port at the same time.

      Warning

      The healthcheck-interval and healthcheck-timeout parameter values must be in <time_in_seconds>s format, e.g., 20s.

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

  1. Open the current Terraform configuration file with an infrastructure plan.

    For more information about creating this file, see Creating a network load balancer.

    For a complete list of updatable configuration fields of a network load balancer, see the provider documentation.

  2. In the network load balancer description, update the target group ID and its health check settings under attached_target_group:

    resource "yandex_lb_network_load_balancer" "foo" {
  name = "<load_balancer_name>"
  ...
  attached_target_group {
    target_group_id = "<target_group_ID>"
    healthcheck {
      name = "<health_check_name>"
      http_options {
        port = <port_number>
        path = "<URL>"
      }
    }
  }
  ...
}

    Where:

    • name: Name of the network load balancer.
    • attached_target_group: Description of the network load balancer's target group parameters:

      • target_group_id: Target group ID.

        To find out the ID, get a list of target groups in the folder.

      • healthcheck: Health check parameters. Enter a name, a port number ranging from 1 to 32767, and a path for health checks.

  3. Make sure the settings are correct.

    1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

    2. Run the command:

      terraform validate

      If there are errors in the configuration files, Terraform will point to them.

  4. Confirm updating the resources.

    1. Run the command to view planned changes:

      terraform plan

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

    2. If you are happy with the planned changes, apply them:

      1. Run the command:

        terraform apply

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

Use the update API method and include the following in the request:

  • Load balancer ID in the networkLoadBalancerId parameter. To find out the ID, get a list of network load balancers in the folder.

  • Target group ID and its health check settings in the attachedTargetGroups parameter.

    To find out the ID, get a list of target groups in the folder.

  • List of cluster configuration fields to update in the updateMask parameter (in this case, attachedTargetGroups).

Warning

This API method overrides all parameters of the object being modified that were not explicitly passed in the request to the default values. To avoid this, list the settings you want to change in the updateMask parameter (one line separated by commas).

Attaching a target group

To attach a target group, follow this guide.

Adding a listener

To add a listener, follow this guide.

Previous
Stopping and starting a load balancer
Next
Moving a VM to a target group in a new availability zone