CONFIG NETWORK INTERFACE UPDATE

Level

network+modify

History

Appears in 6.0.0
Dialtype GPRS appears in 9.0.1
Name deprecated in 9.0.2: use CONFIG NETWORK INTERFACE RENAME instead
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

Update an interface

Usage

ifname=<interface name> [comment=<comment>] [color=<color>]
[type=(0|1|2)] (0=unknown, 1=machine, 2=server)

* PARAMETERS FOR ETHERNET, AGG, VLAN and GRETAP INTERFACES:
[gateway=<gateway>] [Protected=(0|1)] [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)] (MTUmax is displayed by SYSTEM PROPERTY)
[DynamicDNS=<existing DynDNS conf>] (if interface is NOT in a bridge and has Address=DHCP)
[DHCPLeaseTime=<new DHCP Lease Time>] (if interface has Address=DHCP)
[DHCPHostName=<new DHCP hostname>] (if interface has Address=DHCP)
[RequestDNS=(0|1)]

* PARAMETERS FOR ETHERNET INTERFACES:
[Media=(0-6)]
[MaxThroughput=<int>]
[MACAddress=xx:xx:xx:xx:xx:xx] (if interface is NOT in a bridge and NOT in Agg)
[EEE=(0|1)] [FlowControl=(0|1)]

* PARAMETERS FOR AGG INTERFACES:
[Interfaces=<list of aggregated interfaces>]

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

* PARAMETERS FOR BRIDGE INTERFACES:
[Interfaces=<list of bridged interfaces>] [MACAddress=xx:xx:xx:xx:xx:xx] [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)
[DynamicDNS=<existing DynDNS conf>] (if Address=DHCP)

* PARAMETERS FOR DIALUP INTERFACES:
[State=(0|1)] [RequestDNS=(0|1)] [DynamicDNS=<existing DynDNS conf>] [MaxThroughput=<int>]
[DialAuthName=<login>] [DialAuthKey=<passwd>] [DialMode=(ddial|auto)] [DialIdle=<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> [DialAPNum=<int>] [DialDefPeer=<IP>] [DialSimPin=<PIN code>] [DialSimWait=<int>] [DialModem=<string>]]

* PARAMETERS FOR WIFI INTERFACES:
[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)

* PARAMETERS FOR LOOPBACK AND IPSEC INTERFACES:
[State=<0|1>]
[MTU=(140-16384)]
[Protected=<0|1>]
[gateway=<gateway>]
[Address=<IPv4 address> Mask=<IPv4 mask>] [IPv6Address=IPv6 address IPv6Mask=(1-128)]
* PARAMETERS FOR GRETUN INTERFACES:
[State=<0|1>]
[LocalTunnel=<Firewall_XXX object>]
[RemoteTunnel=<Host object>]
[MTU=(140-16384)]
[Protected=<0|1>]
[Address=<IPv4 address> Mask=<IPv4 mask>] [IPv6Address=IPv6 address IPv6Mask=(1-128)]
* PARAMETERS FOR GRETAP INTERFACES:
[State=<0|1>]
[MACAddress=xx:xx:xx:xx:xx:xx] (if interface is NOT in a bridge and NOT in Agg)
[MaxThroughput=<int>]
[LocalTunnel=<Firewall_XXX object>]
[RemoteTunnel=<Host object>]
[Protected=<0|1>]

* PARAMETERS FOR USBETHERNET INTERFACES:
[State=<0|1>]
[Protected=<0|1>]

Returns

Error code

Remark

Addresses (including DHCP and DHCP options, and SLAAC) must be updated via ADDRESS ADD and ADDRESS DEL
Dialup parameters specific to a dialtype will only be parsed if this dialtype is specified on the command
All addresses will be removed if a bridge is specified
All configuration (except Name, Color, State, Media and MaxThroughput) will be removed if an Agg is specified

Example

CONFIG NETWORK INTERFACE UPDATE ifname=bridge3 gateway=net_host2 color=AB12E3 maxthroughput=1234567
CONFIG NETWORK INTERFACE UPDATE ifname=Dialup4 DialType="PPP" DialPhone="0123456789" DialAuthName="name@provider"
CONFIG NETWORK INTERFACE UPDATE ifname=Dialup4 DialType="PPTP" DialModemIP=10.2.9.223
CONFIG NETWORK INTERFACE UPDATE ifname=Dialup4 DialType="PPPoE" DialInterface=in DialService="mod_str"
CONFIG NETWORK INTERFACE UPDATE ifname=Dialup4 DialType="L2TP" DialL2TPLNS="LNS1" DialL2TPChallengeAuth="1"
CONFIG NETWORK INTERFACE UPDATE ifname=ethernet3 name="my_eth" color=AB12E3 DynamicDNS="dyndns_network" state=1
CONFIG NETWORK INTERFACE UPDATE ifname=vlan0 ForwardCustomLLC=5,0,65535 ForwardPPPoE=1 ForwardIPv6=1
CONFIG NETWORK INTERFACE UPDATE ifname=vlan3 tag=44 physical=ethernet3 name="my_vlan" gateway=10.2.9.10 CONFIG NETWORK INTERFACE UPDATE ifname=Loopback1 Name=TunnelAg1 Address=192.168.255.254 Mask=255.255.255.255 IPv6Address=fc00::4 IPv6Mask=128 MTU=1400
CONFIG NETWORK INTERFACE UPDATE 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 UPDATE ifname=GreTap0 Name=TapGreHQ Address=192.168.255.254 Mask=255.255.255.254 IPv6Address=fc00::5 MTU=1400 LocalTunnel=Firewall_out RemoteTunnel=Peer MACAddress=50:60:70:80:90:a0
CONFIG NETWORK INTERFACE UPDATE ifname=usbethernet0 Name=MyUsbModem Address=192.168.8.2 Mask=255.255.255.0
CONFIG NETWORK INTERFACE UPDATE ifname=Vlan0 DHCPLeaseTime=5400 MTU=1514 DHCPHostName=stormshield RequestDNS=0