Fortinet white logo
Fortinet white logo

CLI Reference

system replacemsg

system replacemsg

Use this command to customize the following FortiWeb HTML pages:

  • Pages that FortiWeb presents to clients when it authenticates users. FortiWeb uses these pages when you configure a site publishing configuration to use HTML form authentication for its client authentication method. For details, see waf site-publish-helper rule.

  • The error page FortiWeb uses to respond to an HTTP request that violates a policy that responds to violations with the action alert and deny or period block.

  • The error page FortiWeb uses to respond to a AJAX request that violates a policy and the configured action is Alert & Deny or Period Block.
  • The “Server Unavailable!” page that FortiWeb returns to the client when none of the server pool members are available either because they are disabled or in maintenance more, or they have failed the configured health check.

When you specify the HTML code for the web pages using the buffer setting, you enter the complete HTML code with changes, even if you are only changing a word or fixing a typographical error. The web UI provides a more convenient editing method that allows you to see the effect of your changes as you edit.

To use this command, your administrator account’s access control profile must have either w or rw permission to the sysgrp area. For details, see Permissions.

Syntax

config system replacemsg

edit replacemsg name <name_str>

set ajax-block-support {enable | disable}

config page-list

edit page-list name <name_str>

set code <code_int>

set group {alert | site-publish | captcha | ajax-block}

set msg <msg_str>

set replacemsg-custom-headers <datasource>

next

end

next

end

Variable Description Default

replacemsg name <name_str>

Enter the name for the replacement message.

No default

ajax-block-support {enable | disable}

Enable AJAX requests support to respond to a AJAX request, and configure the AJAX block page message.

disable

page-list name <name_str>

Select the message that you want to edit in the list.

No default

code <code_int>

If you are editing the url-block item, specify the HTTP page return code as an integer.

You cannot edit this setting for other HTML pages.

500

group {alert | site-publish | captcha | ajax-block}

Specifies whether the replacement page is used for security features (blocking and server unavailable) or site publishing feature.

Cannot be changed from the default.

alert (url-block, server-inaccessible)

site-publish (login, token, rsa-login, rsa-challenge)

msg <msg_str>

Edit the selected message to edit.

No default

replacemsg-custom-headers <datasource>

Specify the Custom Headers to be inserted in the HTTP response whenever the replacement message is triggered.

The Custom Headers are created through config system replacemsg-custom-header.

No default

Related topics

system replacemsg

system replacemsg

Use this command to customize the following FortiWeb HTML pages:

  • Pages that FortiWeb presents to clients when it authenticates users. FortiWeb uses these pages when you configure a site publishing configuration to use HTML form authentication for its client authentication method. For details, see waf site-publish-helper rule.

  • The error page FortiWeb uses to respond to an HTTP request that violates a policy that responds to violations with the action alert and deny or period block.

  • The error page FortiWeb uses to respond to a AJAX request that violates a policy and the configured action is Alert & Deny or Period Block.
  • The “Server Unavailable!” page that FortiWeb returns to the client when none of the server pool members are available either because they are disabled or in maintenance more, or they have failed the configured health check.

When you specify the HTML code for the web pages using the buffer setting, you enter the complete HTML code with changes, even if you are only changing a word or fixing a typographical error. The web UI provides a more convenient editing method that allows you to see the effect of your changes as you edit.

To use this command, your administrator account’s access control profile must have either w or rw permission to the sysgrp area. For details, see Permissions.

Syntax

config system replacemsg

edit replacemsg name <name_str>

set ajax-block-support {enable | disable}

config page-list

edit page-list name <name_str>

set code <code_int>

set group {alert | site-publish | captcha | ajax-block}

set msg <msg_str>

set replacemsg-custom-headers <datasource>

next

end

next

end

Variable Description Default

replacemsg name <name_str>

Enter the name for the replacement message.

No default

ajax-block-support {enable | disable}

Enable AJAX requests support to respond to a AJAX request, and configure the AJAX block page message.

disable

page-list name <name_str>

Select the message that you want to edit in the list.

No default

code <code_int>

If you are editing the url-block item, specify the HTTP page return code as an integer.

You cannot edit this setting for other HTML pages.

500

group {alert | site-publish | captcha | ajax-block}

Specifies whether the replacement page is used for security features (blocking and server unavailable) or site publishing feature.

Cannot be changed from the default.

alert (url-block, server-inaccessible)

site-publish (login, token, rsa-login, rsa-challenge)

msg <msg_str>

Edit the selected message to edit.

No default

replacemsg-custom-headers <datasource>

Specify the Custom Headers to be inserted in the HTTP response whenever the replacement message is triggered.

The Custom Headers are created through config system replacemsg-custom-header.

No default

Related topics