Fortinet black logo

CLI Reference

fmupdate

fmupdate

Use these commands to diagnose update services.

Syntax

diagnose fmupdate check-disk-quota <export-import> <clean>

diagnose fmupdate dbcontract [<serial>]

diagnose fmupdate del-device {fct | fds | fgd | fgc} <serial> <uid>

diagnose fmupdate del-log

diagnose fmupdate del-object {fds | fct | fgd | fgc | fgd-fgfq} [<object_type>] [<object_version>]

diagnose fmupdate del-serverlist {fct | fds | fgd | fgc}

diagnose fmupdate fct-getobject

diagnose fmupdate fds-dump {breg | fds-log | fect | fmgi | immx | oblt | srul | subs}

diagnose fmupdate fds-get-downstream-device [<serial>]

diagnose fmupdate fds-getobject <filter type> <filter> <other options>

diagnose fmupdate fds-update-info

diagnose fmupdate fgd-asdevice-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d} {all | <serial>} <integer>

diagnose fmupdate fgd-asserver-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d}

diagnose fmupdate fgd-bandwidth {1h | 6h | 12h | 24h | 7d | 30d}

diagnose fmupdate fgd-dbver [{as1 | as2 | as4 | av-query | av2 | fq | geoip | iotm | iotr | iots | wf}]

diagnose fmupdate fgd-del-db {as | av-query | av2 | file-query | iot | wf}

diagnose fmupdate fgd-get-downstream-device

diagnose fmupdate fgd-test-client <ip> <serial> <string> <integer>

diagnose fmupdate fgd-url-rating <ip> <serial> <version> <url>

diagnose fmupdate fgd-wfas-clear-log

diagnose fmupdate fgd-wfas-log [{name | ip} {<name> | <ip addr>}]

diagnose fmupdate fgd-wfas-rate [{as_hash | as_ip | as_url | av | av2 | fq | wf}]

diagnose fmupdate fgd-wfdevice-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d} <serial> <integer>

diagnose fmupdate fgd-wfserver-stat {top10sites | top10devices} [{10m | 30m | 1h | 6h | 12h | 24h | 7d}]

diagnose fmupdate fgt-del-statistics

diagnose fmupdate fgt-del-um-db

diagnose fmupdate fmg-statistic-info

diagnose fmupdate fortitoken {seriallist | add | del} <serial>

diagnose fmupdate get-device {fct | fds | fgd | fgc} [<serial>]

diagnose fmupdate list-object {fds | fct | fgd | fgc | fgd-fqfq} [<object_type>] [<object_version>]

diagnose fmupdate priority-download {clear | list | view}

diagnose fmupdate service-restart {fds | fct | fgd | fgc | fmtr}

diagnose fmupdate show-bandwidth {fct | fgt | fml | faz} {1h | 6h | 12h | 24h | 7d | 30d}

diagnose fmupdate show-dev-obj [<serial>]

diagnose fmupdate update-status {fds | fct | fgd | fgc | fmtr}

diagnose fmupdate updatenow {fds | fgd | fct}

diagnose fmupdate view-configure {fds | fct | fgd | fgc | fmtr}

diagnose fmupdate view-linkd-log {fds | fct | fgd | fgc}

diagnose fmupdate view-serverlist {fds | fct | fgd | fgc | fmtr}

diagnose fmupdate view-service-info {fds | fgd}

diagnose fmupdate vm-license

Variables

Description

check-disk-quota <export-import> <clean>

Check the related directory size.

  • <export-import>: Directory for object export/import.
  • <clean>: Clean the directory if necessary.

dbcontract [<serial>]

Dump the subscriber contract.

del-device {fct | fds | fgd | fgc} <serial> <uid>

Delete a device. UID is required for FortiClient (fct) only.

del-log

Delete all the logs for FDS and FortiGuard update events.

del-object {fds | fct | fgd | fgc | fgd-fgfq} [<object_type>] [<object_version>]

Remove all objects from the specified service. Optionally, enter the object type and version or time.

del-serverlist {fct | fds | fgd | fgc}

Delete the server list file (fdni.dat) from the specified service.

fct-getobject

Get the versions of all FortiClient objects.

fds-dump {breg | fds-log | fect | fmgi | immx | oblt | srul | subs}

Dump FDS files:

  • breg: Dump the FDS beta serial numbers.
  • fds-log: Dump the FDS svrd log. Optionally, enter a rolling number from 0 to 10.
  • fect: Dump the FortiClient image file. Choose from the two available options of dumping the FortiClient file for the server or the client.
  • fmgi: Dump FMGI (Object description details) file.
  • immx: Dump the image upgrade matrix file. You can dump the IMMX files for FortiManager, FortiGate, or FortiCloud.
  • oblt: Dump the object list file. You can dump the object list files for FortiGate or FortiClient service.
  • srul: Dump the FDS select filtering rules.
  • subs: Dump Contract file.

fds-get-downstream-device [<serial>]

Get information of all downstream FortiGate antivirus-IPS devices. Optionally, enter the device serial number.

fds-getobject <filter type> <filter> <other options>

Get the versions of all FortiGate objects for antivirus-IPS.

  • <filter type>: Enter product or objid as the filter type.
  • <filter>: Enter an available filter. These filters are available only when you select product as your filter type. Enter all for all product filters.
  • <other options>: Enter used to show used-only objects or raw to show response in raw JSON format.

fds-update-info

Display scheduled update information.

fgd-asdevice-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d} {all | <serial>} <integer>

Display antispam device statistics for single or all devices.

  • <integer>: Number of time periods to display (optional, default = 1).

fgd-asserver-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d}

Display antispam server statistics.

fgd-bandwidth {1h | 6h | 12h | 24h | 7d | 30d}

Display the download bandwidth.

fgd-dbver [{as1 | as2 | as4 | av-query | av2 | fq | geoip | iotm | iotr | iots | wf}]

Get the version of the database. Optionally, enter the database type:

  • as1: Antispam (IP).

  • as2: Antispam (URL).

  • as4: Antispam (HASH).

  • av-query: AntiVirus Query.

  • av2: Outbreak Prevention.

  • fq: File Query.

  • geoip: GeoIP.

  • iotm: IoT (mapping).

  • iotr: IoT (range).

  • iots: IoT (single).

  • wf: Webfilter.

fgd-del-db {as | av-query | av2 | file-query | iot | wf}

Delete FortiGuard database. Enter the database type:

  • as: Antispam.

  • av-query: AntiVirus Query.

  • av2: Outbreak Prevention.

  • file-query: File Query.

  • iot: IoT

  • wf: Webfilter.

fgd-get-downstream-device

Get information on all downstream FortiGate web filter and spam devices.

fgd-test-client <ip> <serial> <string> <integer>

Execute FortiGuard test client.

  • <ip>: Enter the hostname or IP of the FortiGuard server.

  • <serial>: Enter the serial number of the device.

  • <string>: Enter the query number per second for stress test, or enter URL for a single query.

  • <integer>: Optionally, enter the category version (default = 7).

fgd-url-rating <ip> <serial> <version> <url>

Rate URLs within the FortiManager database using the FortiGate serial number. Optionally, enter the category version and URL.

fgd-wfas-clear-log

Clear the FortiGuard service log file.

fgd-wfas-log [{name | ip} {<name> | <ip addr>}]

View the FortiGuard service log file. Optionally, enter the device filter type, and device name or IPv4 address.

fgd-wfas-rate [{as_hash | as_ip | as_url | av | av2 | fq | wf}]

Get the web filter / antispam rating speed. Optionally, enter the server type:

  • as_hash: Antispam (HASH).

  • as_ip: Antispam (IP).

  • as_url: Antispam (URL).

  • av: AntiVirus.

  • av2: Outbreak Prevention.

  • fq: File Query.

  • wf: Webfilter.

fgd-wfdevice-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d} <serial> <integer>

Display web filter device statistics. Enter all or a specific device’s serial number. Optionally, enter the number of time periods to display (default = 1).

fgd-wfserver-stat {top10sites | top10devices} [{10m | 30m | 1h | 6h | 12h | 24h | 7d}]

Display web filter server statistics for the top 10 sites or devices. Optionally, enter the time frame to cover.

fgt-del-statistics

Remove all statistics (antivirus / IPS and web filter / antispam). This command requires a reboot.

fgt-del-um-db

Remove UM and UM-GUI databases. This command requires a reboot.

Note: um.db is a sqlite3 database that update manager uses internally. It will store AV/IPS package information of downloaded packages. This command removes the database file information. The package is not removed. After the reboot, the database will be recreated. Use this command if you suspect the database file is corrupted.

fmg-statistic-info

Display statistic information for FortiManager and Java Client.

fortitoken {seriallist | add | del} <serial>

FortiToken related operations.

get-device {fct | fds | fgd | fgc} [<serial>]

Get device information. Optionally, enter a serial number.

list-object {fds | fct | fgd | fgc | fgd-fqfq} [<object_type>] [<object_version>]

List downloaded objects of linkd service. Optionally, enter the object type and version or time.

priority-download {clear | list | view}

Command for priority download:

clear: view config.

list: list object id of list.

view: clear config.

service-restart {fds | fct | fgd | fgc | fmtr}

Restart the linkd service.

show-bandwidth {fct | fgt | fml | faz} {1h | 6h | 12h | 24h | 7d | 30d}

Display the download bandwidth for a device type over a specified time period.

show-dev-obj [<serial>]

Display an objects version of a device. Optionally, enter a serial number.

update-status {fds | fct | fgd | fgc | fmtr}

Display the update status.

updatenow {fds | fgd | fct}

Update immediately.

view-configure {fds | fct | fgd | fgc | fmtr}

Dump the running configuration.

view-linkd-log {fds | fct | fgd | fgc}

View the linkd log file.

view-serverlist {fds | fct | fgd | fgc | fmtr}

Dump the server list.

view-service-info {fds | fgd}

Display the service information.

vm-license

Dump the FortiGate VM license.

fmupdate

Use these commands to diagnose update services.

Syntax

diagnose fmupdate check-disk-quota <export-import> <clean>

diagnose fmupdate dbcontract [<serial>]

diagnose fmupdate del-device {fct | fds | fgd | fgc} <serial> <uid>

diagnose fmupdate del-log

diagnose fmupdate del-object {fds | fct | fgd | fgc | fgd-fgfq} [<object_type>] [<object_version>]

diagnose fmupdate del-serverlist {fct | fds | fgd | fgc}

diagnose fmupdate fct-getobject

diagnose fmupdate fds-dump {breg | fds-log | fect | fmgi | immx | oblt | srul | subs}

diagnose fmupdate fds-get-downstream-device [<serial>]

diagnose fmupdate fds-getobject <filter type> <filter> <other options>

diagnose fmupdate fds-update-info

diagnose fmupdate fgd-asdevice-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d} {all | <serial>} <integer>

diagnose fmupdate fgd-asserver-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d}

diagnose fmupdate fgd-bandwidth {1h | 6h | 12h | 24h | 7d | 30d}

diagnose fmupdate fgd-dbver [{as1 | as2 | as4 | av-query | av2 | fq | geoip | iotm | iotr | iots | wf}]

diagnose fmupdate fgd-del-db {as | av-query | av2 | file-query | iot | wf}

diagnose fmupdate fgd-get-downstream-device

diagnose fmupdate fgd-test-client <ip> <serial> <string> <integer>

diagnose fmupdate fgd-url-rating <ip> <serial> <version> <url>

diagnose fmupdate fgd-wfas-clear-log

diagnose fmupdate fgd-wfas-log [{name | ip} {<name> | <ip addr>}]

diagnose fmupdate fgd-wfas-rate [{as_hash | as_ip | as_url | av | av2 | fq | wf}]

diagnose fmupdate fgd-wfdevice-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d} <serial> <integer>

diagnose fmupdate fgd-wfserver-stat {top10sites | top10devices} [{10m | 30m | 1h | 6h | 12h | 24h | 7d}]

diagnose fmupdate fgt-del-statistics

diagnose fmupdate fgt-del-um-db

diagnose fmupdate fmg-statistic-info

diagnose fmupdate fortitoken {seriallist | add | del} <serial>

diagnose fmupdate get-device {fct | fds | fgd | fgc} [<serial>]

diagnose fmupdate list-object {fds | fct | fgd | fgc | fgd-fqfq} [<object_type>] [<object_version>]

diagnose fmupdate priority-download {clear | list | view}

diagnose fmupdate service-restart {fds | fct | fgd | fgc | fmtr}

diagnose fmupdate show-bandwidth {fct | fgt | fml | faz} {1h | 6h | 12h | 24h | 7d | 30d}

diagnose fmupdate show-dev-obj [<serial>]

diagnose fmupdate update-status {fds | fct | fgd | fgc | fmtr}

diagnose fmupdate updatenow {fds | fgd | fct}

diagnose fmupdate view-configure {fds | fct | fgd | fgc | fmtr}

diagnose fmupdate view-linkd-log {fds | fct | fgd | fgc}

diagnose fmupdate view-serverlist {fds | fct | fgd | fgc | fmtr}

diagnose fmupdate view-service-info {fds | fgd}

diagnose fmupdate vm-license

Variables

Description

check-disk-quota <export-import> <clean>

Check the related directory size.

  • <export-import>: Directory for object export/import.
  • <clean>: Clean the directory if necessary.

dbcontract [<serial>]

Dump the subscriber contract.

del-device {fct | fds | fgd | fgc} <serial> <uid>

Delete a device. UID is required for FortiClient (fct) only.

del-log

Delete all the logs for FDS and FortiGuard update events.

del-object {fds | fct | fgd | fgc | fgd-fgfq} [<object_type>] [<object_version>]

Remove all objects from the specified service. Optionally, enter the object type and version or time.

del-serverlist {fct | fds | fgd | fgc}

Delete the server list file (fdni.dat) from the specified service.

fct-getobject

Get the versions of all FortiClient objects.

fds-dump {breg | fds-log | fect | fmgi | immx | oblt | srul | subs}

Dump FDS files:

  • breg: Dump the FDS beta serial numbers.
  • fds-log: Dump the FDS svrd log. Optionally, enter a rolling number from 0 to 10.
  • fect: Dump the FortiClient image file. Choose from the two available options of dumping the FortiClient file for the server or the client.
  • fmgi: Dump FMGI (Object description details) file.
  • immx: Dump the image upgrade matrix file. You can dump the IMMX files for FortiManager, FortiGate, or FortiCloud.
  • oblt: Dump the object list file. You can dump the object list files for FortiGate or FortiClient service.
  • srul: Dump the FDS select filtering rules.
  • subs: Dump Contract file.

fds-get-downstream-device [<serial>]

Get information of all downstream FortiGate antivirus-IPS devices. Optionally, enter the device serial number.

fds-getobject <filter type> <filter> <other options>

Get the versions of all FortiGate objects for antivirus-IPS.

  • <filter type>: Enter product or objid as the filter type.
  • <filter>: Enter an available filter. These filters are available only when you select product as your filter type. Enter all for all product filters.
  • <other options>: Enter used to show used-only objects or raw to show response in raw JSON format.

fds-update-info

Display scheduled update information.

fgd-asdevice-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d} {all | <serial>} <integer>

Display antispam device statistics for single or all devices.

  • <integer>: Number of time periods to display (optional, default = 1).

fgd-asserver-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d}

Display antispam server statistics.

fgd-bandwidth {1h | 6h | 12h | 24h | 7d | 30d}

Display the download bandwidth.

fgd-dbver [{as1 | as2 | as4 | av-query | av2 | fq | geoip | iotm | iotr | iots | wf}]

Get the version of the database. Optionally, enter the database type:

  • as1: Antispam (IP).

  • as2: Antispam (URL).

  • as4: Antispam (HASH).

  • av-query: AntiVirus Query.

  • av2: Outbreak Prevention.

  • fq: File Query.

  • geoip: GeoIP.

  • iotm: IoT (mapping).

  • iotr: IoT (range).

  • iots: IoT (single).

  • wf: Webfilter.

fgd-del-db {as | av-query | av2 | file-query | iot | wf}

Delete FortiGuard database. Enter the database type:

  • as: Antispam.

  • av-query: AntiVirus Query.

  • av2: Outbreak Prevention.

  • file-query: File Query.

  • iot: IoT

  • wf: Webfilter.

fgd-get-downstream-device

Get information on all downstream FortiGate web filter and spam devices.

fgd-test-client <ip> <serial> <string> <integer>

Execute FortiGuard test client.

  • <ip>: Enter the hostname or IP of the FortiGuard server.

  • <serial>: Enter the serial number of the device.

  • <string>: Enter the query number per second for stress test, or enter URL for a single query.

  • <integer>: Optionally, enter the category version (default = 7).

fgd-url-rating <ip> <serial> <version> <url>

Rate URLs within the FortiManager database using the FortiGate serial number. Optionally, enter the category version and URL.

fgd-wfas-clear-log

Clear the FortiGuard service log file.

fgd-wfas-log [{name | ip} {<name> | <ip addr>}]

View the FortiGuard service log file. Optionally, enter the device filter type, and device name or IPv4 address.

fgd-wfas-rate [{as_hash | as_ip | as_url | av | av2 | fq | wf}]

Get the web filter / antispam rating speed. Optionally, enter the server type:

  • as_hash: Antispam (HASH).

  • as_ip: Antispam (IP).

  • as_url: Antispam (URL).

  • av: AntiVirus.

  • av2: Outbreak Prevention.

  • fq: File Query.

  • wf: Webfilter.

fgd-wfdevice-stat {10m | 30m | 1h | 6h | 12h | 24h | 7d} <serial> <integer>

Display web filter device statistics. Enter all or a specific device’s serial number. Optionally, enter the number of time periods to display (default = 1).

fgd-wfserver-stat {top10sites | top10devices} [{10m | 30m | 1h | 6h | 12h | 24h | 7d}]

Display web filter server statistics for the top 10 sites or devices. Optionally, enter the time frame to cover.

fgt-del-statistics

Remove all statistics (antivirus / IPS and web filter / antispam). This command requires a reboot.

fgt-del-um-db

Remove UM and UM-GUI databases. This command requires a reboot.

Note: um.db is a sqlite3 database that update manager uses internally. It will store AV/IPS package information of downloaded packages. This command removes the database file information. The package is not removed. After the reboot, the database will be recreated. Use this command if you suspect the database file is corrupted.

fmg-statistic-info

Display statistic information for FortiManager and Java Client.

fortitoken {seriallist | add | del} <serial>

FortiToken related operations.

get-device {fct | fds | fgd | fgc} [<serial>]

Get device information. Optionally, enter a serial number.

list-object {fds | fct | fgd | fgc | fgd-fqfq} [<object_type>] [<object_version>]

List downloaded objects of linkd service. Optionally, enter the object type and version or time.

priority-download {clear | list | view}

Command for priority download:

clear: view config.

list: list object id of list.

view: clear config.

service-restart {fds | fct | fgd | fgc | fmtr}

Restart the linkd service.

show-bandwidth {fct | fgt | fml | faz} {1h | 6h | 12h | 24h | 7d | 30d}

Display the download bandwidth for a device type over a specified time period.

show-dev-obj [<serial>]

Display an objects version of a device. Optionally, enter a serial number.

update-status {fds | fct | fgd | fgc | fmtr}

Display the update status.

updatenow {fds | fgd | fct}

Update immediately.

view-configure {fds | fct | fgd | fgc | fmtr}

Dump the running configuration.

view-linkd-log {fds | fct | fgd | fgc}

View the linkd log file.

view-serverlist {fds | fct | fgd | fgc | fmtr}

Dump the server list.

view-service-info {fds | fgd}

Display the service information.

vm-license

Dump the FortiGate VM license.