Fortinet white logo
Fortinet white logo

CLI Reference

config dlp sensor

config dlp sensor

Configure DLP sensors.

config dlp sensor
    Description: Configure DLP sensors.
    edit <name>
        set comment {var-string}
        set dlp-log [enable|disable]
        set extended-log [enable|disable]
        set feature-set [flow|proxy]
        config filter
            Description: Set up DLP filters for this sensor.
            edit <id>
                set name {string}
                set severity [info|low|...]
                set type [file|message]
                set proto {option1}, {option2}, ...
                set filter-by [credit-card|ssn|...]
                set file-size {integer}
                set company-identifier {string}
                set sensitivity <name1>, <name2>, ...
                set match-percentage {integer}
                set file-type {integer}
                set regexp {string}
                set archive [disable|enable]
                set action [allow|log-only|...]
                set expiry {user}
            next
        end
        set full-archive-proto {option1}, {option2}, ...
        set nac-quar-log [enable|disable]
        set replacemsg-group {string}
        set summary-proto {option1}, {option2}, ...
    next
end

config dlp sensor

Parameter

Description

Type

Size

Default

comment

Comment.

var-string

Maximum length: 255

dlp-log

Enable/disable DLP logging.

option

-

enable

Option

Description

enable

Enable DLP logging.

disable

Disable DLP logging.

extended-log

Enable/disable extended logging for data leak prevention.

option

-

disable

Option

Description

enable

Enable setting.

disable

Disable setting.

feature-set

Flow/proxy feature set.

option

-

flow

Option

Description

flow

Flow feature set.

proxy

Proxy feature set.

full-archive-proto

Protocols to always content archive.

option

-

Option

Description

smtp

SMTP.

pop3

POP3.

imap

IMAP.

http-get

HTTP GET.

http-post

HTTP POST.

ftp

FTP.

nntp

NNTP.

mapi

MAPI.

ssh

SFTP and SCP.

cifs

CIFS.

nac-quar-log

Enable/disable NAC quarantine logging.

option

-

disable

Option

Description

enable

Enable NAC quarantine logging.

disable

Disable NAC quarantine logging.

name

Name of the DLP sensor.

string

Maximum length: 35

replacemsg-group

Replacement message group used by this DLP sensor.

string

Maximum length: 35

summary-proto

Protocols to always log summary.

option

-

Option

Description

smtp

SMTP.

pop3

POP3.

imap

IMAP.

http-get

HTTP GET.

http-post

HTTP POST.

ftp

FTP.

nntp

NNTP.

mapi

MAPI.

ssh

SFTP and SCP.

cifs

CIFS.

config filter

Parameter

Description

Type

Size

Default

id

ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

name

Filter name.

string

Maximum length: 35

severity

Select the severity or threat level that matches this filter.

option

-

medium

Option

Description

info

Informational.

low

Low.

medium

Medium.

high

High.

critical

Critical.

type

Select whether to check the content of messages (an email message) or files (downloaded files or email attachments).

option

-

file

Option

Description

file

Check the contents of downloaded or attached files.

message

Check the contents of email messages, web pages, etc.

proto

Check messages or files over one or more of these protocols.

option

-

Option

Description

smtp

SMTP.

pop3

POP3.

imap

IMAP.

http-get

HTTP GET.

http-post

HTTP POST.

ftp

FTP.

nntp

NNTP.

mapi

MAPI.

ssh

SFTP and SCP.

cifs

CIFS.

filter-by

Select the type of content to match.

option

-

credit-card

Option

Description

credit-card

Match credit cards.

ssn

Match social security numbers.

regexp

Use a regular expression to match content.

file-type

Match a DLP file pattern list.

file-size

Match any file over with a size over the threshold.

fingerprint

Match against a fingerprint sensitivity.

watermark

Look for defined file watermarks.

encrypted

Look for encrypted files.

file-size

Match files this size or larger.

integer

Minimum value: 0 Maximum value: 4294967295

10 **

company-identifier

Enter a company identifier watermark to match. Only watermarks that your company has placed on the files are matched.

string

Maximum length: 35

sensitivity <name>

Select a DLP file pattern sensitivity to match.

Select a DLP sensitivity.

string

Maximum length: 35

match-percentage *

Percentage of fingerprints in the fingerprint databases designated with the selected sensitivity to match.

integer

Minimum value: 1 Maximum value: 100

10

file-type

Select the number of a DLP file pattern table to match.

integer

Minimum value: 0 Maximum value: 4294967295

0

regexp

Enter a regular expression to match (max. 255 characters).

string

Maximum length: 255

archive

Enable/disable DLP archiving.

option

-

disable

Option

Description

disable

No DLP archiving.

enable

Enable full DLP archiving.

action

Action to take with content that this DLP sensor matches.

option

-

allow

Option

Description

allow

Allow the content to pass through the FortiGate and do not create a log message.

log-only

Allow the content to pass through the FortiGate, but write a log message.

block

Block the content and write a log message.

quarantine-ip

Quarantine all traffic from the IP address and write a log message.

expiry

Quarantine duration in days, hours, minutes (format = dddhhmm).

user

Not Specified

5m

* This parameter may not exist in some models.

** Values may differ between models.

config dlp sensor

config dlp sensor

Configure DLP sensors.

config dlp sensor
    Description: Configure DLP sensors.
    edit <name>
        set comment {var-string}
        set dlp-log [enable|disable]
        set extended-log [enable|disable]
        set feature-set [flow|proxy]
        config filter
            Description: Set up DLP filters for this sensor.
            edit <id>
                set name {string}
                set severity [info|low|...]
                set type [file|message]
                set proto {option1}, {option2}, ...
                set filter-by [credit-card|ssn|...]
                set file-size {integer}
                set company-identifier {string}
                set sensitivity <name1>, <name2>, ...
                set match-percentage {integer}
                set file-type {integer}
                set regexp {string}
                set archive [disable|enable]
                set action [allow|log-only|...]
                set expiry {user}
            next
        end
        set full-archive-proto {option1}, {option2}, ...
        set nac-quar-log [enable|disable]
        set replacemsg-group {string}
        set summary-proto {option1}, {option2}, ...
    next
end

config dlp sensor

Parameter

Description

Type

Size

Default

comment

Comment.

var-string

Maximum length: 255

dlp-log

Enable/disable DLP logging.

option

-

enable

Option

Description

enable

Enable DLP logging.

disable

Disable DLP logging.

extended-log

Enable/disable extended logging for data leak prevention.

option

-

disable

Option

Description

enable

Enable setting.

disable

Disable setting.

feature-set

Flow/proxy feature set.

option

-

flow

Option

Description

flow

Flow feature set.

proxy

Proxy feature set.

full-archive-proto

Protocols to always content archive.

option

-

Option

Description

smtp

SMTP.

pop3

POP3.

imap

IMAP.

http-get

HTTP GET.

http-post

HTTP POST.

ftp

FTP.

nntp

NNTP.

mapi

MAPI.

ssh

SFTP and SCP.

cifs

CIFS.

nac-quar-log

Enable/disable NAC quarantine logging.

option

-

disable

Option

Description

enable

Enable NAC quarantine logging.

disable

Disable NAC quarantine logging.

name

Name of the DLP sensor.

string

Maximum length: 35

replacemsg-group

Replacement message group used by this DLP sensor.

string

Maximum length: 35

summary-proto

Protocols to always log summary.

option

-

Option

Description

smtp

SMTP.

pop3

POP3.

imap

IMAP.

http-get

HTTP GET.

http-post

HTTP POST.

ftp

FTP.

nntp

NNTP.

mapi

MAPI.

ssh

SFTP and SCP.

cifs

CIFS.

config filter

Parameter

Description

Type

Size

Default

id

ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

name

Filter name.

string

Maximum length: 35

severity

Select the severity or threat level that matches this filter.

option

-

medium

Option

Description

info

Informational.

low

Low.

medium

Medium.

high

High.

critical

Critical.

type

Select whether to check the content of messages (an email message) or files (downloaded files or email attachments).

option

-

file

Option

Description

file

Check the contents of downloaded or attached files.

message

Check the contents of email messages, web pages, etc.

proto

Check messages or files over one or more of these protocols.

option

-

Option

Description

smtp

SMTP.

pop3

POP3.

imap

IMAP.

http-get

HTTP GET.

http-post

HTTP POST.

ftp

FTP.

nntp

NNTP.

mapi

MAPI.

ssh

SFTP and SCP.

cifs

CIFS.

filter-by

Select the type of content to match.

option

-

credit-card

Option

Description

credit-card

Match credit cards.

ssn

Match social security numbers.

regexp

Use a regular expression to match content.

file-type

Match a DLP file pattern list.

file-size

Match any file over with a size over the threshold.

fingerprint

Match against a fingerprint sensitivity.

watermark

Look for defined file watermarks.

encrypted

Look for encrypted files.

file-size

Match files this size or larger.

integer

Minimum value: 0 Maximum value: 4294967295

10 **

company-identifier

Enter a company identifier watermark to match. Only watermarks that your company has placed on the files are matched.

string

Maximum length: 35

sensitivity <name>

Select a DLP file pattern sensitivity to match.

Select a DLP sensitivity.

string

Maximum length: 35

match-percentage *

Percentage of fingerprints in the fingerprint databases designated with the selected sensitivity to match.

integer

Minimum value: 1 Maximum value: 100

10

file-type

Select the number of a DLP file pattern table to match.

integer

Minimum value: 0 Maximum value: 4294967295

0

regexp

Enter a regular expression to match (max. 255 characters).

string

Maximum length: 255

archive

Enable/disable DLP archiving.

option

-

disable

Option

Description

disable

No DLP archiving.

enable

Enable full DLP archiving.

action

Action to take with content that this DLP sensor matches.

option

-

allow

Option

Description

allow

Allow the content to pass through the FortiGate and do not create a log message.

log-only

Allow the content to pass through the FortiGate, but write a log message.

block

Block the content and write a log message.

quarantine-ip

Quarantine all traffic from the IP address and write a log message.

expiry

Quarantine duration in days, hours, minutes (format = dddhhmm).

user

Not Specified

5m

* This parameter may not exist in some models.

** Values may differ between models.