FortiSwitch OS 7.6.4 CLI Reference

https://docs.fortinet.com/document/fortiswitch/7.6.4/
Admin
FortiSwitch OS CLI Reference documentation providing comprehensive command-line interface commands...
Tokens:609,254
Snippets:7,137
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example Output for 'get user setting'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Provides example output for retrieving system user settings, including authentication parameters.

```text
S524DF4K15000024 # get user setting
			
auth-blackout-time  : 0
auth-cert           : (null)
auth-http-basic     : disable
auth-invalid-max    : 5
auth-multi-group    : enable
auth-ports:
	== [ 1 ]
	id: 1
auth-secure-http    : disable
auth-timeout        : 5
auth-timeout-type   : idle-timeout
auth-type           : http https ftp telnet Copy
```

--------------------------------

### Example Output for 'get test'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Shows example output for the 'get test' command, including different test categories and their counts.

```text
S524DF4K15000024 # get test fpmd 1
ROUTE_V4_ADD                  : 9
INTF_V4_ADDR_ADD              : 14
ROUTE_V4_MGMT_FWD_DISABLED    : 4
ROUTE_ADD_INVALID_FAMILY      : 3
ROUTE_ADD_INET127             : 1

S524DF4K15000024 # get test sflowd 1
cmf sflow collector:0.0.0.0:[6343]
sflowd collector:0.0.0.0:[6343] Copy
```

--------------------------------

### Example Output for 'get user local'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Shows example output for listing local users. Use 'config user local' to add a new local user.

```text
S524DF4K15000024 # get user local
			
== [ user1 ]
name: user1 Copy
```

--------------------------------

### Example Output for 'get user group'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Displays example output for listing user groups. Use 'config user group' to add a new group.

```text
S524DF4K15000024 # get user group Copy

== [ group1 ]
name: group1
== [ radgroup ]
name: radgroup Copy
```

--------------------------------

### Example FortiSwitch Remote Assistance Commands

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/452179/diagnose

Examples of starting and stopping remote assistance sessions on a FortiSwitch unit.

```bash
S524DF4K15000024 # diagnose sys remote assistance limit 1
Starting remote assistance  ..... Complete.
```

```bash
S524DF4K15000024 # diagnose sys remote assistance indefinite
Starting remote assistance   .... Complete.
```

```bash
S524DF4K15000024 # diagnose sys remote assistance disable
Stopping remote assistance session   .... Complete. Copy
```

--------------------------------

### Example Output for 'get user local'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953/get

Displays the output of the 'get user local' command, listing local users.

```text
S524DF4K15000024 # get user local
			
== [ user1 ]
name: user1 Copy

```

--------------------------------

### Example Flow Export Configuration

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/500379

This example demonstrates how to configure flow export with IPFIX format, IP level tracking, and a specific collector setup.

```bash
config system flow-export
    set format ipfix
    set level ip
    config collectors
        edit flowone
            set ip 169.254.3.1
            set port 5
            set transport tcp
        next
    end
end
```

--------------------------------

### Example Output for 'get user radius'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Displays example output for listing RADIUS users. Use 'config user radius' to add a new RADIUS user.

```text
S524DF4K15000024 # get user radius
			
== [ serve2 ]
name: serve2
== [ radone ]
name: radone Copy
```

--------------------------------

### Example Output for 'get user group'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953/get

Displays the output of the 'get user group' command, listing available user groups.

```text
S524DF4K15000024 # get user group Copy
== [ group1 ]
name: group1
== [ radgroup ]
name: radgroup Copy

```

--------------------------------

### Example: Create MCLAG Trunks

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/511852/config-switch

This example illustrates creating two separate trunks, 'mclag-core1' and 'mclag-core2', with specified member ports for a multi-tiered MCLAG setup.

```bash
config switch auto-isl-port-group
edit "mclag-core1"
set members "port1" "port2"
next
edit "mclag-core2"
set members "port3" "port4"
end
```

--------------------------------

### Example Output for 'get user tacacs+'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Shows example output for retrieving tacacs+ user information. Use 'config user tacacs+' to manage tacacs+ users.

```text
S524DF4K15000024 # get user tacacs+
			
== [ tacserver ]
name: tacserver Copy
```

--------------------------------

### Example Output for Firmware Info

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/452179/diagnose

Example output indicating the validity of BIOS and firmware signatures.

```text
S148EN5919002269 # diagnose sys firmware info
BIOS Signature: valid
Firmware Signature: invalid

```

--------------------------------

### Example CLI Input

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/192230/config-switch

Illustrates the format for entering CLI commands for configuration.

```cli
config system dns set primary <address_ipv4> end
```

--------------------------------

### Example QoS Policy Configuration

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/511852/config-switch

This example demonstrates how to configure a specific QoS policy named 'policy1' for queue 0, setting various parameters like rate, scheduling, and drop policy.

```fortiswitchcli
config switch qos qos-policy
edit policy1
set rate-by kbps
set schedule weighted
config cos-queue
edit queue-0
set description "QoS policy for queue 0"
set drop-policy weighted-random-early-detection
set max-rate 20
set min-rate 10
set weight 5
set wred-slope 15
end
end
```

--------------------------------

### Example Output for 'get user radius'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953/get

Displays the output of the 'get user radius' command, listing RADIUS users.

```text
S524DF4K15000024 # get user radius
			
== [ serve2 ]
name: serve2
== [ radone ]
name: radone Copy

```

--------------------------------

### Example Syslog Configuration

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/365658

This example demonstrates how to enable syslog logging, specify a server address, and set a port number.

```bash
config log syslogd setting
set status enable
set server "1.2.3.4"
set port 5
end
```

--------------------------------

### Example: Get Debug Level for 'flgd'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/452179/diagnose

This example shows how to retrieve the current debug level for the 'flgd' application daemon and its output.

```bash
S524DF4K15000024 # diagnose debug application flgd
flgd debug level is 8 (0x8)
```

--------------------------------

### Example: Configure a Static Route

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/912449/config-router

This example demonstrates how to configure a basic static route with a specified gateway and status enabled.

```bash
config router static
edit 1
set gateway 192.168.0.10
set status enable
end
end
```

--------------------------------

### Example Output for 'get user tacacs+'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953/get

Displays the output of the 'get user tacacs+' command, showing TACACS+ user information.

```text
S524DF4K15000024 # get user tacacs+
			
== [ tacserver ]
name: tacserver Copy

```

--------------------------------

### Example: Backup all logs to TFTP server

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/434023

This example demonstrates backing up all FortiSwitch log files to a TFTP server.

```bash
execute backup memory alllogs tftp fgt.cfg 192.168.1.23
```

--------------------------------

### Execute Full Configuration Backup to TFTP

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/434023

This example demonstrates how to back up the entire FortiSwitch configuration to a TFTP server. Provide the desired filename and the TFTP server's IP address.

```bash
execute backup full-config tftp fgt.cfg 192.168.1.23
```

--------------------------------

### Get FortiSwitch GUI Log Device Output

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Example output of the 'get log gui' command, indicating that logs are being displayed from memory.

```text
log-device          : memory Copy
```

--------------------------------

### Example: Restore Configuration from SFTP with Credentials

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/434023

Demonstrates downloading a configuration file named 'backupconfig' from an SFTP server using an IPv6 address, port, username, and password.

```bash
execute restore config sftp backupconfig 6001:7:7:7::2]:2222 admin adminpassword
```

--------------------------------

### Example Output for 'get test sflowd 1'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953/get

Shows the output of the 'get test sflowd 1' command, indicating sFlow collector configuration.

```text
S524DF4K15000024 # get test sflowd 1
cmf sflow collector:0.0.0.0:[6343]
sflowd collector:0.0.0.0:[6343] Copy

```

--------------------------------

### Get FortiSwitch Hardware Status Output

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Example output of the 'get hardware status' command, showing detailed hardware specifications of a FortiSwitch model.

```text
Model name: FortiSwitch-524D-FPOE
CPU: ARMv7 Processor rev 0 (v7l)
RAM: 1978 MB
MTD Flash: 52 MB /dev/mtd
Hard disk: not available
Switch CPLD Version: V0.4
Poe Firmware Version:2.6.3 Copy
```

--------------------------------

### Display FortiSwitch Port Details Output Example

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/452179

Example output showing detailed status and configuration for a specific port, including its administrative status, MTU, and traffic statistics.

```text
S524DF4K15000024 # diagnose switch physical-ports list port1

Port(port1) is Admin up, line protocol is down
Interface Type is Serial Gigabit Media Independent Interface(SGMII/SerDes)
Address is 08:5B:0E:F1:95:E6, loopback is not set
MTU 9216 bytes, Encapsulation IEEE 802.3/Ethernet-II
half-duplex, 0 Mb/s, link type is auto
input  : 0 bytes, 0 packets, 0 errors, 0 drops, 0 oversizes
0 unicasts, 0 multicasts, 0 broadcasts, 0 unknowns
output : 0 bytes, 0 packets, 0 errors, 0 drops, 0 oversizes
0 unicasts, 0 multicasts, 0 broadcasts
0 fragments, 0 undersizes, 0 collisions, 0 jabbers Copy
```

--------------------------------

### Example: Enable Density Mode and Trunk Load Balancing

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/511852/config-switch

This example shows how to enable both density mode and trunk load balancing for global ACL settings.

```bash
config switch acl settings
set density-mode enable
set trunk-load-balance enable
end
```

--------------------------------

### Example Output: Memory Log Settings

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Example output showing the general settings for system memory logging, including disk full behavior and status.

```bash
S524DF4K15000024 # get log memory setting
diskfull            : overwrite
status              : enable Copy
```

--------------------------------

### Example Output for Multicast Info

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

This is an example output of the 'get router info multicast info' command, showing PIM/IGMP status, timers, and interface statistics.

```text
S524DF4K15000024 # get router info multicast info 
Router MLAG Role: NONE
Mroute socket descriptor: 7(default)
Mroute socket uptime: 180164:50

Zclient update socket: 11 failures=0
Zclient lookup socket: 12 failures=0

Maximum highest VifIndex: 255

Upstream Join Timer: 60 secs
Join/Prune Holdtime: 210 secs
PIM ECMP: Disable
PIM ECMP Rebalance: Disable

RPF Cache Refresh Delay:    50 msecs
RPF Cache Refresh Timer:    0 msecs
RPF Cache Refresh Requests: 0
RPF Cache Refresh Events:   0
RPF Cache Refresh Last:     --:--:--
Nexthop Lookups:            0
Nexthop Lookups Avoided:    0

Scan OIL - Last: --:--:--  Events: 0
MFC Add  - Last: --:--:--  Events: 0
MFC Del  - Last: --:--:--  Events: 0

Interface        Address            ifi Vif  PktsIn PktsOut    BytesIn   BytesOut Copy
```

--------------------------------

### Example Output: Syslogd Settings

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Example output showing the general settings for system log 1, including disk full behavior and status.

```bash
S524DF4K15000024 # get log syslogd setting
status              : disable	 Copy
```

--------------------------------

### Example Output for 'get test fpmd 1'

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953/get

Displays the output of the 'get test fpmd 1' command, showing counts for different routing-related operations.

```text
S524DF4K15000024 # get test fpmd 1
ROUTE_V4_ADD                  : 9
INTF_V4_ADDR_ADD              : 14
ROUTE_V4_MGMT_FWD_DISABLED    : 4
ROUTE_ADD_INVALID_FAMILY      : 3
ROUTE_ADD_INET127             : 1

```

--------------------------------

### Example: Create Virtual Wire

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/511852/config-switch

This example demonstrates how to create a virtual wire between port7 and port8 using VLAN 70.

```fortiswitchcli
config switch virtual-wire
edit 1
set first-member "port7"
set second-member "port8"
set vlan 70
next
end
```

--------------------------------

### Get FortiSwitch Event Filter Status Output

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Example output of the 'get log eventfilter' command, showing the enabled status of different log categories.

```text
event               : enable
router              : enable
system              : enable
user                : enable Copy
```

--------------------------------

### Example: Restore Configuration from TFTP

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/434023

Demonstrates downloading a configuration file named 'backupconfig' from a TFTP server at IP address 192.168.1.23 to the FortiSwitch unit.

```bash
execute restore config tftp backupconfig 192.168.1.23
```

--------------------------------

### Get FortiSwitch Custom Log Fields Output

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Example output of the 'get log custom-field' command, indicating the number of custom log fields configured.

```text
== [ 1 ]
id: 1
== [ 2 ]
id: 2 Copy
```

--------------------------------

### Configure OSPF6 Router, Area, Interface, and Redistribution

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/912449/config-router

This example demonstrates setting the OSPFv6 router ID, creating an OSPFv6 area with a filter list and range, configuring an OSPFv6 interface, and enabling redistribution for connected routes.

```fortiswitchcli
config router ospf6
	set router-id 10.11.101.1 
	config area
		edit 0.0.0.1
		config filter-list
			edit 1
				set direction in
				set list access1
			next
		end
		config range
			edit 1
				set advertise disable
				set prefix 3f2e:6a8b:78a3:0d82:1725:6a2f:0370:6234/96
			next 
		end
	end
	config interface
		edit vlan35
			set area 0.0.0.1
			set cost 100
			set priority 100
			set status enable
		next
	end
	config redistribute connected
		set status enable
	end
end Copy
```

--------------------------------

### Example Output: Memory Log Global Settings

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Example output displaying the global settings for system memory logging, including warning thresholds and maximum size.

```bash
S524DF4K15000024 # get log memory global-setting
full-final-warning-threshold: 95
full-first-warning-threshold: 75
full-second-warning-threshold: 90
hourly-upload       : disable
max-size            : 98304
```

--------------------------------

### Example Flow Export Configuration

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/500379/config-system

This example demonstrates a complete configuration for system flow export, including setting the format to IPFIX, tracking level to IP, and configuring a specific collector with TCP transport.

```bash
config system flow-export
set format ipfix
set level ip
config collectors
edit flowone
set ip 169.254.3.1
set port 5
set transport tcp
next
end
end
```

--------------------------------

### Example Output: Syslogd2 Settings

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Example output showing the general settings for system log 2, including disk full behavior and status.

```bash
S524DF4K15000024 # get log syslogd2 setting
status              : disable	 Copy
```

--------------------------------

### Get FortiSwitch Memory Log Settings Output

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Example output of the 'get log memory setting' command, indicating the disk full behavior and logging status.

```text
diskfull            : overwrite
status              : enable Copy
```

--------------------------------

### Example Output for PBR Map

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

This is an example output of the 'get router info pbr map' command, illustrating PBR rules, source/destination matches, and next-hop group details.

```text
S524DF4K15000024 # get router info pbr map 
   pbr-map pbrmap1 
     Seq: 1 rule: 300 Installed: 0 UniqIdx: 1 HardwareInstalled: 0 Reason: Invalid NH-group
		SRC Match: 22.1.1.0/24
		DST Match: 0.0.0.0/0
		Nexthop-Group: 12:1:1:2:(10001) Installed: 0(0)
     Seq: 2 rule: 301 Installed: 0 UniqIdx: 2 HardwareInstalled: 0 Reason: Invalid NH-group
		SRC Match: 0.0.0.0/0
		DST Match: 33.1.1.0/24
		Nexthop-Group: nhgroup1(10000) Installed: 0(0)
     Seq: 3 rule: 302 Installed: 0 UniqIdx: 4 HardwareInstalled: 0 Reason: Invalid NH-group
		SRC Match: 11.1.1.0/24
		DST Match: 0.0.0.0/0
		Nexthop-Group: 13:1:1:2:vrfv4(10002) Installed: 0(0)
			
S524DF4K15000024 # get router info pbr map 
```

--------------------------------

### Example: Configure Read-Only Access Profile

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/500379

This example demonstrates how to create an access profile named 'profile1' with read-only permissions for administrative, logging, network, routing, and system groups.

```bash
config system accprofile
edit profile1
set admingrp read
set loggrp read
set netgrp read
set routegrp read
set sysgrp read
end
```

--------------------------------

### Get FortiSwitch Memory Log Global Settings Output

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/896953

Example output of the 'get log memory global-setting' command, showing memory log thresholds and upload settings.

```text
full-final-warning-threshold: 95
full-first-warning-threshold: 75
full-second-warning-threshold: 90
hourly-upload       : disable
max-size            : 98304
```

--------------------------------

### Execute Partial Configuration Backup to TFTP

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/434023

This example shows how to perform a partial backup of the FortiSwitch configuration to a TFTP server. Specify the filename and the TFTP server's IP address.

```bash
execute backup config tftp fgt.cfg 192.168.1.23
```

--------------------------------

### Example CLI Output

Source: https://docs.fortinet.com/document/fortiswitch/7.6.4/fortiswitchos-cli-reference/608648

Shows the typical output format when querying system settings via the CLI.

```bash
FG T-602803030703 # get system setting  Copy
```
comments            : (No default) Copy
```
```
opmode              : nat Copy
```
```
Tokens:
Raw