Fortinet white logo
Fortinet white logo

CLI Reference

config system replacemsg-group

config system replacemsg-group

Configure replacement message groups.

config system replacemsg-group
    Description: Configure replacement message groups.
    edit <name>
        config admin
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config alertmail
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config auth
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config automation
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        set comment {var-string}
        config custom-message
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        set fabric-force-sync [enable|disable]
        set fabric-object [enable|disable]
        set fabric-object-source [member|local|...]
        config fortiguard-wf
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config ftp
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        set group-type [default|utm|...]
        config http
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config icap
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config mail
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config nac-quar
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config spam
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config sslvpn
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config traffic-quota
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config utm
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        set uuid {uuid}
        config webproxy
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
    next
end

config system replacemsg-group

Parameter

Description

Type

Size

Default

comment

Comment.

var-string

Maximum length: 255

fabric-force-sync *

Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped.

option

-

disable

Option

Description

enable

Enable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

disable

Disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

fabric-object *

Security Fabric global object setting.

option

-

disable

Option

Description

enable

Object is set as a security fabric-wide global object.

disable

Object is local to this security fabric member.

fabric-object-source *

Source of truth for fabric object.

option

-

root

Option

Description

member

Source of truth for this object is a non-root member of fabric.

local

Source of truth for this object is this security fabric member.

root

Source of truth for this object is the root of the fabric.

group-type

Group type.

option

-

default

Option

Description

default

Per-vdom replacement messages.

utm

For use with UTM settings in firewall policies.

auth

For use with authentication pages in firewall policies.

name

Group name.

string

Maximum length: 35

uuid *

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

uuid

Not Specified

00000000-0000-0000-0000-000000000000

* This parameter may not exist in some models.

config admin

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config alertmail

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config auth

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config automation

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config custom-message

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config fortiguard-wf

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config ftp

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config http

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config icap

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config mail

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config nac-quar

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config spam

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config sslvpn

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config traffic-quota

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config utm

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config webproxy

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config system replacemsg-group

config system replacemsg-group

Configure replacement message groups.

config system replacemsg-group
    Description: Configure replacement message groups.
    edit <name>
        config admin
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config alertmail
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config auth
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config automation
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        set comment {var-string}
        config custom-message
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        set fabric-force-sync [enable|disable]
        set fabric-object [enable|disable]
        set fabric-object-source [member|local|...]
        config fortiguard-wf
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config ftp
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        set group-type [default|utm|...]
        config http
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config icap
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config mail
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config nac-quar
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config spam
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config sslvpn
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config traffic-quota
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        config utm
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
        set uuid {uuid}
        config webproxy
            Description: Replacement message table entries.
            edit <msg-type>
                set buffer {var-string}
                set format [none|text|...]
                set header [none|http|...]
            next
        end
    next
end

config system replacemsg-group

Parameter

Description

Type

Size

Default

comment

Comment.

var-string

Maximum length: 255

fabric-force-sync *

Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped.

option

-

disable

Option

Description

enable

Enable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

disable

Disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

fabric-object *

Security Fabric global object setting.

option

-

disable

Option

Description

enable

Object is set as a security fabric-wide global object.

disable

Object is local to this security fabric member.

fabric-object-source *

Source of truth for fabric object.

option

-

root

Option

Description

member

Source of truth for this object is a non-root member of fabric.

local

Source of truth for this object is this security fabric member.

root

Source of truth for this object is the root of the fabric.

group-type

Group type.

option

-

default

Option

Description

default

Per-vdom replacement messages.

utm

For use with UTM settings in firewall policies.

auth

For use with authentication pages in firewall policies.

name

Group name.

string

Maximum length: 35

uuid *

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

uuid

Not Specified

00000000-0000-0000-0000-000000000000

* This parameter may not exist in some models.

config admin

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config alertmail

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config auth

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config automation

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config custom-message

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config fortiguard-wf

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config ftp

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config http

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config icap

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config mail

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config nac-quar

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config spam

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config sslvpn

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config traffic-quota

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config utm

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28

config webproxy

Parameter

Description

Type

Size

Default

buffer

Message string.

var-string

Maximum length: 32768

format

Format flag.

option

-

none

Option

Description

none

No format type.

text

Text format.

html

HTML format.

header

Header flag.

option

-

none

Option

Description

none

No header type.

http

HTTP

8bit

8 bit.

msg-type

Message type.

string

Maximum length: 28