Fortimail CLI Reference
Total Page:16
File Type:pdf, Size:1020Kb
FortiMail - CLI Reference Version 7.0.1 FORTINET DOCUMENT LIBRARY https://docs.fortinet.com FORTINET VIDEO GUIDE https://video.fortinet.com FORTINET BLOG https://blog.fortinet.com CUSTOMER SERVICE & SUPPORT https://support.fortinet.com FORTINET TRAINING & CERTIFICATION PROGRAM https://www.fortinet.com/support-and-training/training.html NSE INSTITUTE https://training.fortinet.com FORTIGUARD CENTER https://fortiguard.com/ END USER LICENSE AGREEMENT https://www.fortinet.com/doc/legal/EULA.pdf FEEDBACK Email: [email protected] September 8, 2021 FortiMail 7.0.1 CLI Reference 06-701-658582-20210908 TABLE OF CONTENTS Change Log 16 Using the CLI 17 Connecting to the CLI 17 Local console connection and initial configuration 18 Enabling access to the CLI through the network (SSH or Telnet) 20 Connecting to the CLI using SSH 21 Connecting to the CLI using Telnet 22 Logging out from the CLI console 23 Command syntax 23 Terminology 23 Indentation 25 Notation 25 Sub-commands 27 Permissions 31 Tips and tricks 36 Help 36 Shortcuts and key commands 36 Command abbreviation 37 Environment variables 37 Special characters 38 Language support 38 Screen paging 39 Baud rate 39 Editing the configuration file on an external host 40 config 41 antispam adult-image-analysis 42 Syntax 43 antispam behavior-analysis 43 Syntax 43 Related topics 43 antispam bounce-verification 44 Syntax 44 Related topics 44 antispam deepheader-analysis 44 Syntax 44 Related topics 45 antispam dmarc-report 45 Syntax 45 antispam endpoint reputation blocklist 46 Syntax 46 Related topics 46 antispam endpoint reputation exempt 47 Syntax 47 Related topics 47 FortiMail 7.0.1 CLI Reference 3 Fortinet Technologies Inc. antispam greylist exempt 47 Syntax 47 Related topics 48 antispam quarantine-report 48 Syntax 49 Related topics 49 antispam settings 50 Syntax 50 Related topics 59 antispam trusted 59 Syntax 60 Related topics 60 antispam url-fgas-exempt-list 60 Syntax 60 archive account 61 Syntax 61 Related topics 63 archive exempt-policy 63 Syntax 63 Related topics 64 archive journal 64 Syntax 64 archive policy 65 Syntax 65 Related topics 66 customized-message 66 Syntax 66 Related topics 69 alert-email 69 as-sender-rate-notify 69 attachment-filtering-notify 70 content-disarm-reconstruct 71 custom-webmail-login 72 disclaimer-insertion 72 email-template-av-repack 73 email-template-notify-generic 74 ibe-login-page 75 ibe-notify-account-delete 75 ibe-notify-account-expiry 76 ibe-notify-account-expiry-alert 77 ibe-notify-account-lock 78 ibe-notify-account-reset 78 ibe-notify-account-reset-done 79 ibe-notify-activation 80 ibe-notify-config-change 81 ibe-notify-password-reset 82 ibe-notify-password-reset-done 82 ibe-notify-pull-message 83 FortiMail 7.0.1 CLI Reference 4 Fortinet Technologies Inc. ibe-notify-push-message 84 ibe-notify-user-register-done 85 ibe-notify-wread-notif 86 ibe-notify-wunread-rcpt 86 ibe-notify-wunread-sender 87 ibe-password-reset-page 88 ibe-register-page 89 ibe-tfa-email-verify 89 ibe-tfa-register-page 90 ibe-tfa-sms-verify 91 log-report 91 login-disclaimer 92 reject-content-attachment 93 reject-content-message 93 reject-delivery 94 reject-endpoint-reputation 94 reject-spam 95 reject-virus-message 96 reject-virus-suspicious 96 replace-content-attachment 97 replace-content-body 98 replace-content-subject 98 replace-dlp-body 99 replace-dlp-subject 100 replace-virus-message 100 replace-virus-suspicious 101 report-active-mailbox-summary 102 report-quarantine-summary 102 uri-protection-allow-with-confirmation 103 uri-protection-block 104 uri-protection-remove 104 uri-protection-uri-evaluation 105 dlp scan-rules 106 Syntax 106 domain 107 Syntax 107 config cal resource 108 config customized-message 109 config domain-setting 109 config policy recipient 122 config profile account-sync 126 config user mail 128 domain-association 129 Syntax 129 Related topics 130 file content-disarm-reconstruct 130 Syntax 130 file decryption password 131 Syntax 131 FortiMail 7.0.1 CLI Reference 5 Fortinet Technologies Inc. file filter 131 Syntax 132 file signature 132 Syntax 132 log setting remote 133 Syntax 133 Related topics 135 log setting local 136 Syntax 136 Related topics 138 log alertemail recipient 138 Syntax 138 Example 139 Related topics 139 log alertemail setting 139 Syntax 139 Related topics 140 mailsetting email-addr-handling 140 Syntax 141 mailsetting host-mapping 141 Syntax 141 Related topics 141 mailsetting mail-scan-options 142 Syntax 142 Related topics 142 mailsetting preference 143 Syntax 143 mailsetting proxy-smtp 144 Syntax 144 Related topics 146 mailsetting quarantine-rescan-options 146 Syntax 146 mailsetting relay-host-list 146 Syntax 147 Related topics 148 mailsetting sender-rewriting-scheme 148 Syntax 148 mailsetting smtp-rcpt-verification 149 Syntax 149 mailsetting storage central-ibe 149 Syntax 149 mailsetting storage central-quarantine 151 Syntax 151 Related topics 152 mailsetting storage config 152 Syntax 152 Related topics 154 FortiMail 7.0.1 CLI Reference 6 Fortinet Technologies Inc. mailsetting storage email-continuity 154 Syntax 154 mailsetting systemquarantine 154 Syntax 154 Related topics 155 ms365 account 156 Syntax 156 ms365 policy 156 Syntax 156 ms365 profile action 157 Syntax 157 ms365 profile antispam 158 ms365 profile antivirus 158 ms365 profile content 159 ms365 profile dlp 159 ms365 setting 159 Syntax 159 policy access-control receive 160 Syntax 160 Related topics 164 policy access-control delivery 164 Syntax 164 Related topics 166 policy delivery-control 166 Syntax 166 policy ip 167 Syntax 167 Related topics 170 policy recipient 170 Syntax 170 Related topics 173 profile access-control 173 Syntax 173 profile antispam 177 Syntax 177 Related topics 188 profile antispam-action 188 Syntax 188 Related topics 192 profile antivirus 192 Syntax 193 Related topics 195 profile antivirus-action 195 Syntax 195 Related topics 200 profile authentication 201 Syntax 201 FortiMail 7.0.1 CLI Reference 7 Fortinet Technologies Inc. Related topics 204 profile certificate-binding 204 Syntax 205 Related topics 205 profile content 205 Syntax 205 Related topics 213 profile content-action 213 Syntax 213 Related topics 217 profile cousin-domain 217 Syntax 218 profile dictionary 218 Syntax 218 Related topics 221 profile dictionary-group 221 Syntax 221 Related topics 221 profile dlp 222 Syntax 222 profile email-address-group 222 Syntax 222 Related topics 223 profile encryption 223 Syntax 223 Related topics 224 profile impersonation 224 Syntax 224 profile ip-address-group 225 Syntax 225 Related topics 226 profile ip-pool 226 Syntax 226 profile ldap 227 Syntax 227 Email address mapping 242 Related topics 243 profile notification 243 Syntax 244 profile resource 244 Syntax 244 profile session 246 Syntax 246 Related topics 260 profile tls 260 Syntax 260 Related topics 262 FortiMail 7.0.1 CLI Reference 8 Fortinet Technologies Inc. profile uri-filter 262 Syntax 262 report mail 262 Syntax 262 Related topics 265 report mailbox 265 Syntax 265 sensitive data 266 Syntax 266 system accprofile 268 Syntax 268 Related topics 270 system admin 270 Syntax 270 Related topics 272 system advanced-management 272 Syntax 272 Related topics 273 system appearance 273 Syntax 273 Related topics 274 system backup-restore-mail 274 Syntax 275 Related topics 276 system certificate ca 276 Syntax 277 Related topics 277 system certificate crl 277 Syntax 277 Related topics 277 system certificate local 278 Syntax 278 Related topics 278 system certificate remote 279 Syntax 279 Related topics 279 system csf 279 Syntax 279 system ddns 280 Syntax 280 Related topics 282 system disclaimer 282 Syntax 282 Related topics 283 system disclaimer-exclude 283 Syntax 284 Related topics 284 FortiMail 7.0.1 CLI Reference 9 Fortinet Technologies Inc. system dns 284 Syntax 284 Related topics 285 system domain-group 286 Syntax 286 Related topics 286 system encryption ibe 286 Syntax 286 Related topics 290 system encryption ibe-auth 290 Syntax 290 Related topics 290 system fortiguard antivirus 291 Syntax 291 Related topics 293 system fortiguard antispam 293 Syntax 293 Related topics 295 system fortisandbox 295 Syntax 295 system geoip-override 297 Syntax 297 system global 298 Syntax 298 Related topics 302 system ha 302 Syntax 302 Related topics 314 system interface 314 Syntax 314 Related topics 320 system link-monitor 320 Syntax 320 system mailserver 320 Syntax 321 Related topics 327 system password-policy 327 Syntax 327 Related topics 328 system port-forwarding 328 Syntax 329 system route 329 Syntax 329 Related topics 330 system saml 330 Syntax 330 system scheduled-backup 330 FortiMail 7.0.1 CLI Reference 10 Fortinet Technologies Inc. Syntax 330 system security crypto 330 Syntax 331 system security authserver 331 Syntax 331 system snmp community 332 Syntax 332 Related topics 332 system snmp sysinfo 333 Syntax 333 Related topics 333 system snmp threshold 333 Syntax 333 Related topics 334 system snmp user 334 Syntax 334 Related topics 336 system time manual 336 Syntax 337 Related topics 337 system time ntp 337 Syntax 337 Related topics 338 system wccp settings 338 Syntax 338 system webmail-language 339 Syntax 339 Related topics 339 user alias 339 Syntax 340 Related topics 340 user map 341 Syntax 342 Related topics 344 user pki 344 Syntax 345 Related topics 347 execute 348 backup 348 Syntax 349 Optionally encrypt backup content 350 Related topics 350 backup-restore 350 Syntax 350 Related topics 351 blocklist 352 Syntax 352 FortiMail 7.0.1 CLI Reference 11 Fortinet Technologies Inc. Related topics 352 certificate 353 Syntax 353 Related