Skip to main content

Version: current

gre

interface/gre

Type: Directory

Generic Routing Encapsulation (GRE) is a tunneling protocol originally developed by Cisco to encapsulate a wide variety of network layer protocols over an IP network.

Flag	Name	Description
`X`	disabled	Whether an item is disabled.
`R`	running	Whether the interface is running.

Argument	Type	Description
`name`	string	Name of the tunnel.
`mtu`	num	Layer3 maximum transmission unit.
`local-address`	ipAddr	IP address used for the local tunnel end. If set to 0.0.0.0, the IP address of the outgoing interface is used.
`remote-address` ( mandatory )	address (flags=4Dv)	IP address of the remote tunnel end.
`keepalive`	super { keepalive-interval: time [1 .. ] , [keepalive-retries] [ ,num [1 .. ]] }	The keepalive parameter sets the time interval in which the tunnel running flag remains even if the remote end of the tunnel goes down. If the configured time and retries fail, the interface running flag is removed. Parameters are written in the following format: `KeepaliveInterval,KeepaliveRetries` where KeepaliveInterval is the time interval and KeepaliveRetries is the number of retry attempts. By default keepalive is set to 10 seconds and 10 retries.
`dscp`	num	DSCP value of the packet. Inherited means the DSCP value is inherited from the tunneled traffic.
`clamp-tcp-mss`	bool	Controls whether to change the MSS size for received TCP SYN packets. When enabled, the router changes the MSS size for received TCP SYN packets if the current MSS size exceeds the tunnel interface MTU (taking into account the TCP/IP overhead). The received encapsulated packet still contains the original MSS, and only after decapsulation the MSS is changed.
`dont-fragment`	bool	Whether to include the DF bit in related packets. `no` - fragment if needed. `inherit` - use the DF flag of the original packet.
`ipsec-secret` (syscap=security)	string	When a secret is specified, the router adds a dynamic IPsec peer to remote-address with a pre-shared key and policy (by default phase2 uses sha1/aes128cbc).
`allow-fast-path`	bool	Whether to allow FastPath processing. Must be disabled if IPsec tunneling is used.

Read-only Argument	Type	Description
`actual-mtu`	num	Actual maximum transmission unit of the tunnel.
`current-remote-address`	ipAddr	Current IP address of the remote end.

interface/gre