CONFIG NETWORK INTERFACE CREATE

Level

network+modify

History

Appears in 6.0.0
DHCPRequestGW and dialdefault deprecated in 7.0.0
Dialtype GPRS appears in 9.0.1
LocalARP (for bridges only) appears in 9.1.2
Interface Agg appears in 1.0.0
UseSTP, STPPriority, STPForwardDelay, STPMaxAgeTime and STPHelloTime (for bridges only) appear in 2.0.0
MSTConfigIDFormatSelector, MSTConfigName, MSTConfigRevision (for bridges only) appear in 2.0.0
GRETUN and GRETAP interface type appear in 2.0.0
USBETHERNET interface type appear in 3.2.0
Priority for VLANs appear in 3.3.0
MigrateRarp for bridged interfaces appears in 3.7.0

Description

Create a new interface

Implementation notes

INTERFACE GENERIC TOKENS
RequestDNS: retrieve the DNS from the remote host
MTU: value
...
DIALUP GENERIC TOKENS
DialAuthname: account login
DialAuthkey: account password
DialIdle: idle timeout before hang up
DialMode: auto/ddial
DialType: PPP|PPTP|PPPOE|L2TP
DIALUP PPP TOKENS
All interface generic and dialup generic tokens apply for PPP dialups
DialPhone: phone number
DialString: modem initialisation string
DIALUP PPTP TOKENS
All interface generic and dialup generic tokens apply for PPTP dialups
DialModemIP: ip address of the PPTP modem
DIALUP PPPOE TOKENS
All interface generic and dialup generic tokens apply for PPPOE dialups
DialInterface: name of the interface to use to send PPPOE packets
DialService: service field (use by ISP to identify group of users)>]
DIALUP L2TP TOKENS
All interface generic, dialup generic and PPP tokens apply for L2TP dialups
DialL2TPLNS: LNS server object DialL2TPSecret: tunnel shared secret
DialL2TPBackupLNS: backup LNS server object
DialL2TPRedialTimeout: time between two redials
DialL2TPMaxRedial: number of redials
DialL2TPLengthBit: use the Length BIT in L2TP packets
DialL2TPHiddenAvp: enforce the exchange of sensible data (required a shared secret)
DialL2TPChallengeAuth: challenge the authentication of the peer
LOOPBACK AND IPSEC TOKENS
* Loopback0 and Ipsec are reserved for internal use *

Usage

ifname=<interface name> name=<username>
[comment=<comment>] [color=<color>] [type=(0|1|2)]
[DynamicDNS=<existing DynDNS conf>] (if Address=DHCP)
+ specific mandatory/optional tokens=values for interface type

* PARAMETERS FOR VLAN, AGG AND GRETAP INTERFACES:
Protected=(0|1)
[Address=(<IPv4 address>|DHCP) [Mask=<IPv4 mask>]]
[IPv6Address=<IPv6 address|DHCP|SLAAC> [IPv6Mask=(1-128) [eui64=(0|1)]]]
[gateway=<gateway>] [State=(0|1)] [Bridge=<bridge name>]
[FastRoute=(0|1) [KeepVLANID=(0|1)]] (if interface is in a bridge)
[MigrateRarp=(0|1)] (if interface is in a bridge)
[ForwardIPX=(0|1)] (if interface is in a bridge)
[ForwardNetbios=(0|1)] (if interface is in a bridge)
[ForwardAppletalk=(0|1)] (if interface is in a bridge)
[ForwardPPPoE=(0|1)] (if interface is in a bridge)
[ForwardIPv6=(0|1)] (if interface is in a bridge)
[ForwardCustomLLC=0-65535[,0-65535]*] (if interface is in a bridge)
[ForwardCustomEther=0-65535[,0-65535]*] (if interface is in a bridge)
[MTU=(140-MTUmax)] (if interface is NOT in a bridge; MTUmax displayed by SYSTEM PROPERTY)

* PARAMETERS FOR VLAN INTERFACES:
Physical=<eth/vlan interface name> Tag=(1-4094) [MaxThroughput=<int>] [KeepVLANPriority=(0|1)] [Priority=(0-7)]

* PARAMETERS FOR AGG INTERFACES:
Interfaces=<list of aggregated ethernet interfaces>
[MACAddress=xx:xx:xx:xx:xx:xx] (if agg is NOT in a bridge)

* PARAMETERS FOR GRETAP INTERFACES:
LocalTunnel=<Firewall_XXX object>
RemoteTunnel=<Host object>
[MACAddress=xx:xx:xx:xx:xx:xx] (if gretap is NOT in a bridge)

* PARAMETERS FOR BRIDGE INTERFACES:
Interfaces=<list of bridged interfaces> [Address=(<IPv4 address>|DHCP) [Mask=<IPv4 mask>]] [IPv6Address=<IPv6 address|DHCP|SLAAC> [IPv6Mask=(1-128)] [eui64=(0|1)]]
[MACAddress=xx:xx:xx:xx:xx:xx] [AddressComment=<comment>] [gateway=<gateway>]
[LocalARP=(0|1)]
[UseSTP=(0|1|2)] [STPPriority=(0-61440 step 4096)] [STPForwardDelay=(4-30)] [STPMaxAgeTime=(4-30)] [STPHelloTime=(1-10)]
[MSTConfigIdFormatSelector=(0-255)] [MSTConfigName=<str>] [MSTConfigRevision=(0-65535)]
[MaxThroughput=<int>]
[MTU=(140-MTUmax)] (MTUmax is displayed by SYSTEM PROPERTY)

* PARAMETERS FOR DIALUP INTERFACES:
DialAuthName=<login> DialAuthKey=<passwd> DialMode=(ddial|auto) DialType=(PPP|L2TP|PPTP|PPPoE|GPRS)
[State=(0|1)] [RequestDNS=(0|1)] [DynamicDNS=<existing DynDNS conf>] [DialIdle=<int>]
[MaxThroughput=<int>]
DialType=PPP DialPhone=<dial number> [DialString=<dial string>]
DialType=L2TP DialL2TPLNS=<server> [DialL2TPSecret=<passwd>] [DialL2TPBackupLNS=<server>] [DialL2TPRedialTimeout=<int>] [DialL2TPMaxRedial=<int>] [DialL2TPLengthBit=(0|1)] [DialL2TPHiddenAVP=(0|1)] [DialL2TPChallengeAuth=<int>]
DialType=PPTP DialModemIP=<ip>
DialType=PPPoE DialInterface=<eth/vlan interface username> [DialService=<service>]
DialType=GPRS DialPhone=<dial number> DialAPN=<string> DialDefPeer=<IP> [DialAPNum=<int>] [DialSimPin=<PIN code>] [DialSimWait=<int>] [DialModem=<string>]

* PARAMETERS FOR LOOPBACK AND IPSEC INTERFACES:
[State=<0|1>]
[Protected=<0|1>]
[Address=<IPv4 address> Mask=<IPv4 mask>]
[IPv6Address=IPv6 address IPv6Mask=(1-128)]
[MTU=(140-16384)]

* PARAMETERS FOR GRETUN INTERFACES:
[State=<0|1>]
[Protected=<0|1>]
[Address=<IPv4 address> Mask=<IPv4 mask>]
[IPv6Address=IPv6 address IPv6Mask=(1-128)]
LocalTunnel=<Firewall_XXX object>
RemoteTunnel=<Host object>
[MTU=(140-16384)]

* PARAMETERS FOR WIFI INTERFACES:
ifname=<interface name> name=<username>
SSID=<ssid name> (only printable characters, at least 5 characters and at max 31 characters long)
[WPA=<0|1|2>] (0 = open, 1 = wpa1, 2 = wpa2)
[ApIsolate=<0|1>]
[PassPhrase=<passphrase>] (when wpa = <1|2>, only printable characters, at least 8 characters and at max 63 characters long)
[color=<color>] [type=(0|1|2)]
[State=<0|1>]
[Protected=<0|1>]
[Address=<IPv4 address> Mask=<IPv4 mask>] [IPv6Address=IPv6 address IPv6Mask=(1-128)] | [Bridge=<bridge name>] (maximum 1 wifi interface per bridge)
[gateway=<gateway>]
[MTU=(140-7951)]

* PARAMETERS FOR USBETHERNET INTERFACES:
ifname=<interface name> name=<username>
[State=<0|1>]
[Address=(<IPv4 address>|DHCP) [Mask=<IPv4 mask>]]
[Protected=<0|1>]

Returns

Error code

Example

CONFIG NETWORK INTERFACE CREATE ifname=Vlan0 Name=VLANNetwork Address=DHCP DHCPLeaseTime=3600 Tag=123 MTU=1496 Physical=Ethernet1 Color=C0C0C0 Protected=1 Type=0 Comment="VLAN Network"
CONFIG NETWORK INTERFACE CREATE ifname=bridge0 Name=Bridge Address=192.168.1.1 Mask=255.255.255.0 Interfaces=Ethernet0,VLANNetwork
CONFIG NETWORK INTERFACE CREATE ifname=dialup0 Name=Test DialAuthName=test DialAuthKey=test DialMode=auto DialType=L2TP DialL2TPLNS=lns_host DialL2TPSecret=secret DialL2TPBackupLNS=bckp_lns_host
CONFIG NETWORK INTERFACE CREATE ifname=Loopback1 Name=TunnelAg1 Address=192.168.255.254 Mask=255.255.255.255 IPv6Address=fc00::4 IPv6Mask=128 MTU=1400
CONFIG NETWORK INTERFACE CREATE ifname=GreTun0 Name=TunGreHQ Address=192.168.255.254 RemoteAddress=172.31.128.254 IPv6Address=fc00::5 MTU=1400 LocalTunnel=Firewall_out RemoteTunnel=Peer
CONFIG NETWORK INTERFACE CREATE ifname=GreTap0 Name=VPNBRIDGE Address=192.168.255.254 Mask=255.255.255.255 IPv6Address=fc00::4 IPv6Mask=128 MTU=1400 LocalTunnel=Firewall_out RemoteTunnel=Peer
CONFIG NETWORK INTERFACE CREATE ifname=usbethernet0 Name=MyUsbModem Address=192.168.8.2 Mask=255.255.255.0 Protected=0 Comment="4G USB modem"