Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.0.0
Download PDF
Copy Link

extender-controller extender

Use this command to configure the FortiExtender controller. This includes basic configurations, setting the role to primary or secondary, dial-mode settings, AT commands, mode of operation (LTE | 3G | 2G), SIM settings, and more.

To learn more about FortiExtender, including Admin Guides, Release Notes, and Hardware Manuals, see FortiExtender resources on our Fortinet Documentation Library website. The Release Notes also include a list of modems supported by the FortiExtender.

config extender-controller extender
    edit {id}
    # Extender controller configuration.
        set id {string}   FortiExtender serial number. size[19]
        set admin {disable | discovered | enable}   FortiExtender Administration (enable or disable).
        set ifname {string}   FortiExtender interface name. size[15]
        set vdom {integer}   VDOM range[0-4294967295]
        set role {none | primary | secondary}   FortiExtender work role(Primary, Secondary, None).
                none       FortiExtender is not supplying any service.
                primary    FortiExtender is supplying primary service.
                secondary  FortiExtender is standby for primary FortiExtender.
        set mode {standalone | redundant}   FortiExtender mode.
                standalone  Standalone.
                redundant   Redundant for an interface.
        set dial-mode {dial-on-demand | always-connect}   Dial mode (dial-on-demand or always-connect).
                dial-on-demand  The dial action is controlled by user.
                always-connect  auto dial.
        set redial {option}   Number of redials allowed based on failed attempts.
                none  Forever.
                1     One attempt.
                2     Two attempts.
                3     Three attempts.
                4     Four attempts.
                5     Five attempts.
                6     Six attempts.
                7     Seven attempts.
                8     Eight attempts.
                9     Nine attempts.
                10    Ten attempts.
        set redundant-intf {string}   Redundant interface. size[15]
        set dial-status {integer}   Dial status. range[0-4294967295]
        set conn-status {integer}   Connection status. range[0-4294967295]
        set ext-name {string}   FortiExtender name. size[31]
        set description {string}   Description. size[31]
        set quota-limit-mb {integer}   Monthly quota limit (MB). range[0-10485760]
        set billing-start-day {integer}   Billing start day. range[1-28]
        set at-dial-script {string}   Initialization AT commands specific to the MODEM. size[127]
        set modem-passwd {password_string}   MODEM password. size[27]
        set initiated-update {enable | disable}   Allow/disallow network initiated updates to the MODEM.
        set modem-type {cdma | gsm/lte | wimax}   MODEM type (CDMA, GSM/LTE or WIMAX).
                cdma     CDMA
                gsm/lte  GSM/LTE
                wimax    WIMAX
        set ppp-username {string}   PPP username. size[31]
        set ppp-password {password_string}   PPP password. size[27]
        set ppp-auth-protocol {auto | pap | chap}   PPP authentication protocol (PAP,CHAP or auto).
                auto  AUTO
                pap   PAP
                chap  CHAP
        set ppp-echo-request {enable | disable}   Enable/disable PPP echo request.
        set wimax-carrier {string}   WiMax carrier. size[31]
        set wimax-realm {string}   WiMax realm. size[31]
        set wimax-auth-protocol {tls | ttls}   WiMax authentication protocol(TLS or TTLS).
                tls   TLS
                ttls  TTLS
        set sim-pin {password_string}   SIM PIN. size[27]
        set access-point-name {string}   Access point name(APN). size[63]
        set multi-mode {option}   MODEM mode of operation(3G,LTE,etc).
                auto       AUTO
                auto-3g    Auto 3G(3G or less)
                force-lte  Force LTE
                force-3g   Force 3G
                force-2g   Force 2G
        set roaming {enable | disable}   Enable/disable MODEM roaming.
        set cdma-nai {string}   NAI for CDMA MODEMS. size[31]
        set aaa-shared-secret {password_string}   AAA shared secret. size[27]
        set ha-shared-secret {password_string}   HA shared secret. size[27]
        set primary-ha {string}   Primary HA. size[31]
        set secondary-ha {string}   Secondary HA. size[31]
        set cdma-aaa-spi {string}   CDMA AAA SPI. size[31]
        set cdma-ha-spi {string}   CDMA HA SPI. size[31]
    next
end

Additional information

The following section is for those options that require additional explanation.

 

set modem-type { cdma | gsm/lte | wimax }

The modem type (by default

  • cmda: A CMDA (Code Division Multiple Access) modem.
  • gsm/lte: A GSM (Global System for Mobile Communications)/ LTE (Long Term Evolution) modem.
  • wimax: A WiMax (Worldwide Interoperability for Microwave Access) modem.

set quota-limit-mb {integer}

Monthly quota limit of 0 to 10485760MB (approximately 10.5 Terabytes).

 

set billing-start-day {integer}

Set the day of the month when the billing period starts, anywhere from the first day of the month to the 28th day.

set dial mode {dial-on-demand | always-connect}

Thedial mode:

  • dial-on-demand: Automatically initiates a connection when the user makes a request.
  • always-connect: Automatically initiates a connection whenever the device is turned on.

set role {none | primary | secondary}

The default work role is set to none by default, but can be set to primary or secondary based on the role.

  • primary: The FortiExtender can act as a primary WAN connection, particularly in locations like small branch offices, retail "pop-up" stores, Point of Sale systems and remote kiosks type systems.
  • secondary: The FortiExtender can act as a backup or secondary failover WAN link.

set admin {enable | discovered | disable}

The administration mode for this unit is set to enable by default, but can be set to discovered, or disable.

  • enable: Manage this FortiExtender unit.
  • discovered: Manage disovered units.
  • disable: Do not manage this FortiExtender unit.

set multi-mode {auto | auto-3G | force-lte | force-3g | force-2g }

The MODEM mode of operation is set to auto by default, but can be set to auto-3G, force-lte, force-3g and force-2g. For related documentation on the differences between 3G, and LTE configurations see: Modems.

  • auto: Automatically selects the mode (either 3G or LTE).
  • auto-3G: Enables automatic selection of modes 3G or less.
  • force-lte: Enables selection of LTE mode only.
  • force-3g: Enables selection of 3G mode only.
  • force-2g: Enables selection of 2G mode only.

 

 

 

 

 

extender-controller extender

Use this command to configure the FortiExtender controller. This includes basic configurations, setting the role to primary or secondary, dial-mode settings, AT commands, mode of operation (LTE | 3G | 2G), SIM settings, and more.

To learn more about FortiExtender, including Admin Guides, Release Notes, and Hardware Manuals, see FortiExtender resources on our Fortinet Documentation Library website. The Release Notes also include a list of modems supported by the FortiExtender.

config extender-controller extender
    edit {id}
    # Extender controller configuration.
        set id {string}   FortiExtender serial number. size[19]
        set admin {disable | discovered | enable}   FortiExtender Administration (enable or disable).
        set ifname {string}   FortiExtender interface name. size[15]
        set vdom {integer}   VDOM range[0-4294967295]
        set role {none | primary | secondary}   FortiExtender work role(Primary, Secondary, None).
                none       FortiExtender is not supplying any service.
                primary    FortiExtender is supplying primary service.
                secondary  FortiExtender is standby for primary FortiExtender.
        set mode {standalone | redundant}   FortiExtender mode.
                standalone  Standalone.
                redundant   Redundant for an interface.
        set dial-mode {dial-on-demand | always-connect}   Dial mode (dial-on-demand or always-connect).
                dial-on-demand  The dial action is controlled by user.
                always-connect  auto dial.
        set redial {option}   Number of redials allowed based on failed attempts.
                none  Forever.
                1     One attempt.
                2     Two attempts.
                3     Three attempts.
                4     Four attempts.
                5     Five attempts.
                6     Six attempts.
                7     Seven attempts.
                8     Eight attempts.
                9     Nine attempts.
                10    Ten attempts.
        set redundant-intf {string}   Redundant interface. size[15]
        set dial-status {integer}   Dial status. range[0-4294967295]
        set conn-status {integer}   Connection status. range[0-4294967295]
        set ext-name {string}   FortiExtender name. size[31]
        set description {string}   Description. size[31]
        set quota-limit-mb {integer}   Monthly quota limit (MB). range[0-10485760]
        set billing-start-day {integer}   Billing start day. range[1-28]
        set at-dial-script {string}   Initialization AT commands specific to the MODEM. size[127]
        set modem-passwd {password_string}   MODEM password. size[27]
        set initiated-update {enable | disable}   Allow/disallow network initiated updates to the MODEM.
        set modem-type {cdma | gsm/lte | wimax}   MODEM type (CDMA, GSM/LTE or WIMAX).
                cdma     CDMA
                gsm/lte  GSM/LTE
                wimax    WIMAX
        set ppp-username {string}   PPP username. size[31]
        set ppp-password {password_string}   PPP password. size[27]
        set ppp-auth-protocol {auto | pap | chap}   PPP authentication protocol (PAP,CHAP or auto).
                auto  AUTO
                pap   PAP
                chap  CHAP
        set ppp-echo-request {enable | disable}   Enable/disable PPP echo request.
        set wimax-carrier {string}   WiMax carrier. size[31]
        set wimax-realm {string}   WiMax realm. size[31]
        set wimax-auth-protocol {tls | ttls}   WiMax authentication protocol(TLS or TTLS).
                tls   TLS
                ttls  TTLS
        set sim-pin {password_string}   SIM PIN. size[27]
        set access-point-name {string}   Access point name(APN). size[63]
        set multi-mode {option}   MODEM mode of operation(3G,LTE,etc).
                auto       AUTO
                auto-3g    Auto 3G(3G or less)
                force-lte  Force LTE
                force-3g   Force 3G
                force-2g   Force 2G
        set roaming {enable | disable}   Enable/disable MODEM roaming.
        set cdma-nai {string}   NAI for CDMA MODEMS. size[31]
        set aaa-shared-secret {password_string}   AAA shared secret. size[27]
        set ha-shared-secret {password_string}   HA shared secret. size[27]
        set primary-ha {string}   Primary HA. size[31]
        set secondary-ha {string}   Secondary HA. size[31]
        set cdma-aaa-spi {string}   CDMA AAA SPI. size[31]
        set cdma-ha-spi {string}   CDMA HA SPI. size[31]
    next
end

Additional information

The following section is for those options that require additional explanation.

 

set modem-type { cdma | gsm/lte | wimax }

The modem type (by default

  • cmda: A CMDA (Code Division Multiple Access) modem.
  • gsm/lte: A GSM (Global System for Mobile Communications)/ LTE (Long Term Evolution) modem.
  • wimax: A WiMax (Worldwide Interoperability for Microwave Access) modem.

set quota-limit-mb {integer}

Monthly quota limit of 0 to 10485760MB (approximately 10.5 Terabytes).

 

set billing-start-day {integer}

Set the day of the month when the billing period starts, anywhere from the first day of the month to the 28th day.

set dial mode {dial-on-demand | always-connect}

Thedial mode:

  • dial-on-demand: Automatically initiates a connection when the user makes a request.
  • always-connect: Automatically initiates a connection whenever the device is turned on.

set role {none | primary | secondary}

The default work role is set to none by default, but can be set to primary or secondary based on the role.

  • primary: The FortiExtender can act as a primary WAN connection, particularly in locations like small branch offices, retail "pop-up" stores, Point of Sale systems and remote kiosks type systems.
  • secondary: The FortiExtender can act as a backup or secondary failover WAN link.

set admin {enable | discovered | disable}

The administration mode for this unit is set to enable by default, but can be set to discovered, or disable.

  • enable: Manage this FortiExtender unit.
  • discovered: Manage disovered units.
  • disable: Do not manage this FortiExtender unit.

set multi-mode {auto | auto-3G | force-lte | force-3g | force-2g }

The MODEM mode of operation is set to auto by default, but can be set to auto-3G, force-lte, force-3g and force-2g. For related documentation on the differences between 3G, and LTE configurations see: Modems.

  • auto: Automatically selects the mode (either 3G or LTE).
  • auto-3G: Enables automatic selection of modes 3G or less.
  • force-lte: Enables selection of LTE mode only.
  • force-3g: Enables selection of 3G mode only.
  • force-2g: Enables selection of 2G mode only.