Fortinet black logo

Cookbook

Replacement messages

Copy Link
Copy Doc ID 5be0d1a4-3f0d-11eb-96b9-00505692583a:131140
Download PDF

Replacement messages

The replacement message list in System > Replacement Messages enables you to view and customize replacement messages. Highlight the replacement messages you want to edit and customize the message content to your requirements. Hit Save when done. If you do not see the message you want to edit, select the Extended View option in the upper right-hand corner of the screen.

If you make a mistake, select Restore Default to return to the original message and code base.

Replacement message images

You can add images to replacement messages on:

  • Disclaimer pages
  • Login pages
  • Declined disclaimer pages
  • Login failed pages
  • Login challenge pages
  • Keepalive pages
    Note

    Supported image formats are GIF, JPEG, TIFF, and PNG. The maximum file size supported is 24KB.

Adding images to replacement messages

To add images to replacement messages in the GUI:
  1. Go to System > Replacement Messages.
  2. Click Manage Images at the top of the page.
  3. Click Create New.
  4. Enter a name for the image.
  5. Click Upload Image and locate the file.

  6. Click OK.

To add images to replacement messages in the CLI:
config system replacemsg-image
    edit <image_name>
        set image-type {gif | jpg | tiff | png}
        set image-base64 <string>
    next
end

Modifying replacement messages

Replacement messages can be modified to include an HTML message or content that suits your organization. A list of common replacement messages appear in the main window. Select Extended View to see the entire list and all categories for replacement messages.

To modify a replacement message in the GUI:
  1. Go to System > Replacement Messages.
  2. Select the replacement message you want to edit.
  3. In the bottom pane of the GUI the message will be displayed on the left alongside the HTML code on the right. Edit the HTML code as needed.

    The message view changes in real-time as you edit the content.

  4. Click Save.
To modify a replacement message in the CLI:
config system replacemsg <message_category> <message_type>
    set buffer <string>
    set header {none | http | 8bit}
    set format {none | text | html}
end

For example, to modify the Traffic Quota Limit Exceeded Page message:

config system replacemsg traffic-quota "per-ip-shaper-block"
    set buffer "<html>
  <head>
    <title>
      Traffic Quota Control
    </title>
  </head>
  <body>
    <font size=2>
      <table width=\"100%\">
        <tr>
          <td bgcolor=#3300cc align=\"center\" colspan=2>
            <font color=#ffffff>
              <b>
                Traffic blocked because exceeded session quota
              </b>
            </font>
          </td>
        </tr>
      </table>
      <br>
      <br>
      Traffic blocked because it exceeded the per IP shaper session quota. Please contact the system administrator.
      <br>
      %%QUOTA_INFO%%
      <br>
      <br>
      <hr>
    </font>
  </body>
</html>"
    set header http
    set format html
end

Replacement messages

The replacement message list in System > Replacement Messages enables you to view and customize replacement messages. Highlight the replacement messages you want to edit and customize the message content to your requirements. Hit Save when done. If you do not see the message you want to edit, select the Extended View option in the upper right-hand corner of the screen.

If you make a mistake, select Restore Default to return to the original message and code base.

Replacement message images

You can add images to replacement messages on:

  • Disclaimer pages
  • Login pages
  • Declined disclaimer pages
  • Login failed pages
  • Login challenge pages
  • Keepalive pages
    Note

    Supported image formats are GIF, JPEG, TIFF, and PNG. The maximum file size supported is 24KB.

Adding images to replacement messages

To add images to replacement messages in the GUI:
  1. Go to System > Replacement Messages.
  2. Click Manage Images at the top of the page.
  3. Click Create New.
  4. Enter a name for the image.
  5. Click Upload Image and locate the file.

  6. Click OK.

To add images to replacement messages in the CLI:
config system replacemsg-image
    edit <image_name>
        set image-type {gif | jpg | tiff | png}
        set image-base64 <string>
    next
end

Modifying replacement messages

Replacement messages can be modified to include an HTML message or content that suits your organization. A list of common replacement messages appear in the main window. Select Extended View to see the entire list and all categories for replacement messages.

To modify a replacement message in the GUI:
  1. Go to System > Replacement Messages.
  2. Select the replacement message you want to edit.
  3. In the bottom pane of the GUI the message will be displayed on the left alongside the HTML code on the right. Edit the HTML code as needed.

    The message view changes in real-time as you edit the content.

  4. Click Save.
To modify a replacement message in the CLI:
config system replacemsg <message_category> <message_type>
    set buffer <string>
    set header {none | http | 8bit}
    set format {none | text | html}
end

For example, to modify the Traffic Quota Limit Exceeded Page message:

config system replacemsg traffic-quota "per-ip-shaper-block"
    set buffer "<html>
  <head>
    <title>
      Traffic Quota Control
    </title>
  </head>
  <body>
    <font size=2>
      <table width=\"100%\">
        <tr>
          <td bgcolor=#3300cc align=\"center\" colspan=2>
            <font color=#ffffff>
              <b>
                Traffic blocked because exceeded session quota
              </b>
            </font>
          </td>
        </tr>
      </table>
      <br>
      <br>
      Traffic blocked because it exceeded the per IP shaper session quota. Please contact the system administrator.
      <br>
      %%QUOTA_INFO%%
      <br>
      <br>
      <hr>
    </font>
  </body>
</html>"
    set header http
    set format html
end