Fortinet black logo

Configuration help

Configuration help

FortiExtender 4.1.2 supports the following CLI commands for device status and configuration. For more use cases and advanced configuration options, refer to the FortiExtender 4.1.2 Admin Guide.

Status commands

Command

Description

get system version

Displays the device's hardware and software versions.

get modem status

Displays detailed modem status information.

get extender status

Displays the connectivity status of the FortiExtender device to its master.

get cpm status

Displays SSL tunnel information and connectivity status.

Configuration commands

When FortiExtender is deployed in the Cloud, it can download configurations from FortiExtender Cloud. However, you can still configure the device locally using the following commands:

Change the default SIM

The default SIM is sim1. You can change it to sim2 using the following commands:

config lte setting modem1

set default-sim sim {1 | 2}

end

Select a preferred carrier

config lte setting modem1

set preferred-carrier <carrier name>

end

Enable SIM-switch

config lte setting modem1

set smart-switch enable

end

Add a new carrier profile

config lte carrier

edit <carrier>

set firmware <firmware name>

set pri <pri name>

next

Add new carrier

config lte simmap

edit <carrier>

set mcc <first 3 digits of the IMSI number>

set mnc <next 2 digits the IMSI number>

set carrier <carrier name from the newly created carrier profile>

next

Add new data plan

config lte plan

edit <plan name>

set carrier <carrier name>

set apn <carrier apn>

set capacity <data plan in MB>

set billing-date <billing date>

set overage {enable | disable}

next

end

Manage FortiExtender locally

config system management

set discovery-type local

config local

set mode ip-passthrough

end

end

Configure VRRP mode

Tooltip

This feature applies to the newly released FEX-201E and /or FEX-211E only. It is not applicable to FEX-40D-AMEU.

config system management
 set discovery-type fortigate
  config fortigate
  set ac-discovery-type broadcast
  set ac-ctl-port 5246
  set ac-data-port 25246
 end
 

 config fortigate-backup
  vrrp-interface <vrrp interface i.e por1>
  vrrp-id < vrrp id greater than Fortigate>
  status enable
 end
end


config system interface
 edit lan
  config vrrp
   set version 2 <only 2 is supported currently>
   set id <vrrp id>
   set ip <IP of virtual router>
   set priority <priority>
   set adv-interval <advertisement interval in seconds>
   set start-time <initialization timer for backup router, typically 1>
   set preempt <enable | disable> (preempting master typically disable)
   set status enable
  end
 next
end

To display the status of virtual router on FortiExtender, use the following command:

get router info vrrp 

Configure health monitoring (HMON)

config hmon
    config interface-monitoring
        edit < interface specific monitor name >
            set interval <interval size in seconds, default:30>
            set interface <interfaces to monitor: lte1, lte2>
            set filter <interested fields: rx_bytes,tx_bytes,rx_packets,tx_packets,rx_dropped,tx_dropped,rx_bps,tx_bps,rx_pps,tx_pps>
        next
    end
    config hchk
        edit < health check type name >
            set protocol <ping|http|dns, default: ping>
            set interval <interval size in seconds, default :30>
            set probe-cnt <probes to be sent within an intervalm default:1>
            set probe-tm <probe timeout, default:2>
            set probe-target <target to be probed>
            set interface <uplink interfaces on which probe has to be sent>
            set src-iface <interface whose source IP is to be used>
            set filter <rtt |loss>
        next
    end
end
To display interface statistics by filter:
get hmon interface-monitoring <interface specific monitor name>
To get health parameters:
get hmon hchk <health check type name>
To run health check monitor to display all interface statistics:
execute hmon interface-monitoring <interface>
To run health check on a specific interface:
execute hmon hchk protocol ping -I <interface> <probe ip or url>

Configure route multicasting

FortiExtender is capable of running PIM-SM to discover terminal devices and join multicast routing group accordingly.

config router multicast
 config pim-sm-global
 set join-prune-interval <Periodic JOIN/PRUNE message interval, default 60>
 set bsr-priority 5 <BSR priority , default 5>
 set spt-threshold <SPT threahold, default 3000 >
 set hello-interval < Periodic Hello message interval, default 30 >
 config rp-address 
	 edit 1
	 set address <RP ip adddress>
	 set group <Group for this RP >
 next
 end
 end

 config interface
  edit lan //the interfaces PIM running on
  next
  edit rp //the interfaces PIM running on
  next
  end
end

Configure SMS

FortiExtender supports the configuration of mobile phone numbers, thus enabling the reception of SMS-based alerts.

To create receivers:
config system sms-notification
set notification enable/disable
config receiver
edit <user1>
		 set receiver enable/disable
		 set phone-number <mobile phone number>
		 set alert <type of alerts i.e system-reboot,data-exhausted,session-disconnect,etc >
		 next
 edit <user2>
	 		 set receiver enable/disable
			 set phone-number <mobile phone number>
			 set alert <type of alerts i.e system-reboot,data-exhausted,session-disconnect,etc >
		 next
 end
To use/tune alert messages:
Tooltip

The following messages can be edited, but no new categories can be created.

config system sms-notification alert
    set system-reboot rebooting
    set data-exhausted data plan is exhausted
    set session-disconnect LTE data session is disconnected
    set low-signal-strength LTE signal strength is too low
    set os-image-fallback system start to fallback OS image
    set mode-switch system working mode switched
end

Configuration help

FortiExtender 4.1.2 supports the following CLI commands for device status and configuration. For more use cases and advanced configuration options, refer to the FortiExtender 4.1.2 Admin Guide.

Status commands

Command

Description

get system version

Displays the device's hardware and software versions.

get modem status

Displays detailed modem status information.

get extender status

Displays the connectivity status of the FortiExtender device to its master.

get cpm status

Displays SSL tunnel information and connectivity status.

Configuration commands

When FortiExtender is deployed in the Cloud, it can download configurations from FortiExtender Cloud. However, you can still configure the device locally using the following commands:

Change the default SIM

The default SIM is sim1. You can change it to sim2 using the following commands:

config lte setting modem1

set default-sim sim {1 | 2}

end

Select a preferred carrier

config lte setting modem1

set preferred-carrier <carrier name>

end

Enable SIM-switch

config lte setting modem1

set smart-switch enable

end

Add a new carrier profile

config lte carrier

edit <carrier>

set firmware <firmware name>

set pri <pri name>

next

Add new carrier

config lte simmap

edit <carrier>

set mcc <first 3 digits of the IMSI number>

set mnc <next 2 digits the IMSI number>

set carrier <carrier name from the newly created carrier profile>

next

Add new data plan

config lte plan

edit <plan name>

set carrier <carrier name>

set apn <carrier apn>

set capacity <data plan in MB>

set billing-date <billing date>

set overage {enable | disable}

next

end

Manage FortiExtender locally

config system management

set discovery-type local

config local

set mode ip-passthrough

end

end

Configure VRRP mode

Tooltip

This feature applies to the newly released FEX-201E and /or FEX-211E only. It is not applicable to FEX-40D-AMEU.

config system management
 set discovery-type fortigate
  config fortigate
  set ac-discovery-type broadcast
  set ac-ctl-port 5246
  set ac-data-port 25246
 end
 

 config fortigate-backup
  vrrp-interface <vrrp interface i.e por1>
  vrrp-id < vrrp id greater than Fortigate>
  status enable
 end
end


config system interface
 edit lan
  config vrrp
   set version 2 <only 2 is supported currently>
   set id <vrrp id>
   set ip <IP of virtual router>
   set priority <priority>
   set adv-interval <advertisement interval in seconds>
   set start-time <initialization timer for backup router, typically 1>
   set preempt <enable | disable> (preempting master typically disable)
   set status enable
  end
 next
end

To display the status of virtual router on FortiExtender, use the following command:

get router info vrrp 

Configure health monitoring (HMON)

config hmon
    config interface-monitoring
        edit < interface specific monitor name >
            set interval <interval size in seconds, default:30>
            set interface <interfaces to monitor: lte1, lte2>
            set filter <interested fields: rx_bytes,tx_bytes,rx_packets,tx_packets,rx_dropped,tx_dropped,rx_bps,tx_bps,rx_pps,tx_pps>
        next
    end
    config hchk
        edit < health check type name >
            set protocol <ping|http|dns, default: ping>
            set interval <interval size in seconds, default :30>
            set probe-cnt <probes to be sent within an intervalm default:1>
            set probe-tm <probe timeout, default:2>
            set probe-target <target to be probed>
            set interface <uplink interfaces on which probe has to be sent>
            set src-iface <interface whose source IP is to be used>
            set filter <rtt |loss>
        next
    end
end
To display interface statistics by filter:
get hmon interface-monitoring <interface specific monitor name>
To get health parameters:
get hmon hchk <health check type name>
To run health check monitor to display all interface statistics:
execute hmon interface-monitoring <interface>
To run health check on a specific interface:
execute hmon hchk protocol ping -I <interface> <probe ip or url>

Configure route multicasting

FortiExtender is capable of running PIM-SM to discover terminal devices and join multicast routing group accordingly.

config router multicast
 config pim-sm-global
 set join-prune-interval <Periodic JOIN/PRUNE message interval, default 60>
 set bsr-priority 5 <BSR priority , default 5>
 set spt-threshold <SPT threahold, default 3000 >
 set hello-interval < Periodic Hello message interval, default 30 >
 config rp-address 
	 edit 1
	 set address <RP ip adddress>
	 set group <Group for this RP >
 next
 end
 end

 config interface
  edit lan //the interfaces PIM running on
  next
  edit rp //the interfaces PIM running on
  next
  end
end

Configure SMS

FortiExtender supports the configuration of mobile phone numbers, thus enabling the reception of SMS-based alerts.

To create receivers:
config system sms-notification
set notification enable/disable
config receiver
edit <user1>
		 set receiver enable/disable
		 set phone-number <mobile phone number>
		 set alert <type of alerts i.e system-reboot,data-exhausted,session-disconnect,etc >
		 next
 edit <user2>
	 		 set receiver enable/disable
			 set phone-number <mobile phone number>
			 set alert <type of alerts i.e system-reboot,data-exhausted,session-disconnect,etc >
		 next
 end
To use/tune alert messages:
Tooltip

The following messages can be edited, but no new categories can be created.

config system sms-notification alert
    set system-reboot rebooting
    set data-exhausted data plan is exhausted
    set session-disconnect LTE data session is disconnected
    set low-signal-strength LTE signal strength is too low
    set os-image-fallback system start to fallback OS image
    set mode-switch system working mode switched
end