How to create a listener?
Last updated
Last updated
To create a listener, follow the below steps:
Step 1: Login to your account.
Step 2: Navigate to Services and then click on My Services.
Step 3: Click on your project.
Step 4: Navigate to Networks and then click on Load Balancer.
Step 5: Choose the load balancer for which you want to create the listener and click on the load balancer name.
Step 6: Navigate to Listener tab and click on Create Listener.
Step 7: Enter the Listener Details and click Next.
Note: If you do not want to create a listener, disable the toggle and click Next.
Field | Description |
Listener Name* | Enter the name of the Listener. |
Listener Description | Enter the description of the Listener. |
Listener Protocol* | Select a protocol for the listener from the below options:
|
Listener Port* | The protocol port number for the resource. The default is 1. |
Client Data Timeout (in ms) | Enter client inactivity timeout in milliseconds. The default is 50000. |
TCP Inspect Timeout (in ms) | Enter time, in milliseconds, to wait for additional TCP packets for content inspection. The default is 0. |
Member Connect Timeout (in ms) | Enter member connection timeout in milliseconds. The default is 5000. |
Member Data Timeout (in ms) | Enter member inactivity timeout in milliseconds. The default is 50000. |
Allowed CIDRs | Enter a list of IPv4, IPv6 or mix of both CIDRs. |
Connection Limit* | The maximum number of connections permitted for this listener. Default value is -1 which represents infinite connections. |
TLS Cipher String* | Enter List of ciphers in OpenSSL format and it should be colon-separated. |
Insert Headers | Select the headers to insert into the request before it is sent to the member from the below option:
|
Step 8: Enter Pool Details, Server Monitor Health details and click Next.
Note:
If you have not created Listener, you will not be able to create Pool and Monitor.
If you have not created Pool, you will not be able to create Monitor.
If you do not want to create Pool and Monitor disable the toggle and click Next.
Field | Description |
Pool Name* | Enter the name of the Pool. |
Pool Description | Enter the description of the pool. |
Pool Algorithm* | Select the load balancing algorithm for the pool from the below options:
|
Pool Protocol* | Select a protocol for the pool from the below options:
|
TLS Enabled |
|
TLS Cipher String | Enter List of ciphers in OpenSSL format and it should be colon-separated. |
Session Persistence | Select a JSON object specifying the session persistence for the pool from the below options:
|
Cookie Name* | Enter the name of the cookie to use for session persistence. |
Monitor Name* | Enter the name of the Health Monitor. |
Monitor Protocol* | Select a protocol for the health monitor from the below options:
|
Max Retries Down* | Enter the number of allowed check failures before changing the operating status of the member to ERROR. A valid value is from 1 to 10. The default is 3. |
Delay (in sec.)* | Enter the interval, in seconds, between health checks. The default is 10. |
Max Retries* | Enter the number of successful checks before changing the operating status of the member to ONLINE. The default is 1. |
Timeout (in sec.)* | The time, in seconds, after which a health check times out. The default is 5. |
HTTP Method | Select the HTTP method that the health monitor uses for requests from the below options:
|
Expected Codes* | Enter the HTTP status codes expected in response from the member to declare it healthy. The default is 200. |
URL Path* | Enter the HTTP URL path of the request sent by the monitor to test the health of a member. Must be a string that begins with a forward slash. The default URL path is /. |
Step 9: Enter Backend Servers details and click Next.
Note:
If you have not created Pool, you will not be able to create Backend Servers.
If you do not want to create Backend Servers disable the toggle and click Next.
Field | Description |
Add Servers* | Select the servers from the dropdown. |
Specific IP | Enter the specific IP you want to Add and click on Add button. |
Name | Name of the server. |
IP Address | IP address of the server. |
Associated Subnet | Name of the subnet, associated with the server. |
Specific Port* | Enter the specific port you want to add. |
Monitor Address | Enter an alternate IP address used for health monitoring a member. |
Monitor Port | Enter an alternate protocol port used for health monitoring a member. |
Weight | Enter the weight of a member determines the portion of requests or connections it services compared to the other members of the pool. |
Step 10: Review your load balancer details and click on Create button.