Fortinet white logo
Fortinet white logo

CLI Reference

FortiOS CLI reference

FortiOS CLI reference

This document describes FortiOS 6.4.11 CLI commands used to configure and manage a FortiGate unit from the command line interface (CLI). For information on using the CLI, see the FortiOS 6.4.11 Administration Guide, which contains information such as:

Creation of the CLI reference

The CLI syntax is created by processing the schema from FortiGate models running FortiOS 6.4.11 and reformatting the resultant CLI output. The following reference models were used to create this CLI reference:

  • FGT_80E_POE: a POE model with 12x PoE ports and 16x GE RJ45 ports. No log disk.
  • FWF_61E: a WiFi/desktop model with SSD storage, FortiSoC3, Wireless (802.11a/b/g/n/ac) and 10x GE RJ45 ports.
  • FGT_501E: a mid-range model with 2x 240GB SSD storage, NP6 and CP9 acceleration, 2x 10GE SFP+ slots, 8x GE SFP slots and 10x GE RJ45 ports.
  • FGT_3000D: a high-end model with 480GB SSD storage, NP6 and CP8 acceleration, dyak AC power supplies, 16x 10GE SFP+ slots and 2x GE RJ45 management ports.
  • FGT_VM64: a Virtual Machine model running on VMware ESXi.

If you have comments on this content, its format, or requests for commands that are not included, contact us at techdoc@fortinet.com.

Availability of commands and options

Some FortiOS CLI commands and options are not available on all FortiGate units. The CLI displays an error message if you attempt to enter a command or option that is not available. You can use the question mark ‘?’ to verify the commands and options that are available.

Commands and options may not be available for the following reasons:

FortiGate model

All commands are not available on all FortiGate models. For example, a hardware switch can be configured only on models which have the corresponding hardware switch chipset.

Hardware configuration

For example, settings like mediatype would only be available on units with SFPs.

FortiOS Carrier, FortiGate 5K/6K/7K, FortiGate with LTE, etc.

Commands for extended functionality are not available on all FortiGate models. The CLI Reference may not include all commands.

Command tree

Enter tree to display the entire FortiOS CLI command tree. To capture the full output, connect to your device using a terminal emulation program, such as PuTTY, and capture the output to a log file.

  • To view all available commands, enter tree.

  • To view a specific configuration branch of a tree, enter tree <branch>, for example: tree system.

  • To view all available diagnose commands, enter tree diagnose.

  • To view all available execute commands, enter tree execute.

FortiOS CLI reference

FortiOS CLI reference

This document describes FortiOS 6.4.11 CLI commands used to configure and manage a FortiGate unit from the command line interface (CLI). For information on using the CLI, see the FortiOS 6.4.11 Administration Guide, which contains information such as:

Creation of the CLI reference

The CLI syntax is created by processing the schema from FortiGate models running FortiOS 6.4.11 and reformatting the resultant CLI output. The following reference models were used to create this CLI reference:

  • FGT_80E_POE: a POE model with 12x PoE ports and 16x GE RJ45 ports. No log disk.
  • FWF_61E: a WiFi/desktop model with SSD storage, FortiSoC3, Wireless (802.11a/b/g/n/ac) and 10x GE RJ45 ports.
  • FGT_501E: a mid-range model with 2x 240GB SSD storage, NP6 and CP9 acceleration, 2x 10GE SFP+ slots, 8x GE SFP slots and 10x GE RJ45 ports.
  • FGT_3000D: a high-end model with 480GB SSD storage, NP6 and CP8 acceleration, dyak AC power supplies, 16x 10GE SFP+ slots and 2x GE RJ45 management ports.
  • FGT_VM64: a Virtual Machine model running on VMware ESXi.

If you have comments on this content, its format, or requests for commands that are not included, contact us at techdoc@fortinet.com.

Availability of commands and options

Some FortiOS CLI commands and options are not available on all FortiGate units. The CLI displays an error message if you attempt to enter a command or option that is not available. You can use the question mark ‘?’ to verify the commands and options that are available.

Commands and options may not be available for the following reasons:

FortiGate model

All commands are not available on all FortiGate models. For example, a hardware switch can be configured only on models which have the corresponding hardware switch chipset.

Hardware configuration

For example, settings like mediatype would only be available on units with SFPs.

FortiOS Carrier, FortiGate 5K/6K/7K, FortiGate with LTE, etc.

Commands for extended functionality are not available on all FortiGate models. The CLI Reference may not include all commands.

Command tree

Enter tree to display the entire FortiOS CLI command tree. To capture the full output, connect to your device using a terminal emulation program, such as PuTTY, and capture the output to a log file.

  • To view all available commands, enter tree.

  • To view a specific configuration branch of a tree, enter tree <branch>, for example: tree system.

  • To view all available diagnose commands, enter tree diagnose.

  • To view all available execute commands, enter tree execute.