Fortinet black logo

CLI Reference

FortiOS CLI reference

FortiOS CLI reference

This document describes FortiOS 7.2.4 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 7.2.4 Administration Guide, which contains information such as:

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

This document describes FortiOS 7.2.4 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 7.2.4 Administration Guide, which contains information such as:

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.