How to configure the listener

This section describes how to configure the listener.

Listener is a function to check the connection request to Managed Load Balancer using the specified IP address, port number, and protocol.

Add listener

  • From the control panel, select Cloud / Server Local Network → Managed Load Balancer.

  • The Managed Load Balancers list screen is displayed, select the Managed Load Balancer to which you want to add a listener.

listner_add_1
  • Open the "Listeners" tab and click "Add Listener".

ManagedLB
  • Enter the required items to add a listener and click "Add Listener".

  • The items that can be configured when adding a listener are as follows.

Specifiable parameters

detail

Input format

name

You can configure the name of the listener.

255 half-width characters

Explanation

You can configure the listener description.

255 half-width characters

tag

You can configure the listener tag.

JSON format

IP address

You can configure the IP address used by the listener.

IPv4 address format

port

You can configure the port number used by the listener.

Integer 1 ~ 65534

protocol

You can select the protocol used by the listener from the pull-down menu.
[TCP, UDP]
 

Note

  • You cannot set an IP address belonging to the same segment with the virtual IP address (VIP) for the interface of the load balancer as the IP address of the listener. Please set the listener's IP address in another segment.

  • You cannot specify a combination of IP address and port that is already used by another listener on the same load balancer.

  • Confirm that the listener's config status is "CREATE_STAGED".

listner_add_3
  • Execute "Apply Load Balancer Settings" to complete the listener addition.

Note

  • You can apply the load balancer settings together with other setting items.

Display the details of listener

  • In the Managed Load Balancer list screen, click the resource name of the Managed Load Balancer whose listener details you want to check.

  • Open the "Listeners" tab and click the listener's resource name for more information.

listner_detail_1
  • The information that can be confirmed on the listener details screen is as follows.

Specifiable parameters

detail

name

You can see the name of the listener.

ID

You can see the listener's ID.

Explanation

You can see the listener description.

tag

You can see the listener's tag.

Config status

You can see the config status of the listener.

The possible values are as follows.
・"ACTIVE":The load balancer does not have a config waiting to be applied.
・"CREATE_STAGED":The config added to the load balancer is waiting to be applied.
・"UPDATE_STAGED":The config to be changed to the load balancer is waiting to be applied.
・"DELETE_STAGED":The config to be deleted by the load balancer is waiting to be applied.

Operation status

You can see the operational status of the listener.

The possible values are as follows.
・"NONE":Initial state
・"PROCESSING":The state in which the config is being applied to the load balancer.
・"COMPLETE":The state where the latest operation is completed
・"STUCK":The latest operation processing is stopped and operator intervention is required, so it is impossible to operate the resource.
・"ERROR":The latest operation processing failed, but since it has been rolled back normally, it is possible to operate the resource.

IP address

You can see the IP address used by the listener.

port

You can see the port number used by the listener.

protocol

You can see the protocol used by the listener.

Edit listener

  • In the Managed Load Balancer list screen, click the resource name of the Managed Load Balancer whose listener you want to edit.

  • Open the "Listeners" tab and click "Edit Listener" from the Actions pull-down for the listener you want to edit.

listner_edit_1
  • Enter the settings you want to edit and click "Edit Listener".

  • The items that can be set when editing the listener are as follows.

Specifiable parameters

detail

Input format

name

You can configure the name of the listener.

255 half-width characters

Explanation

You can configure the listener description.

255 half-width characters

tag

You can configure the listener tag.

JSON format

IP address

You can configure the IP address used by the listener.

IPv4 address format

port

You can configure the port number used by the listener.

Integer 1 ~ 65534

protocol

You can select the protocol used by the listener from the pull-down menu.
[TCP, UDP]
 

Note

  • You cannot set an IP address belonging to the same segment with the virtual IP address (VIP) for the interface of the load balancer as the IP address of the listener. Please set the listener's IP address in another segment.

  • You cannot specify a combination of IP address and port that is already used by another listener on the same load balancer.

  • If the listener's config status is "UPDATE_STAGED" or "CREATE_STAGED", to execute "Apply Load Balancer Settings" puts editing the listener completed.

listner_edit_2

Note

  • If you edit only the name, description, and tag, the config status will not change to "UPDATE_STAGED".

  • In addition, you can apply the load balancer settings together with other setting items.

Cancel listener settings

  • In the Managed Load Balancer list screen, click the resource name of the Managed Load Balancer whose listener settings you want to cancel.

  • Open the "Listeners" tab and click "Cancel the Listener Settings" from the listener's Actions pull-down for which you want to cancel the settings.

listner_cancel_change_1
  • The confirmation screen for canceling the listener settings is displayed, click "Confirmation of Cancellation of Listener Settings".

listner_cancel_change_2

Delete listener

  • In the Managed Load Balancer list screen, click the resource name of the Managed Load Balancer whose listener settings you want to delete.

  • Open the "Listeners" tab and click "Delete Listener" from the Actions pull-down for the listener you want to delete.

listner_delete_1
  • The confirmation screen for deleting the listener is displayed, click "Delete Listener".

listner_delete_2

Note

  • After the listener config status becomes "DELETE_STAGED" by this operation, the listener settings will not be deleted from the load balancer instance until the load balancer settings are applied. If you want to delete the listener settings from the load balancer instance, execute "Apply Load Balancer Settings" following this operation.

  • If you want to cancel the setting that is "DELETE_STAGED", execute "Cancel the Listener Settings".

  • Confirm that the status of the listener turns into "DELETE_STAGED".

listner_delete_3
  • Execute "Apply Load Balancer Settings" to complete the listener deletion.

Note

  • You can apply the load balancer settings together with other setting items.