Fortinet black logo

CLI Reference

Conventions

Conventions

This document uses the conventions described in this section.

IP addresses

To avoid IP conflicts that would occur if you used examples in this document with public IP addresses that belong to a real organization, the IP addresses used in this document are fictional. They belong to the private IP address ranges defined by these RFCs.

RFC 1918: Address Allocation for Private Internets

https://tools.ietf.org/html/rfc1918

RFC 5737: IPv4 Address Blocks Reserved for Documentation

https://tools.ietf.org/html/rfc5737

RFC 3849: IPv6 Address Prefix Reserved for Documentation

https://tools.ietf.org/html/rfc3849

For example, even though a real network’s Internet-facing IP address would be routable on the public Internet, in this document’s examples, the IP address would be shown as a non-Internet-routable IP such as 192.0.2.108, 198.51.100.155, or 203.0.113.79.

Cautions, notes, & tips

This document uses the following guidance and styles for notes, tips and cautions.

Warn you about procedures or feature behaviors that could have unexpected or undesirable results including loss of data or damage to equipment.
Highlight important, possibly unexpected but non-destructive, details about a feature’s behavior.
Present best practices, troubleshooting, performance tips, or alternative methods.

Typographic conventions

Convention Example
Button, menu, text box, field, or check box label

From Minimum log level, select Notification.

CLI input

config system dns

set primary <address_ipv4>

end

CLI output

FortiWeb# diagnose hardware logdisk info

disk number: 1

disk[0] size: 31.46GB

raid level: no raid exists

partition number: 1

mount status: read-write

Emphasis

HTTP connections are not secure and can be intercepted by a third party.

File content

<HTML><HEAD><TITLE>Firewall Authentication</TITLE></HEAD>
<BODY><H4>You must authenticate to use this service.</H4>

Hyperlink

https://support.fortinet.com

Keyboard entry

Enter a name for the remote VPN peer or client, such as Central_Office_1.

Navigation

Go to VPN > IPSEC > Auto Key (IKE).

Publication

For details, see the FortiWeb Administration Guide: https://docs.fortinet.com/fortiweb/admin-guides.

Command syntax

The CLI requires that you use valid syntax, and conform to expected input constraints. It will reject invalid commands.

For command syntax conventions such as braces, brackets, and command constraints such as <address_ipv4>, see Notation.

Conventions

Conventions

This document uses the conventions described in this section.

IP addresses

To avoid IP conflicts that would occur if you used examples in this document with public IP addresses that belong to a real organization, the IP addresses used in this document are fictional. They belong to the private IP address ranges defined by these RFCs.

RFC 1918: Address Allocation for Private Internets

https://tools.ietf.org/html/rfc1918

RFC 5737: IPv4 Address Blocks Reserved for Documentation

https://tools.ietf.org/html/rfc5737

RFC 3849: IPv6 Address Prefix Reserved for Documentation

https://tools.ietf.org/html/rfc3849

For example, even though a real network’s Internet-facing IP address would be routable on the public Internet, in this document’s examples, the IP address would be shown as a non-Internet-routable IP such as 192.0.2.108, 198.51.100.155, or 203.0.113.79.

Cautions, notes, & tips

This document uses the following guidance and styles for notes, tips and cautions.

Warn you about procedures or feature behaviors that could have unexpected or undesirable results including loss of data or damage to equipment.
Highlight important, possibly unexpected but non-destructive, details about a feature’s behavior.
Present best practices, troubleshooting, performance tips, or alternative methods.

Typographic conventions

Convention Example
Button, menu, text box, field, or check box label

From Minimum log level, select Notification.

CLI input

config system dns

set primary <address_ipv4>

end

CLI output

FortiWeb# diagnose hardware logdisk info

disk number: 1

disk[0] size: 31.46GB

raid level: no raid exists

partition number: 1

mount status: read-write

Emphasis

HTTP connections are not secure and can be intercepted by a third party.

File content

<HTML><HEAD><TITLE>Firewall Authentication</TITLE></HEAD>
<BODY><H4>You must authenticate to use this service.</H4>

Hyperlink

https://support.fortinet.com

Keyboard entry

Enter a name for the remote VPN peer or client, such as Central_Office_1.

Navigation

Go to VPN > IPSEC > Auto Key (IKE).

Publication

For details, see the FortiWeb Administration Guide: https://docs.fortinet.com/fortiweb/admin-guides.

Command syntax

The CLI requires that you use valid syntax, and conform to expected input constraints. It will reject invalid commands.

For command syntax conventions such as braces, brackets, and command constraints such as <address_ipv4>, see Notation.