Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.2.1
Copy Link

Configure Overlay Controller VPN settings.

  config vpn ocvpn
      Description: Configure Overlay Controller VPN settings.
      set status [enable|disable]
      set role [spoke|primary-hub|...]
      set poll-interval {integer}
      set auto-discovery [enable|disable]
      set eap [enable|disable]
      set eap-users {string}
      set nat [enable|disable]
      config overlays
          Description: Network overlays to register with Overlay Controller VPN service.
          edit <id>
              set name {string}
              set assign-ip [enable|disable]
              set ipv4-start-ip {ipv4-address}
              set ipv4-end-ip {ipv4-address}
              config subnets
                  Description: Internal subnets to register with OCVPN service.
                  edit <id>
                      set type [subnet|interface]
                      set subnet {ipv4-classnet-any}
                      set interface {string}
                  next
              end
          next
      end
      set ha-alias {string}
  end

config vpn ocvpn

Parameter Name Description Type Size
status Enable/disable Overlay Controller cloud assisted VPN.
enable: Enable Overlay Controller VPN.
disable: Disable Overlay Controller VPN.
option -
role Set device role.
spoke: Register device as static spoke.
primary-hub: Register device as primary hub.
secondary-hub: Register device as secondary hub.
option -
poll-interval Overlay Controller VPN polling interval. integer Minimum value: 30 Maximum value: 120
auto-discovery Enable/disable auto-discovery shortcuts.
enable: Enable ADVPN auto-discovery shortcuts.
disable: Disable ADVPN auto-discovery shortcuts.
option -
eap Enable/disable EAP client authentication.
enable: Enable EAP client authentication.
disable: Disable EAP client authentication.
option -
eap-users EAP authentication user group. string Maximum length: 35
nat Enable/disable inter-overlay source NAT.
enable: Enable inter-overlay source NAT.
disable: Disable inter-overlay source NAT.
option -
ha-alias Hidden HA alias. string Maximum length: 35
Parameter Name Description Type Size
name Overlay name. string Maximum length: 63
assign-ip Enable/disable client address assignment.
enable: Enable client IPv4 address assignment.
disable: Disable client IPv4 address assignment.
option -
ipv4-start-ip Start of client IPv4 range. ipv4-address Not Specified
ipv4-end-ip End of client IPv4 range. ipv4-address Not Specified

config subnets

Parameter Name Description Type Size
type Subnet type.
subnet: Configure participating subnet IP and mask.
interface: Configure participating LAN interface.
option -
subnet IPv4 address and subnet mask. ipv4-classnet-any Not Specified
interface LAN interface. string Maximum length: 15

Configure Overlay Controller VPN settings.

  config vpn ocvpn
      Description: Configure Overlay Controller VPN settings.
      set status [enable|disable]
      set role [spoke|primary-hub|...]
      set poll-interval {integer}
      set auto-discovery [enable|disable]
      set eap [enable|disable]
      set eap-users {string}
      set nat [enable|disable]
      config overlays
          Description: Network overlays to register with Overlay Controller VPN service.
          edit <id>
              set name {string}
              set assign-ip [enable|disable]
              set ipv4-start-ip {ipv4-address}
              set ipv4-end-ip {ipv4-address}
              config subnets
                  Description: Internal subnets to register with OCVPN service.
                  edit <id>
                      set type [subnet|interface]
                      set subnet {ipv4-classnet-any}
                      set interface {string}
                  next
              end
          next
      end
      set ha-alias {string}
  end

config vpn ocvpn

Parameter Name Description Type Size
status Enable/disable Overlay Controller cloud assisted VPN.
enable: Enable Overlay Controller VPN.
disable: Disable Overlay Controller VPN.
option -
role Set device role.
spoke: Register device as static spoke.
primary-hub: Register device as primary hub.
secondary-hub: Register device as secondary hub.
option -
poll-interval Overlay Controller VPN polling interval. integer Minimum value: 30 Maximum value: 120
auto-discovery Enable/disable auto-discovery shortcuts.
enable: Enable ADVPN auto-discovery shortcuts.
disable: Disable ADVPN auto-discovery shortcuts.
option -
eap Enable/disable EAP client authentication.
enable: Enable EAP client authentication.
disable: Disable EAP client authentication.
option -
eap-users EAP authentication user group. string Maximum length: 35
nat Enable/disable inter-overlay source NAT.
enable: Enable inter-overlay source NAT.
disable: Disable inter-overlay source NAT.
option -
ha-alias Hidden HA alias. string Maximum length: 35
Parameter Name Description Type Size
name Overlay name. string Maximum length: 63
assign-ip Enable/disable client address assignment.
enable: Enable client IPv4 address assignment.
disable: Disable client IPv4 address assignment.
option -
ipv4-start-ip Start of client IPv4 range. ipv4-address Not Specified
ipv4-end-ip End of client IPv4 range. ipv4-address Not Specified

config subnets

Parameter Name Description Type Size
type Subnet type.
subnet: Configure participating subnet IP and mask.
interface: Configure participating LAN interface.
option -
subnet IPv4 address and subnet mask. ipv4-classnet-any Not Specified
interface LAN interface. string Maximum length: 15