Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

debug

Use the following commands to debug the FortiAnalyzer.

debug application

Use these commands to view or set the debug levels for the FortiAnalyzer applications. All of the debug levels are 0 by default.

 

Syntax

diagnose debug application alertmail <integer>

diagnose debug application apiproxyd <integer>

diagnose debug application camctld <integer>

diagnose debug application camerad <integer>

diagnose debug application camnotifyd <integer>

diagnose debug application camproxyd <integer>

diagnose debug application camschedd <integer>

diagnose debug application clusterd <integer>

diagnose debug application connector <integer>

diagnose debug application curl <integer>

diagnose debug application discoverd <integer>

diagnose debug application dmapi <integer>

diagnose debug application dns <integer>

diagnose debug application dump

diagnose debug application execmd <integer>

diagnose debug application fazcfgd <integer>

diagnose debug application fazmaild <integer>

diagnose debug application faznotify <integer>

diagnose debug application fazsvcd <integer>

diagnose debug application fazwatchd <integer>

diagnose debug application fdssvrd <integer>

diagnose debug application fgdsvr <integer>

diagnose debug application fgdupd <integer>

diagnose debug application fgfmsd <integer> [deviceName]

diagnose debug application filefwd <integer>

diagnose debug application fileparsed <integer>

diagnose debug application fnbam <integer>

diagnose debug application fortilogd <integer>

diagnose debug application fortimanagerws <integer>

diagnose debug application fortimeter <integer>

diagnose debug application gui <integer>

diagnose debug application ha <integer>

diagnose debug application ipsec <integer>

diagnose debug application localmod <integer>

diagnose debug application log-aggregate <integer>

diagnose debug application logd <integer>

diagnose debug application log-fetchd <integer>

diagnose debug application logfiled <integer>

diagnose debug application logfwd <integer>

diagnose debug application lrm <integer>

diagnose debug application ntpd <integer>

diagnose debug application oftpd <integer> [<IP/deviceSerial/deviceName>]

diagnose debug application quotad <integer>

diagnose debug application rptchkd <integer>

diagnose debug application scansched <integer>

diagnose debug application scheduled <integer>

diagnose debug application snapd <integer>

diagnose debug application snmpd <integer>

diagnose debug application sql_dashboard_rpt <integer>

diagnose debug application sql-integration <integer>

diagnose debug application sqllogd <integer>

diagnose debug application sqlplugind <integer>

diagnose debug application sqlrptcached <integer>

diagnose debug application ssh <integer>

diagnose debug application sshd <integer>

diagnose debug application storaged <integer>

diagnose debug application syncsched <integer>

diagnose debug application uploadd <integer>

diagnose debug application vmd <integer>

Variable

Description

alertmail <integer>

Set the debug level of the alert email daemon.

apiproxyd <integer>

Set the debug level of the API proxy daemon.

camctld <integer>

Set the debug level of the camera control daemon.

camerad <integer>

Set the debug level of the camera daemon.

camnotifyd <integer>

Set the debug level of the camnotify daemon.

camproxyd <integer>

Set the debug level of the camera proxy daemon.

camschedd <integer>

Set the debug level of the camera scheduler daemon.

clusterd <integer>

Set the debug level of the clusterd daemon.

connector <integer>

Set the debug level of the connector daemon.

curl <integer>

This command is not in use.

discoverd <integer>

Set the debug level of the camera discovery daemon.

dmapi <integer>

Set the debug level of the dmapi daemon.

dns <integer>

Set the debug level of DNS daemon.

dump

Dump services.

execmd <integer>

Set the debug level of the execmd daemon.

fazcfgd <integer>

Set the debug level of the fazcfgd daemon.

fazmaild <integer>

Set the debug level of the fazmaild daemon.

faznotify <integer>

Set the debug level of the faznotify daemon.

fazsvcd <integer>

Set the debug level of the FAZ server daemon.

fazwatchd <integer>

Set the debug level of the fazwatchd daemon.

fdssvrd <integer>

Set the debug level of the FDS server daemon.

fgdsvr <integer>

Set the debug level of the FortiGuard query daemon.

fgdupd <integer>

Set the debug level of the FortiGuard update daemon.

fgfmsd <integer> [deviceName]

Set the debug level of FGFM daemon. Enter a device name to only show messages related to that device.

filefwd <integer>

Set the debug level of the filefwd daemon.

fileparsed <integer>

Set the debug level of the fileparsed daemon.

fnbam <integer>

Set the debug level of the Fortinet authentication module.

fortilogd <integer>

Set the debug level of the fortilogd daemon.

fortimanagerws <integer>

Set the debug level of the FortiAnalyzer Web Service.

fortimeter <integer>

Set the debug level of the FortiMeter daemon.

gui <integer>

Set the debug level of the GUI.

ha <integer>

Set the debug level of HA.

ipsec <integer>

Set the debug level of the IPsec daemon.

localmod <integer>

Set the debug level of the localmod daemon.

log-aggregate <integer>

Set the debug level of the log aggregate daemon.

logd <integer>

Set the debug level of the log daemon.

log-fetchd <integer>

Set the debug level of the log fetcher daemon.

logfiled <integer>

Set the debug level of the logfilled daemon.

logfwd <integer>

Set the debug level of the logfwd daemon.

lrm <integer>

Set the debug level of the Log and Report Manager.

ntpd <integer>

Set the debug level of the Network Time Protocol (NTP) daemon.

oftpd <integer> [<IP/deviceSerial/deviceName>]

Set the debug level of the oftpd daemon. Enter an IPv4 address, device serial number, or device name to only show messages related to that device or IPv4 address.

quotad <integer>

Set the debug level of the quota daemon.

rptchkd <integer>

Set the debug level of the rptchkd daemon.

scansched <integer>

Set the debug level of the scan schedule daemon.

scheduled <integer>

Set the debug level of the schedule task daemon.

snapd <integer>

Set the debug level of the snapshot daemon.

snmpd <integer>

Set the debug level of the SNMP daemon.

sql_dashboard_rpt <integer>

Set the debug level of the SQL dashboard report daemon.

sql-integration <integer>

Set the debug level of SQL applications.

sqllogd <integer>

Set the debug level of SQL log daemon.

sqlplugind <integer>

Set the debug level of the SQL plugin daemon.

sqlrptcached <integer>

Set the debug level of the SQL report caching daemon.

ssh <integer>

Set the debug level of SSH protocol transactions.

sshd <integer>

Set the debug level of the SSH daemon.

storaged <integer>

Set the debug level of communication with java clients.

syncsched <integer>

Set the debug level of the syncsched daemon.

uploadd <integer>

Set the debug level of the upload daemon.

vmtools <integer>

Set the debug level for vmd.

Example

This example shows how to set the debug level to 7 for the upload daemon:

diagnose debug application uploadd 7

debug backup-oldformat-script-logs

Use this command to backup script log files that failed to be upgraded to the FTP server.

Syntax

diagnose debug backup-oldformat-script-logs <ip> <string> <username> <password>

Variable

Description

<ip>

Enter the FTP server IP address.

<string>

Enter the path/filename to save the log to the FTP server.

<username>

Enter the user name on the FTP server.

<password>

Enter the password associated with the user name.

debug cli

Use this command to set the debug level of CLI.

Syntax

diagnose debug cli <integer>

Variable

Description

<integer>

Set the debug level of the CLI (0 - 8, default = 3).

debug console

Use this command to enable or disable console debugging.

Syntax

diagnose debug console {enable | disable}

Variable

Description

{enable | disable}

Enable/disable console debugging.

debug coredump

Use this command to manage daemon and process core dumps.

Syntax

diagnose debug coredump crash-pid <pid>

diagnose debug coredump delete <daemon>

diagnose debug coredump disable <daemon>

diagnose debug coredump disable-pid <pid>

diagnose debug coredump enable <daemon>

diagnose debug coredump enable-once <daemon>

diagnose debug coredump enable-pid <pid>

diagnose debug coredump list

diagnose debug coredump upload <daemon> <service> <ip> <username> <password> <directory>

Variable

Description

crash-pid <pid>

Crash running process for core dump.

delete <daemon>

Delete core dumps for a daemon.

disable <daemon>

Disable core dump for a daemon.

disable-pid <pid>

Disable core dump of running process.

enable <daemon>

Enable core dump for a daemon.

enable-once <daemon>

Enable core dump the next time a daemon starts (one time only).

enable-pid <pid>

Enable core dump of running process.

list

List core dumps.

upload <daemon> <service> <ip> <username> <password> <directory>

Upload core dumps for a daemon to the specified server.

debug crashlog

Use this command to clear the debug crash log.

Syntax

diagnose debug crashlog clear

diagnose debug crashlog read

Variable

Description

clear

Clear the crash log.

read

Read the crash log.

debug disable

Use this command to disable debugging.

Syntax

diagnose debug disable

debug enable

Use this command to enable debugging.

Syntax

diagnose debug enable

debug info

Use this command to show active debug level settings.

Syntax

diagnose debug info

debug klog

Use this command to show all kernel logs.

Syntax

diagnose debug klog

debug library

Use this command to get or set the debug levels for FortiRecorder library settings.

Syntax

diagnose debug cambase <integer>

diagnose debug camctl <integer>

diagnose debug camnotify <integer>

diagnose debug flatfiledb <integer>

diagnose debug http <integer>

diagnose debug mediafile <integer>

diagnose debug mediaproc <integer>

diagnose debug mediaread <integer>

diagnose debug onvif <integer>

diagnose debug packetize <integer>

diagnose debug rtsp <integer>

diagnose debug sockio <integer>

Variable

Description

cambase <integer>

Set the debug level of the cambase library.

camctl <integer>

Set the debug level of the camctl library.

camnotify <integer>

Set the debug level of the camnotify library.

flatfiledb <integer>

Set the debug level of the flatfiledb library.

http <integer>

Set the debug level of the http library.

mediafile <integer>

Set the debug level of the mediafile library.

mediaproc <integer>

Set the debug level of the mediaproc library.

mediaread <integer>

Set the debug level of the mediaread library.

onvif <integer>

Set the debug level of the onvif library.

packetize <integer>

Set the debug level of the packetize library.

rtsp <integer>

Set the debug level of the rtsp library.

sockio <integer>

Set the debug level of the sockio library.

Example

This example shows the debug level of the camctl library:

diagnose debug library camctl

Values: 1 - non-PTZ, 2 - PTZ, 4 - Low-level error

camctl debug level: 0

debug reset

Use this command reset the debug level settings. All debug settings will be reset.

Syntax

diagnose debug reset

debug service

Use this command to view or set the debug level of various service daemons, and to dump the services.

Syntax

diagnose debug service anonymous <integer>

diagnose debug service cdb <integer>

diagnose debug service cmdb <integer>

diagnose debug service csf <integer>

diagnose debug service dbcache <integer>

diagnose debug service dvmcmd <integer>

diagnose debug service dvmdb <integer>

diagnose debug service dump

diagnose debug service fazcmd <integer>

diagnose debug service fazconf <integer>

diagnose debug service httpd <integer>

diagnose debug service main <integer>

diagnose debug service rpcauth <integer>

daignose debug service sys <integer>

diagnose debug service task <integer>

Variable

Description

<integer>

The debug level

dump

Dump the services.

The anonymous, dbcache, dump, fazcmd, and rpcauth commands are only available on hardware devices.

debug sysinfo

Use this command to show system information.

Syntax

diagnose debug sysinfo

debug sysinfo-log

Use this command to generate one system info log file every two minutes.

Syntax

diagnose debug sysinfo-log {on | off}

debug sysinfo-log-backup

Use this command to backup all sysinfo log files to an FTP server.

Syntax

diagnose debug sysinfo-log-backup <server> <filepath> <user> <password>

Variable

Description

<server>

Enter the FTP server IP address.

<filepath>

Enter the path/filename to save the log to the FTP server.

<user>

Enter the user name on the FTP server.

<password>

Enter the password associated with the user name.

debug sysinfo-log-list

Use this command to display system information elogs.

Syntax

diagnose debug sysinfo-log-list <integer>

Variable

Description

<integer>

Display the last n elogs (default = 10).

debug timestamp

Use this command to enable or disable debug timestamp.

Syntax

diagnose debug timestamp {enable | disable}

debug vminfo

Use this command to show VM license information.

This command is only available on FortiAnalyzer VM models.

Syntax

diagnose debug vminfo

debug

Use the following commands to debug the FortiAnalyzer.

debug application

Use these commands to view or set the debug levels for the FortiAnalyzer applications. All of the debug levels are 0 by default.

 

Syntax

diagnose debug application alertmail <integer>

diagnose debug application apiproxyd <integer>

diagnose debug application camctld <integer>

diagnose debug application camerad <integer>

diagnose debug application camnotifyd <integer>

diagnose debug application camproxyd <integer>

diagnose debug application camschedd <integer>

diagnose debug application clusterd <integer>

diagnose debug application connector <integer>

diagnose debug application curl <integer>

diagnose debug application discoverd <integer>

diagnose debug application dmapi <integer>

diagnose debug application dns <integer>

diagnose debug application dump

diagnose debug application execmd <integer>

diagnose debug application fazcfgd <integer>

diagnose debug application fazmaild <integer>

diagnose debug application faznotify <integer>

diagnose debug application fazsvcd <integer>

diagnose debug application fazwatchd <integer>

diagnose debug application fdssvrd <integer>

diagnose debug application fgdsvr <integer>

diagnose debug application fgdupd <integer>

diagnose debug application fgfmsd <integer> [deviceName]

diagnose debug application filefwd <integer>

diagnose debug application fileparsed <integer>

diagnose debug application fnbam <integer>

diagnose debug application fortilogd <integer>

diagnose debug application fortimanagerws <integer>

diagnose debug application fortimeter <integer>

diagnose debug application gui <integer>

diagnose debug application ha <integer>

diagnose debug application ipsec <integer>

diagnose debug application localmod <integer>

diagnose debug application log-aggregate <integer>

diagnose debug application logd <integer>

diagnose debug application log-fetchd <integer>

diagnose debug application logfiled <integer>

diagnose debug application logfwd <integer>

diagnose debug application lrm <integer>

diagnose debug application ntpd <integer>

diagnose debug application oftpd <integer> [<IP/deviceSerial/deviceName>]

diagnose debug application quotad <integer>

diagnose debug application rptchkd <integer>

diagnose debug application scansched <integer>

diagnose debug application scheduled <integer>

diagnose debug application snapd <integer>

diagnose debug application snmpd <integer>

diagnose debug application sql_dashboard_rpt <integer>

diagnose debug application sql-integration <integer>

diagnose debug application sqllogd <integer>

diagnose debug application sqlplugind <integer>

diagnose debug application sqlrptcached <integer>

diagnose debug application ssh <integer>

diagnose debug application sshd <integer>

diagnose debug application storaged <integer>

diagnose debug application syncsched <integer>

diagnose debug application uploadd <integer>

diagnose debug application vmd <integer>

Variable

Description

alertmail <integer>

Set the debug level of the alert email daemon.

apiproxyd <integer>

Set the debug level of the API proxy daemon.

camctld <integer>

Set the debug level of the camera control daemon.

camerad <integer>

Set the debug level of the camera daemon.

camnotifyd <integer>

Set the debug level of the camnotify daemon.

camproxyd <integer>

Set the debug level of the camera proxy daemon.

camschedd <integer>

Set the debug level of the camera scheduler daemon.

clusterd <integer>

Set the debug level of the clusterd daemon.

connector <integer>

Set the debug level of the connector daemon.

curl <integer>

This command is not in use.

discoverd <integer>

Set the debug level of the camera discovery daemon.

dmapi <integer>

Set the debug level of the dmapi daemon.

dns <integer>

Set the debug level of DNS daemon.

dump

Dump services.

execmd <integer>

Set the debug level of the execmd daemon.

fazcfgd <integer>

Set the debug level of the fazcfgd daemon.

fazmaild <integer>

Set the debug level of the fazmaild daemon.

faznotify <integer>

Set the debug level of the faznotify daemon.

fazsvcd <integer>

Set the debug level of the FAZ server daemon.

fazwatchd <integer>

Set the debug level of the fazwatchd daemon.

fdssvrd <integer>

Set the debug level of the FDS server daemon.

fgdsvr <integer>

Set the debug level of the FortiGuard query daemon.

fgdupd <integer>

Set the debug level of the FortiGuard update daemon.

fgfmsd <integer> [deviceName]

Set the debug level of FGFM daemon. Enter a device name to only show messages related to that device.

filefwd <integer>

Set the debug level of the filefwd daemon.

fileparsed <integer>

Set the debug level of the fileparsed daemon.

fnbam <integer>

Set the debug level of the Fortinet authentication module.

fortilogd <integer>

Set the debug level of the fortilogd daemon.

fortimanagerws <integer>

Set the debug level of the FortiAnalyzer Web Service.

fortimeter <integer>

Set the debug level of the FortiMeter daemon.

gui <integer>

Set the debug level of the GUI.

ha <integer>

Set the debug level of HA.

ipsec <integer>

Set the debug level of the IPsec daemon.

localmod <integer>

Set the debug level of the localmod daemon.

log-aggregate <integer>

Set the debug level of the log aggregate daemon.

logd <integer>

Set the debug level of the log daemon.

log-fetchd <integer>

Set the debug level of the log fetcher daemon.

logfiled <integer>

Set the debug level of the logfilled daemon.

logfwd <integer>

Set the debug level of the logfwd daemon.

lrm <integer>

Set the debug level of the Log and Report Manager.

ntpd <integer>

Set the debug level of the Network Time Protocol (NTP) daemon.

oftpd <integer> [<IP/deviceSerial/deviceName>]

Set the debug level of the oftpd daemon. Enter an IPv4 address, device serial number, or device name to only show messages related to that device or IPv4 address.

quotad <integer>

Set the debug level of the quota daemon.

rptchkd <integer>

Set the debug level of the rptchkd daemon.

scansched <integer>

Set the debug level of the scan schedule daemon.

scheduled <integer>

Set the debug level of the schedule task daemon.

snapd <integer>

Set the debug level of the snapshot daemon.

snmpd <integer>

Set the debug level of the SNMP daemon.

sql_dashboard_rpt <integer>

Set the debug level of the SQL dashboard report daemon.

sql-integration <integer>

Set the debug level of SQL applications.

sqllogd <integer>

Set the debug level of SQL log daemon.

sqlplugind <integer>

Set the debug level of the SQL plugin daemon.

sqlrptcached <integer>

Set the debug level of the SQL report caching daemon.

ssh <integer>

Set the debug level of SSH protocol transactions.

sshd <integer>

Set the debug level of the SSH daemon.

storaged <integer>

Set the debug level of communication with java clients.

syncsched <integer>

Set the debug level of the syncsched daemon.

uploadd <integer>

Set the debug level of the upload daemon.

vmtools <integer>

Set the debug level for vmd.

Example

This example shows how to set the debug level to 7 for the upload daemon:

diagnose debug application uploadd 7

debug backup-oldformat-script-logs

Use this command to backup script log files that failed to be upgraded to the FTP server.

Syntax

diagnose debug backup-oldformat-script-logs <ip> <string> <username> <password>

Variable

Description

<ip>

Enter the FTP server IP address.

<string>

Enter the path/filename to save the log to the FTP server.

<username>

Enter the user name on the FTP server.

<password>

Enter the password associated with the user name.

debug cli

Use this command to set the debug level of CLI.

Syntax

diagnose debug cli <integer>

Variable

Description

<integer>

Set the debug level of the CLI (0 - 8, default = 3).

debug console

Use this command to enable or disable console debugging.

Syntax

diagnose debug console {enable | disable}

Variable

Description

{enable | disable}

Enable/disable console debugging.

debug coredump

Use this command to manage daemon and process core dumps.

Syntax

diagnose debug coredump crash-pid <pid>

diagnose debug coredump delete <daemon>

diagnose debug coredump disable <daemon>

diagnose debug coredump disable-pid <pid>

diagnose debug coredump enable <daemon>

diagnose debug coredump enable-once <daemon>

diagnose debug coredump enable-pid <pid>

diagnose debug coredump list

diagnose debug coredump upload <daemon> <service> <ip> <username> <password> <directory>

Variable

Description

crash-pid <pid>

Crash running process for core dump.

delete <daemon>

Delete core dumps for a daemon.

disable <daemon>

Disable core dump for a daemon.

disable-pid <pid>

Disable core dump of running process.

enable <daemon>

Enable core dump for a daemon.

enable-once <daemon>

Enable core dump the next time a daemon starts (one time only).

enable-pid <pid>

Enable core dump of running process.

list

List core dumps.

upload <daemon> <service> <ip> <username> <password> <directory>

Upload core dumps for a daemon to the specified server.

debug crashlog

Use this command to clear the debug crash log.

Syntax

diagnose debug crashlog clear

diagnose debug crashlog read

Variable

Description

clear

Clear the crash log.

read

Read the crash log.

debug disable

Use this command to disable debugging.

Syntax

diagnose debug disable

debug enable

Use this command to enable debugging.

Syntax

diagnose debug enable

debug info

Use this command to show active debug level settings.

Syntax

diagnose debug info

debug klog

Use this command to show all kernel logs.

Syntax

diagnose debug klog

debug library

Use this command to get or set the debug levels for FortiRecorder library settings.

Syntax

diagnose debug cambase <integer>

diagnose debug camctl <integer>

diagnose debug camnotify <integer>

diagnose debug flatfiledb <integer>

diagnose debug http <integer>

diagnose debug mediafile <integer>

diagnose debug mediaproc <integer>

diagnose debug mediaread <integer>

diagnose debug onvif <integer>

diagnose debug packetize <integer>

diagnose debug rtsp <integer>

diagnose debug sockio <integer>

Variable

Description

cambase <integer>

Set the debug level of the cambase library.

camctl <integer>

Set the debug level of the camctl library.

camnotify <integer>

Set the debug level of the camnotify library.

flatfiledb <integer>

Set the debug level of the flatfiledb library.

http <integer>

Set the debug level of the http library.

mediafile <integer>

Set the debug level of the mediafile library.

mediaproc <integer>

Set the debug level of the mediaproc library.

mediaread <integer>

Set the debug level of the mediaread library.

onvif <integer>

Set the debug level of the onvif library.

packetize <integer>

Set the debug level of the packetize library.

rtsp <integer>

Set the debug level of the rtsp library.

sockio <integer>

Set the debug level of the sockio library.

Example

This example shows the debug level of the camctl library:

diagnose debug library camctl

Values: 1 - non-PTZ, 2 - PTZ, 4 - Low-level error

camctl debug level: 0

debug reset

Use this command reset the debug level settings. All debug settings will be reset.

Syntax

diagnose debug reset

debug service

Use this command to view or set the debug level of various service daemons, and to dump the services.

Syntax

diagnose debug service anonymous <integer>

diagnose debug service cdb <integer>

diagnose debug service cmdb <integer>

diagnose debug service csf <integer>

diagnose debug service dbcache <integer>

diagnose debug service dvmcmd <integer>

diagnose debug service dvmdb <integer>

diagnose debug service dump

diagnose debug service fazcmd <integer>

diagnose debug service fazconf <integer>

diagnose debug service httpd <integer>

diagnose debug service main <integer>

diagnose debug service rpcauth <integer>

daignose debug service sys <integer>

diagnose debug service task <integer>

Variable

Description

<integer>

The debug level

dump

Dump the services.

The anonymous, dbcache, dump, fazcmd, and rpcauth commands are only available on hardware devices.

debug sysinfo

Use this command to show system information.

Syntax

diagnose debug sysinfo

debug sysinfo-log

Use this command to generate one system info log file every two minutes.

Syntax

diagnose debug sysinfo-log {on | off}

debug sysinfo-log-backup

Use this command to backup all sysinfo log files to an FTP server.

Syntax

diagnose debug sysinfo-log-backup <server> <filepath> <user> <password>

Variable

Description

<server>

Enter the FTP server IP address.

<filepath>

Enter the path/filename to save the log to the FTP server.

<user>

Enter the user name on the FTP server.

<password>

Enter the password associated with the user name.

debug sysinfo-log-list

Use this command to display system information elogs.

Syntax

diagnose debug sysinfo-log-list <integer>

Variable

Description

<integer>

Display the last n elogs (default = 10).

debug timestamp

Use this command to enable or disable debug timestamp.

Syntax

diagnose debug timestamp {enable | disable}

debug vminfo

Use this command to show VM license information.

This command is only available on FortiAnalyzer VM models.

Syntax

diagnose debug vminfo