Fortinet Document Library

Version:


Table of Contents

CLI Reference

5.3.0
Download PDF
Copy Link

Introduction

Welcome, and thank you for selecting Fortinet products for your network protection.

Scope

This document describes how to use the command-line interface (CLI) of the FortiADC appliance. It assumes that you have already successfully installed the FortiADC appliance and completed basic setup.

At this stage:

  • You have administrative access to the web UI and/or CLI.
  • The FortiADC appliance is integrated into your network.

Once that basic installation is complete, you can use this document. This document is a reference for commands you can use to:

  • Update the system.
  • Configure features and advanced options.
  • Diagnose problems.

This document does not cover the web UI or first-time setup. For that information, see the FortiADC Handbook.

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
  • RFC 5737: IPv4 Address Blocks Reserved for Documentation
  • RFC 3849: IPv6 Address Prefix Reserved for Documentation

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 10.0.0.1, 192.168.0.1, or 172.16.0.1.

Cautions, notes, & tips

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

 

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

Typographical conventions

Table 1 describes the typographical conventions used in this document.

Typographical conventions

Convention Example

A GUI element you are instructed to click or select

From Minimum log level, select Notification.

CLI input

config system dns
     set primary <address_ipv4>

end

CLI output

FortiADC-VM # execute certificate local regenerate

self certificate regenerated!

Emphasis

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

File content

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

Hyperlink

https://support.fortinet.com

Keyboard entry

Type a name for the configuration such as virtual_server_1.

Navigation

Go to System > Maintenance.

Publication

For details, see the FortiADC Handbook.

Command syntax

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

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

 

Introduction

Welcome, and thank you for selecting Fortinet products for your network protection.

Scope

This document describes how to use the command-line interface (CLI) of the FortiADC appliance. It assumes that you have already successfully installed the FortiADC appliance and completed basic setup.

At this stage:

  • You have administrative access to the web UI and/or CLI.
  • The FortiADC appliance is integrated into your network.

Once that basic installation is complete, you can use this document. This document is a reference for commands you can use to:

  • Update the system.
  • Configure features and advanced options.
  • Diagnose problems.

This document does not cover the web UI or first-time setup. For that information, see the FortiADC Handbook.

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
  • RFC 5737: IPv4 Address Blocks Reserved for Documentation
  • RFC 3849: IPv6 Address Prefix Reserved for Documentation

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 10.0.0.1, 192.168.0.1, or 172.16.0.1.

Cautions, notes, & tips

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

 

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

Typographical conventions

Table 1 describes the typographical conventions used in this document.

Typographical conventions

Convention Example

A GUI element you are instructed to click or select

From Minimum log level, select Notification.

CLI input

config system dns
     set primary <address_ipv4>

end

CLI output

FortiADC-VM # execute certificate local regenerate

self certificate regenerated!

Emphasis

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

File content

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

Hyperlink

https://support.fortinet.com

Keyboard entry

Type a name for the configuration such as virtual_server_1.

Navigation

Go to System > Maintenance.

Publication

For details, see the FortiADC Handbook.

Command syntax

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

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