Specify the virtual server type:

After you have specified the type, the CLI commands are constrained to the ones that are applicable to the specified type, not all of the settings described in this table.

Note: IPv6 is not supported for FTP or HTTP Turbo profiles.

Enable/disable alone mode. When enabled, each virtual server is handled by a separate haproxy daemon. When disabled, all virtual servers are handled by one haproxy daemon.

Note: HTTP, HTTPS, and TCPS only.

Specify an auth policy configuration object. HTTP/HTTPS only.

Limit the number of concurrent connections. The default is 0 (disabled). The valid range is 1 to 1,048,576 concurrent connections.

You can apply a connection limit per real server and per virtual server. Both limits are enforced. Attempted connections that are dropped by security rules are not counted.

Note: Not supported for FTP profiles.

Specify a connection pool configuration object.

With all Layer 4 profiles, and with the Layer 2 TCP profile, you can limit the number of new connections per second. The default is 0 (disabled). The valid range is 1 to 86,400 connections per second.

You can apply a connection rate limit per real server and per virtual server. Both limits are enforced. Attempted connections that are dropped by security rules are not counted.

Note: Not supported for FTP profiles.

Enable to rewrite HTTP headers.

Specify content rewriting rules.

Note: You can select multiple content rewriting rules in the virtual server configuration. Rules that you add are consulted from top to bottom. The first rule to match is applied. If the traffic does not match any of the content rewriting rule conditions, the header is not rewritten.

Enable to route packets to backend servers based on IP address (Layer 4) or HTTP headers (Layer 7 content).

Overrides static or policy routes.

Specify content route configuration objects.

Note: You can specify multiple content routing rules in the virtual server configuration. Rules that you add are consulted from top to bottom. The first rule to match is applied. If the traffic does not match any of the content routing rule conditions specified in the virtual server configuration, the system behaves unexpectedly. Therefore, it is important that you create a “catch all” rule that has no match conditions. In the virtual server configuration, this rule should be ordered last so it can be used to forward traffic to a default pool.

Specify an error page configuration object.

If you do not use an error page, you can enter an error message to be returned to clients in the event no server is available.

Specify a geography IP address block list configuration object.

Specify a geography IP address whitelist configuration object.

Deprecated.

Network interface that receives client traffic for this virtual server.

IP address provisioned for the virtual server.

Note: You do not specify an IP address for a Layer 2 virtual server. A Layer 2 virtual server is not aware of IP addresses. Instead of routing data for a specific destination, this type of server simply forwards data from the specified network interface and port.

Port number to listen for client requests.

Note: If a Layer 2 virtual server is assigned a network interface that uses port 80 or 443, ensure that the HTTPS and HTTP administrative access options are not enabled for the interface.

Specify the number of ports in a port range. For example, if port is 80, and port-range is 254, then the virtual port range starts at 80 and goes to 334.

The default is 0 (no range). The valid range is 0-255.

The port-range option is useful in deployments where it is desirable to have a virtual IP address with a large number of virtual ports, such as data centers or web hosting companies that use port number to identify their specific customers.

Statistics and configurations are applied to the virtual port range as a whole and not to the individual ports within the specified range.

Note: Not supported for HTTP Turbo, RADIUS, FTP, or Layer 2 TCP profiles.

Specify a predefined or user-defined method configuration object.

Specify a predefined or user-defined persistence configuration object.

Specify a server pool configuration object.

Specify a predefined or user-defined profile configuration object.

If your system has a multicore CPU, you can assign the number of CPU cores to handle traffic for a virtual server. The valid range is 1 to 15.

Note: HTTP, HTTPS, and TCPS only.

In Layer 4 virtual server deployments, select one of the following packet forwarding methods:

If you are configuring a Layer 4 virtual server and enable Full NAT, NAT46, or NAT64, specify a source pool configuration object.

Specify an auth policy configuration object. HTTP/HTTPS only.

Enable to record traffic logs for this virtual server.

Note: Local logging is constrained by available disk space. We recommend that if you enable traffic logs, you monitor your disk space closely. We also recommend that you use local logging during evaluation and verification of your initial deployment, and then configure remote logging to send logs to a log management repository.

Limit the number of HTTP requests per second. The default is 0 (disabled). The valid range is 1 to 1,048,567 transactions per second.

The system counts each client HTTP request against the limit. When the HTTP request rate exceeds the limit, the virtual server sends an HTTP 503 error response to the client.

Note: Not supported for HTTP Turbo profiles.

Specify a web application firewall (WAF) profile configuration object.

Maximum connection rate while the virtual server is starting up. The default is 10 connections per second. The valid range is 1 to 86,400 connections per second.

If Warm Up is 5 and Warm Rate is 2, the number of allowed new connections increases at the following rate:

If the server cannot initially handle full connection load when it begins to respond to health checks (for example, if it begins to respond when startup is not fully complete), indicate how long to forward traffic at a lesser rate. The default is 0 (disabled). The valid range is 1 to 86,400 seconds.