Fortinet white logo
Fortinet white logo

CLI Reference

waf waiting-room policy

waf waiting-room policy

You can use Waiting Room to manage visitor traffic and avoid server overload delays, you can enable a virtual holding space and queuing system, allowing new users to enter a Waiting Room where they can view estimated wait times before accessing your application.

This feature may be configured for your entire website, or specific URL paths.

Use this command to create waiting room policies.

Syntax

config waf waiting-room-policy

edit <waiting-room-policy_name>

set path-type {plain | regular}

set path <string>

set total-active-users <integer>

set new-users-per-min <integer>

set session-duration <integer>

set description <string>

config bypass-rules

edit <bypass-rules_id>

set type source-ip

set value <string>

next

end

next

end

Variable Description Default
<waiting-room-policy_name> Enter a 40-character string for the name, for example e1947036-a1fa-489e-8434-c8a401a75f78. No default
path-type {plain | regular} Select whether to use a Simple String or a Regular Expression to specify the URLs for the Waiting Room. When users access the URL, FortiWeb will queue their requests according to the Waiting Room policy. plain

path <string>

The waiting room will only be enabled for the configured URL. Use /.* to match all.

  • If Path Type is Simple String, enter the literal URL.

  • If Path Type is Regular Expression, enter a regular expression to match the URLs.

This value cannot be empty.

No default

total-active-users <integer>

Control the size of traffic accessing your application.

If the number of active users reaches the configured value, additional users will enter the Waiting Room.

0

new-users-per-min <integer>

Prevent your application from being flooded by new users in a short time span.

If the number of new users per minute reaches the configured value, additional users will enter the Waiting Room.

At least specify one of total-active-users and new-users-per-min.

If you choose to configure both, make sure that total-active-users is set to a value greater than or equal to new-users-per-min.

0

session-duration <integer>

Users who have remained idle for the configured time will be considered as a new user.

Users who have ended and restarted the session will also be considered as a new user.

This value cannot be empty.

5

description <string>

Enter a brief description for the Waiting Room Policy.

No default

<bypass-rules_id>

Add bypass rules to allow users with certain IP addresses to access your application directly, even if they trigger the above limiting conditions.

No default

value <string>

Enter an IP address or range in the Value field to configure a new Bypass rule.

No default

Related topics

waf waiting-room policy

waf waiting-room policy

You can use Waiting Room to manage visitor traffic and avoid server overload delays, you can enable a virtual holding space and queuing system, allowing new users to enter a Waiting Room where they can view estimated wait times before accessing your application.

This feature may be configured for your entire website, or specific URL paths.

Use this command to create waiting room policies.

Syntax

config waf waiting-room-policy

edit <waiting-room-policy_name>

set path-type {plain | regular}

set path <string>

set total-active-users <integer>

set new-users-per-min <integer>

set session-duration <integer>

set description <string>

config bypass-rules

edit <bypass-rules_id>

set type source-ip

set value <string>

next

end

next

end

Variable Description Default
<waiting-room-policy_name> Enter a 40-character string for the name, for example e1947036-a1fa-489e-8434-c8a401a75f78. No default
path-type {plain | regular} Select whether to use a Simple String or a Regular Expression to specify the URLs for the Waiting Room. When users access the URL, FortiWeb will queue their requests according to the Waiting Room policy. plain

path <string>

The waiting room will only be enabled for the configured URL. Use /.* to match all.

  • If Path Type is Simple String, enter the literal URL.

  • If Path Type is Regular Expression, enter a regular expression to match the URLs.

This value cannot be empty.

No default

total-active-users <integer>

Control the size of traffic accessing your application.

If the number of active users reaches the configured value, additional users will enter the Waiting Room.

0

new-users-per-min <integer>

Prevent your application from being flooded by new users in a short time span.

If the number of new users per minute reaches the configured value, additional users will enter the Waiting Room.

At least specify one of total-active-users and new-users-per-min.

If you choose to configure both, make sure that total-active-users is set to a value greater than or equal to new-users-per-min.

0

session-duration <integer>

Users who have remained idle for the configured time will be considered as a new user.

Users who have ended and restarted the session will also be considered as a new user.

This value cannot be empty.

5

description <string>

Enter a brief description for the Waiting Room Policy.

No default

<bypass-rules_id>

Add bypass rules to allow users with certain IP addresses to access your application directly, even if they trigger the above limiting conditions.

No default

value <string>

Enter an IP address or range in the Value field to configure a new Bypass rule.

No default

Related topics