Fortinet black logo

CLI Reference

config vpn ocvpn

config vpn ocvpn

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

end

config vpn ocvpn

Parameter name

Description

Type

Size

status

Enable/disable Overlay Controller cloud assisted VPN.

option

-

Option

Description

enable

Enable Overlay Controller VPN.

disable

Disable Overlay Controller VPN.

role

Set device role.

option

-

Option

Description

spoke

Register device as static spoke.

primary-hub

Register device as primary hub.

secondary-hub

Register device as secondary hub.

poll-interval

Overlay Controller VPN polling interval.

integer

Minimum value: 30 Maximum value: 120

auto-discovery

Enable/disable auto-discovery shortcuts.

option

-

Option

Description

enable

Enable ADVPN auto-discovery shortcuts.

disable

Disable ADVPN auto-discovery shortcuts.

eap

Enable/disable EAP client authentication.

option

-

Option

Description

enable

Enable EAP client authentication.

disable

Disable EAP client authentication.

eap-users

EAP authentication user group.

string

Maximum length: 35

nat

Enable/disable inter-overlay source NAT.

option

-

Option

Description

enable

Enable inter-overlay source NAT.

disable

Disable inter-overlay source NAT.

Parameter name

Description

Type

Size

name

Overlay name.

string

Maximum length: 63

assign-ip

Enable/disable client address assignment.

option

-

Option

Description

enable

Enable client IPv4 address assignment.

disable

Disable client IPv4 address assignment.

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.

option

-

Option

Description

subnet

Configure participating subnet IP and mask.

interface

Configure participating LAN interface.

subnet

IPv4 address and subnet mask.

ipv4-classnet-any

Not Specified

interface

LAN interface.

string

Maximum length: 15

config vpn ocvpn

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

end

config vpn ocvpn

Parameter name

Description

Type

Size

status

Enable/disable Overlay Controller cloud assisted VPN.

option

-

Option

Description

enable

Enable Overlay Controller VPN.

disable

Disable Overlay Controller VPN.

role

Set device role.

option

-

Option

Description

spoke

Register device as static spoke.

primary-hub

Register device as primary hub.

secondary-hub

Register device as secondary hub.

poll-interval

Overlay Controller VPN polling interval.

integer

Minimum value: 30 Maximum value: 120

auto-discovery

Enable/disable auto-discovery shortcuts.

option

-

Option

Description

enable

Enable ADVPN auto-discovery shortcuts.

disable

Disable ADVPN auto-discovery shortcuts.

eap

Enable/disable EAP client authentication.

option

-

Option

Description

enable

Enable EAP client authentication.

disable

Disable EAP client authentication.

eap-users

EAP authentication user group.

string

Maximum length: 35

nat

Enable/disable inter-overlay source NAT.

option

-

Option

Description

enable

Enable inter-overlay source NAT.

disable

Disable inter-overlay source NAT.

Parameter name

Description

Type

Size

name

Overlay name.

string

Maximum length: 63

assign-ip

Enable/disable client address assignment.

option

-

Option

Description

enable

Enable client IPv4 address assignment.

disable

Disable client IPv4 address assignment.

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.

option

-

Option

Description

subnet

Configure participating subnet IP and mask.

interface

Configure participating LAN interface.

subnet

IPv4 address and subnet mask.

ipv4-classnet-any

Not Specified

interface

LAN interface.

string

Maximum length: 15