config system interface
Configure interfaces.
config system interface Description: Configure interfaces. edit <name> set vdom {string} set cli-conn-status {integer} set mode [static|dhcp|...] config client-options Description: DHCP client options. edit <id> set code {integer} set type [hex|string|...] set value {string} set ip {user} next end set distance {integer} set priority {integer} set dhcp-relay-interface-select-method [auto|specify] set dhcp-relay-interface {string} set dhcp-relay-service [disable|enable] set dhcp-relay-ip {user} set dhcp-relay-link-selection {ipv4-address} set dhcp-relay-request-all-server [disable|enable] set dhcp-relay-type [regular|ipsec] set dhcp-relay-agent-option [enable|disable] set dhcp-classless-route-addition [enable|disable] set management-ip {ipv4-classnet-host} set ip {ipv4-classnet-host} set allowaccess {option1}, {option2}, ... set gwdetect [enable|disable] set ping-serv-status {integer} set detectserver {user} set detectprotocol {option1}, {option2}, ... set ha-priority {integer} set fail-detect [enable|disable] set fail-detect-option {option1}, {option2}, ... set fail-alert-method [link-failed-signal|link-down] set fail-action-on-extender [soft-restart|hard-restart|...] set fail-alert-interfaces <name1>, <name2>, ... set dhcp-client-identifier {string} set dhcp-renew-time {integer} set ipunnumbered {ipv4-address} set username {string} set pppoe-unnumbered-negotiate [enable|disable] set password {password} set idle-timeout {integer} set detected-peer-mtu {integer} set disc-retry-timeout {integer} set padt-retry-timeout {integer} set service-name {string} set ac-name {string} set lcp-echo-interval {integer} set lcp-max-echo-fails {integer} set defaultgw [enable|disable] set dns-server-override [enable|disable] set dns-server-protocol {option1}, {option2}, ... set auth-type [auto|pap|...] set pptp-client [enable|disable] set pptp-user {string} set pptp-password {password} set pptp-server-ip {ipv4-address} set pptp-auth-type [auto|pap|...] set pptp-timeout {integer} set arpforward [enable|disable] set broadcast-forward [enable|disable] set bfd [global|enable|...] set bfd-desired-min-tx {integer} set bfd-detect-mult {integer} set bfd-required-min-rx {integer} set l2forward [enable|disable] set icmp-send-redirect [enable|disable] set icmp-accept-redirect [enable|disable] set stpforward [enable|disable] set stpforward-mode [rpl-all-ext-id|rpl-bridge-ext-id|...] set macaddr {mac-address} set substitute-dst-mac {mac-address} set large-receive-offload [enable|disable] set generic-receive-offload [enable|disable] set speed [auto|10full|...] set status [up|down] set netbios-forward [disable|enable] set wins-ip {ipv4-address} set type [physical|vlan|...] set dedicated-to [none|management] set trust-ip-1 {ipv4-classnet-any} set trust-ip-2 {ipv4-classnet-any} set trust-ip-3 {ipv4-classnet-any} set trust-ip6-1 {ipv6-prefix} set trust-ip6-2 {ipv6-prefix} set trust-ip6-3 {ipv6-prefix} set mtu-override [enable|disable] set mtu {integer} set ring-rx {integer} set ring-tx {integer} set wccp [enable|disable] set drop-overlapped-fragment [enable|disable] set drop-fragment [enable|disable] set src-check [enable|disable] set explicit-web-proxy [enable|disable] set explicit-ftp-proxy [enable|disable] set proxy-captive-portal [enable|disable] set tcp-mss {integer} set inbandwidth {integer} set outbandwidth {integer} set egress-shaping-profile {string} set ingress-shaping-profile {string} set disconnect-threshold {integer} set spillover-threshold {integer} set ingress-spillover-threshold {integer} set weight {integer} set interface {string} set external [enable|disable] set vlan-protocol [8021q|8021ad] set vlanid {integer} set forward-domain {integer} set remote-ip {ipv4-classnet-host} set member <interface-name1>, <interface-name2>, ... set lacp-mode {option} set lacp-ha-secondary [enable|disable] set system-id-type [auto|user] set system-id {mac-address} set lacp-speed [slow|fast] set min-links {integer} set min-links-down [operational|administrative] set algorithm [L2|L3|...] set link-up-delay {integer} set priority-override [enable|disable] set aggregate {string} set redundant-interface {string} set devindex {integer} set switch {string} set description {var-string} set alias {string} set security-mode [none|captive-portal|...] set security-mac-auth-bypass [mac-auth-only|enable|...] set security-external-web {var-string} set security-external-logout {string} set replacemsg-override-group {string} set security-redirect-url {var-string} set auth-cert {string} set auth-portal-addr {string} set security-exempt-list {string} set security-groups <name1>, <name2>, ... set role [lan|wan|...] set snmp-index {integer} set secondary-IP [enable|disable] config secondaryip Description: Second IP address of interface. edit <id> set ip {ipv4-classnet-host} set allowaccess {option1}, {option2}, ... set gwdetect [enable|disable] set ping-serv-status {integer} set detectserver {user} set detectprotocol {option1}, {option2}, ... set ha-priority {integer} next end set color {integer} config tagging Description: Config object tagging. edit <name> set category {string} set tags <name1>, <name2>, ... next end config ipv6 Description: IPv6 of interface. set ip6-mode [static|dhcp|...] set nd-mode [basic|SEND-compatible] set nd-cert {string} set nd-security-level {integer} set nd-timestamp-delta {integer} set nd-timestamp-fuzz {integer} set nd-cga-modifier {user} set ip6-dns-server-override [enable|disable] set ip6-address {ipv6-prefix} config ip6-extra-addr Description: Extra IPv6 address prefixes of interface. edit <prefix> next end set ip6-allowaccess {option1}, {option2}, ... set ip6-send-adv [enable|disable] set icmp6-send-redirect [enable|disable] set ip6-manage-flag [enable|disable] set ip6-other-flag [enable|disable] set ip6-max-interval {integer} set ip6-min-interval {integer} set ip6-link-mtu {integer} set ra-send-mtu [enable|disable] set ip6-reachable-time {integer} set ip6-retrans-time {integer} set ip6-default-life {integer} set ip6-hop-limit {integer} set autoconf [enable|disable] set unique-autoconf-addr [enable|disable] set interface-identifier {ipv6-address} set ip6-prefix-mode [dhcp6|ra] set ip6-upstream-interface {string} set ip6-delegated-prefix-iaid {integer} set ip6-subnet {ipv6-prefix} config ip6-prefix-list Description: Advertised prefix list. edit <prefix> set autonomous-flag [enable|disable] set onlink-flag [enable|disable] set valid-life-time {integer} set preferred-life-time {integer} set rdnss {user} set dnssl <domain1>, <domain2>, ... next end config ip6-delegated-prefix-list Description: Advertised IPv6 delegated prefix list. edit <prefix-id> set upstream-interface {string} set delegated-prefix-iaid {integer} set autonomous-flag [enable|disable] set onlink-flag [enable|disable] set subnet {ipv6-network} set rdnss-service [delegated|default|...] set rdnss {user} next end set dhcp6-relay-service [disable|enable] set dhcp6-relay-type {option} set dhcp6-relay-ip {user} set dhcp6-client-options {option1}, {option2}, ... set dhcp6-prefix-delegation [enable|disable] set dhcp6-information-request [enable|disable] config dhcp6-iapd-list Description: DHCPv6 IA-PD list. edit <iaid> set prefix-hint {ipv6-network} set prefix-hint-plt {integer} set prefix-hint-vlt {integer} next end set cli-conn6-status {integer} end next end
config system interface
Parameter |
Description |
Type |
Size |
Default |
||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name |
Name. |
string |
Maximum length: 15 |
|
||||||||||||||||||||||||||
vdom |
Interface is in this virtual domain (VDOM). |
string |
Maximum length: 31 |
|
||||||||||||||||||||||||||
cli-conn-status |
CLI connection status. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||||||||||
mode |
Addressing mode (static, DHCP, PPPoE). |
option |
- |
static |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
distance |
Distance for routes learned through PPPoE or DHCP, lower distance indicates preferred route. |
integer |
Minimum value: 1 Maximum value: 255 |
5 |
||||||||||||||||||||||||||
priority |
Priority of learned routes. |
integer |
Minimum value: 1 Maximum value: 65535 |
0 |
||||||||||||||||||||||||||
dhcp-relay-interface-select-method |
Specify how to select outgoing interface to reach server. |
option |
- |
auto |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
dhcp-relay-interface |
Specify outgoing interface to reach server. |
string |
Maximum length: 15 |
|
||||||||||||||||||||||||||
dhcp-relay-service |
Enable/disable allowing this interface to act as a DHCP relay. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
dhcp-relay-ip |
DHCP relay IP address. |
user |
Not Specified |
|
||||||||||||||||||||||||||
dhcp-relay-link-selection |
DHCP relay link selection. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||||||||||||||||||||
dhcp-relay-request-all-server |
Enable/disable sending of DHCP requests to all servers. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
dhcp-relay-type |
DHCP relay type (regular or IPsec). |
option |
- |
regular |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
dhcp-relay-agent-option |
Enable/disable DHCP relay agent option. |
option |
- |
enable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
dhcp-classless-route-addition |
Enable/disable addition of classless static routes retrieved from DHCP server. |
option |
- |
enable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
management-ip |
High Availability in-band management IP address of this interface. |
ipv4-classnet-host |
Not Specified |
0.0.0.0 0.0.0.0 |
||||||||||||||||||||||||||
ip |
Interface IPv4 address and subnet mask, syntax: X.X.X.X/24. |
ipv4-classnet-host |
Not Specified |
0.0.0.0 0.0.0.0 |
||||||||||||||||||||||||||
allowaccess |
Permitted types of management access to this interface. |
option |
- |
|
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
gwdetect |
Enable/disable detect gateway alive for first. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
ping-serv-status |
PING server status. |
integer |
Minimum value: 0 Maximum value: 255 |
0 |
||||||||||||||||||||||||||
detectserver |
Gateway's ping server for this IP. |
user |
Not Specified |
|
||||||||||||||||||||||||||
detectprotocol |
Protocols used to detect the server. |
option |
- |
ping |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
ha-priority |
HA election priority for the PING server. |
integer |
Minimum value: 1 Maximum value: 50 |
1 |
||||||||||||||||||||||||||
fail-detect |
Enable/disable fail detection features for this interface. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
fail-detect-option |
Options for detecting that this interface has failed. |
option |
- |
link-down |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
fail-alert-method |
Select link-failed-signal or link-down method to alert about a failed link. |
option |
- |
link-down |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
fail-action-on-extender |
Action on FortiExtender when interface fail. |
option |
- |
soft-restart |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
fail-alert-interfaces |
Names of the FortiProxy interfaces to which the link failure alert is sent. Names of the non-virtual interface. |
string |
Maximum length: 79 |
|
||||||||||||||||||||||||||
dhcp-client-identifier |
DHCP client identifier. |
string |
Maximum length: 48 |
|
||||||||||||||||||||||||||
dhcp-renew-time |
DHCP renew time in seconds , 0 means use the renew time provided by the server. |
integer |
Minimum value: 300 Maximum value: 604800 |
0 |
||||||||||||||||||||||||||
ipunnumbered |
Unnumbered IP used for PPPoE interfaces for which no unique local address is provided. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||||||||||||||||||||
username |
Username of the PPPoE account, provided by your ISP. |
string |
Maximum length: 64 |
|
||||||||||||||||||||||||||
pppoe-unnumbered-negotiate |
Enable/disable PPPoE unnumbered negotiation. |
option |
- |
enable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
password |
PPPoE account's password. |
password |
Not Specified |
|
||||||||||||||||||||||||||
idle-timeout |
PPPoE auto disconnect after idle timeout seconds, 0 means no timeout. |
integer |
Minimum value: 0 Maximum value: 32767 |
0 |
||||||||||||||||||||||||||
detected-peer-mtu |
MTU of detected peer. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||||||||||
disc-retry-timeout |
Time in seconds to wait before retrying to start a PPPoE discovery, 0 means no timeout. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
1 |
||||||||||||||||||||||||||
padt-retry-timeout |
PPPoE Active Discovery Terminate (PADT) used to terminate sessions after an idle time. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
1 |
||||||||||||||||||||||||||
service-name |
PPPoE service name. |
string |
Maximum length: 63 |
|
||||||||||||||||||||||||||
ac-name |
PPPoE server name. |
string |
Maximum length: 63 |
|
||||||||||||||||||||||||||
lcp-echo-interval |
Time in seconds between PPPoE Link Control Protocol (LCP) echo requests. |
integer |
Minimum value: 0 Maximum value: 32767 |
5 |
||||||||||||||||||||||||||
lcp-max-echo-fails |
Maximum missed LCP echo messages before disconnect. |
integer |
Minimum value: 0 Maximum value: 32767 |
3 |
||||||||||||||||||||||||||
defaultgw |
Enable to get the gateway IP from the DHCP or PPPoE server. |
option |
- |
enable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
dns-server-override |
Enable/disable use DNS acquired by DHCP or PPPoE. |
option |
- |
enable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
dns-server-protocol |
DNS transport protocols. |
option |
- |
cleartext |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
auth-type |
PPP authentication type to use. |
option |
- |
auto |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
pptp-client |
Enable/disable PPTP client. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
pptp-user |
PPTP user name. |
string |
Maximum length: 64 |
|
||||||||||||||||||||||||||
pptp-password |
PPTP password. |
password |
Not Specified |
|
||||||||||||||||||||||||||
pptp-server-ip |
PPTP server IP address. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||||||||||||||||||||
pptp-auth-type |
PPTP authentication type. |
option |
- |
auto |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
pptp-timeout |
Idle timer in minutes (0 for disabled). |
integer |
Minimum value: 0 Maximum value: 65535 |
0 |
||||||||||||||||||||||||||
arpforward |
Enable/disable ARP forwarding. |
option |
- |
enable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
broadcast-forward |
Enable/disable broadcast forwarding. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
bfd |
Bidirectional Forwarding Detection (BFD) settings. |
option |
- |
global |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
bfd-desired-min-tx |
BFD desired minimal transmit interval. |
integer |
Minimum value: 1 Maximum value: 100000 |
250 |
||||||||||||||||||||||||||
bfd-detect-mult |
BFD detection multiplier. |
integer |
Minimum value: 1 Maximum value: 50 |
3 |
||||||||||||||||||||||||||
bfd-required-min-rx |
BFD required minimal receive interval. |
integer |
Minimum value: 1 Maximum value: 100000 |
250 |
||||||||||||||||||||||||||
l2forward |
Enable/disable l2 forwarding. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
icmp-send-redirect |
Enable/disable sending of ICMP redirects. |
option |
- |
enable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
icmp-accept-redirect |
Enable/disable ICMP accept redirect. |
option |
- |
enable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
stpforward |
Enable/disable STP forwarding. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
stpforward-mode |
Configure STP forwarding mode. |
option |
- |
rpl-all-ext-id |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
macaddr |
Change the interface's MAC address. |
mac-address |
Not Specified |
00:00:00:00:00:00 |
||||||||||||||||||||||||||
substitute-dst-mac |
Destination MAC address that all packets are sent to from this interface. |
mac-address |
Not Specified |
00:00:00:00:00:00 |
||||||||||||||||||||||||||
large-receive-offload |
Enable/disable large-receive-offload. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
generic-receive-offload |
Enable/disable generic-receive-offload. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
speed |
Interface speed. The default setting and the options available depend on the interface hardware. |
option |
- |
auto |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
status |
Bring the interface up or shut the interface down. |
option |
- |
up |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
netbios-forward |
Enable/disable NETBIOS forwarding. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
wins-ip |
WINS server IP. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||||||||||||||||||||
type |
Interface type. |
option |
- |
vlan |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
dedicated-to |
Configure interface for single purpose. |
option |
- |
none |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
trust-ip-1 |
Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts). |
ipv4-classnet-any |
Not Specified |
0.0.0.0 0.0.0.0 |
||||||||||||||||||||||||||
trust-ip-2 |
Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts). |
ipv4-classnet-any |
Not Specified |
0.0.0.0 0.0.0.0 |
||||||||||||||||||||||||||
trust-ip-3 |
Trusted host for dedicated management traffic (0.0.0.0/24 for all hosts). |
ipv4-classnet-any |
Not Specified |
0.0.0.0 0.0.0.0 |
||||||||||||||||||||||||||
trust-ip6-1 |
Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). |
ipv6-prefix |
Not Specified |
::/0 |
||||||||||||||||||||||||||
trust-ip6-2 |
Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). |
ipv6-prefix |
Not Specified |
::/0 |
||||||||||||||||||||||||||
trust-ip6-3 |
Trusted IPv6 host for dedicated management traffic (::/0 for all hosts). |
ipv6-prefix |
Not Specified |
::/0 |
||||||||||||||||||||||||||
mtu-override |
Enable to set a custom MTU for this interface. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
mtu |
MTU value for this interface. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
1500 |
||||||||||||||||||||||||||
ring-rx |
RX ring size. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||||||||||
ring-tx |
TX ring size. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||||||||||
wccp |
Enable/disable WCCP on this interface. Used for encapsulated WCCP communication between WCCP clients and servers. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
drop-overlapped-fragment |
Enable/disable drop overlapped fragment packets. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
drop-fragment |
Enable/disable drop fragment packets. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
src-check |
Enable/disable source IP check. |
option |
- |
enable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
explicit-web-proxy |
Enable/disable the explicit web proxy on this interface. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
explicit-ftp-proxy |
Enable/disable the explicit FTP proxy on this interface. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
proxy-captive-portal |
Enable/disable proxy captive portal on this interface. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
tcp-mss |
TCP maximum segment size. 0 means do not change segment size. |
integer |
Minimum value: 48 Maximum value: 65535 |
0 |
||||||||||||||||||||||||||
inbandwidth |
Bandwidth limit for incoming traffic , 0 means unlimited. |
integer |
Minimum value: 0 Maximum value: 80000000 |
0 |
||||||||||||||||||||||||||
outbandwidth |
Bandwidth limit for outgoing traffic. |
integer |
Minimum value: 0 Maximum value: 80000000 |
0 |
||||||||||||||||||||||||||
egress-shaping-profile |
Outgoing traffic shaping profile. |
string |
Maximum length: 35 |
|
||||||||||||||||||||||||||
ingress-shaping-profile |
Incoming traffic shaping profile. |
string |
Maximum length: 35 |
|
||||||||||||||||||||||||||
disconnect-threshold |
Time in milliseconds to wait before sending a notification that this interface is down or disconnected. |
integer |
Minimum value: 0 Maximum value: 10000 |
0 |
||||||||||||||||||||||||||
spillover-threshold |
Egress Spillover threshold , 0 means unlimited. |
integer |
Minimum value: 0 Maximum value: 16776000 |
0 |
||||||||||||||||||||||||||
ingress-spillover-threshold |
Ingress Spillover threshold , 0 means unlimited. |
integer |
Minimum value: 0 Maximum value: 16776000 |
0 |
||||||||||||||||||||||||||
weight |
Default weight for static routes (if route has no weight configured). |
integer |
Minimum value: 0 Maximum value: 255 |
0 |
||||||||||||||||||||||||||
interface |
Interface name. |
string |
Maximum length: 15 |
|
||||||||||||||||||||||||||
external |
Enable/disable identifying the interface as an external interface (which usually means it's connected to the Internet). |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
vlan-protocol |
Ethernet protocol of VLAN. |
option |
- |
8021q |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
vlanid |
VLAN ID. |
integer |
Minimum value: 1 Maximum value: 4094 |
0 |
||||||||||||||||||||||||||
forward-domain |
Transparent mode forward domain. |
integer |
Minimum value: 1 Maximum value: 4094 |
1 |
||||||||||||||||||||||||||
remote-ip |
Remote IP address of tunnel. |
ipv4-classnet-host |
Not Specified |
0.0.0.0 0.0.0.0 |
||||||||||||||||||||||||||
member |
Physical interfaces that belong to the aggregate or redundant interface. Physical interface name. |
string |
Maximum length: 79 |
|
||||||||||||||||||||||||||
lacp-mode |
LACP mode. |
option |
- |
|
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
lacp-ha-secondary |
LACP HA slave. |
option |
- |
enable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
system-id-type |
Method in which system ID is generated. |
option |
- |
auto |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
system-id |
Define a system ID for the aggregate interface. |
mac-address |
Not Specified |
00:00:00:00:00:00 |
||||||||||||||||||||||||||
lacp-speed |
How often the interface sends LACP messages. |
option |
- |
slow |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
min-links |
Minimum number of aggregated ports that must be up. |
integer |
Minimum value: 1 Maximum value: 32 |
1 |
||||||||||||||||||||||||||
min-links-down |
Action to take when less than the configured minimum number of links are active. |
option |
- |
operational |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
algorithm |
Frame distribution algorithm. |
option |
- |
L4 |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
link-up-delay |
Number of milliseconds to wait before considering a link is up. |
integer |
Minimum value: 50 Maximum value: 3600000 |
50 |
||||||||||||||||||||||||||
priority-override |
Enable/disable fail back to higher priority port once recovered. |
option |
- |
enable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
aggregate |
Aggregate interface. |
string |
Maximum length: 15 |
|
||||||||||||||||||||||||||
redundant-interface |
Redundant interface. |
string |
Maximum length: 15 |
|
||||||||||||||||||||||||||
devindex |
Device Index. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||||||||||
switch |
Contained in switch. |
string |
Maximum length: 15 |
|
||||||||||||||||||||||||||
description |
Description. |
var-string |
Maximum length: 255 |
|
||||||||||||||||||||||||||
alias |
Alias will be displayed with the interface name to make it easier to distinguish. |
string |
Maximum length: 25 |
|
||||||||||||||||||||||||||
security-mode |
Turn on captive portal authentication for this interface. |
option |
- |
none |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
security-mac-auth-bypass |
Enable/disable MAC authentication bypass. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
security-external-web |
URL of external authentication web server. |
var-string |
Maximum length: 1023 |
|
||||||||||||||||||||||||||
security-external-logout |
URL of external authentication logout server. |
string |
Maximum length: 127 |
|
||||||||||||||||||||||||||
replacemsg-override-group |
Replacement message override group. |
string |
Maximum length: 35 |
|
||||||||||||||||||||||||||
security-redirect-url |
URL redirection after disclaimer/authentication. |
var-string |
Maximum length: 1023 |
|
||||||||||||||||||||||||||
auth-cert |
HTTPS server certificate. |
string |
Maximum length: 35 |
|
||||||||||||||||||||||||||
auth-portal-addr |
Address of captive portal. |
string |
Maximum length: 63 |
|
||||||||||||||||||||||||||
security-exempt-list |
Name of security-exempt-list. |
string |
Maximum length: 35 |
|
||||||||||||||||||||||||||
security-groups |
User groups that can authenticate with the captive portal. Names of user groups that can authenticate with the captive portal. |
string |
Maximum length: 79 |
|
||||||||||||||||||||||||||
role |
Interface role. |
option |
- |
undefined |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
snmp-index |
Permanent SNMP Index of the interface. |
integer |
Minimum value: 1 Maximum value: 2147483647 |
0 |
||||||||||||||||||||||||||
secondary-IP |
Enable/disable adding a secondary IP to this interface. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
color |
Color of icon on the GUI. |
integer |
Minimum value: 0 Maximum value: 32 |
0 |
config client-options
Parameter |
Description |
Type |
Size |
Default |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||
code |
DHCP client option code. |
integer |
Minimum value: 0 Maximum value: 255 |
0 |
||||||||||
type |
DHCP client option type. |
option |
- |
hex |
||||||||||
|
|
|||||||||||||
value |
DHCP client option value. |
string |
Maximum length: 312 |
|
||||||||||
ip |
DHCP option IPs. |
user |
Not Specified |
|
config secondaryip
Parameter |
Description |
Type |
Size |
Default |
||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||||||||||
ip |
Secondary IP address of the interface. |
ipv4-classnet-host |
Not Specified |
0.0.0.0 0.0.0.0 |
||||||||||||||||||||||||||
allowaccess |
Management access settings for the secondary IP address. |
option |
- |
|
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
gwdetect |
Enable/disable detect gateway alive for first. |
option |
- |
disable |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
ping-serv-status |
PING server status. |
integer |
Minimum value: 0 Maximum value: 255 |
0 |
||||||||||||||||||||||||||
detectserver |
Gateway's ping server for this IP. |
user |
Not Specified |
|
||||||||||||||||||||||||||
detectprotocol |
Protocols used to detect the server. |
option |
- |
ping |
||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
ha-priority |
HA election priority for the PING server. |
integer |
Minimum value: 1 Maximum value: 50 |
1 |
config tagging
Parameter |
Description |
Type |
Size |
Default |
---|---|---|---|---|
name |
Tagging entry name. |
string |
Maximum length: 63 |
|
category |
Tag category. |
string |
Maximum length: 63 |
|
tags |
Tags. Tag name. |
string |
Maximum length: 79 |
|
config ipv6
Parameter |
Description |
Type |
Size |
Default |
||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ip6-mode |
Addressing mode (static, DHCP, delegated). |
option |
- |
static |
||||||||||||||||||
|
|
|||||||||||||||||||||
nd-mode |
Neighbor discovery mode. |
option |
- |
basic |
||||||||||||||||||
|
|
|||||||||||||||||||||
nd-cert |
Neighbor discovery certificate. |
string |
Maximum length: 35 |
|
||||||||||||||||||
nd-security-level |
Neighbor discovery security level. |
integer |
Minimum value: 0 Maximum value: 7 |
0 |
||||||||||||||||||
nd-timestamp-delta |
Neighbor discovery timestamp delta value. |
integer |
Minimum value: 1 Maximum value: 3600 |
300 |
||||||||||||||||||
nd-timestamp-fuzz |
Neighbor discovery timestamp fuzz factor. |
integer |
Minimum value: 1 Maximum value: 60 |
1 |
||||||||||||||||||
nd-cga-modifier |
Neighbor discovery CGA modifier. |
user |
Not Specified |
|
||||||||||||||||||
ip6-dns-server-override |
Enable/disable using the DNS server acquired by DHCP. |
option |
- |
enable |
||||||||||||||||||
|
|
|||||||||||||||||||||
ip6-address |
Primary IPv6 address prefix. Syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx. |
ipv6-prefix |
Not Specified |
::/0 |
||||||||||||||||||
ip6-allowaccess |
Allow management access to the interface. |
option |
- |
|
||||||||||||||||||
|
|
|||||||||||||||||||||
ip6-send-adv |
Enable/disable sending advertisements about the interface. |
option |
- |
disable |
||||||||||||||||||
|
|
|||||||||||||||||||||
icmp6-send-redirect |
Enable/disable sending of ICMPv6 redirects. |
option |
- |
enable |
||||||||||||||||||
|
|
|||||||||||||||||||||
ip6-manage-flag |
Enable/disable the managed flag. |
option |
- |
disable |
||||||||||||||||||
|
|
|||||||||||||||||||||
ip6-other-flag |
Enable/disable the other IPv6 flag. |
option |
- |
disable |
||||||||||||||||||
|
|
|||||||||||||||||||||
ip6-max-interval |
IPv6 maximum interval (4 to 1800 sec). |
integer |
Minimum value: 4 Maximum value: 1800 |
600 |
||||||||||||||||||
ip6-min-interval |
IPv6 minimum interval (3 to 1350 sec). |
integer |
Minimum value: 3 Maximum value: 1350 |
198 |
||||||||||||||||||
ip6-link-mtu |
IPv6 link MTU. |
integer |
Minimum value: 1280 Maximum value: 16000 |
0 |
||||||||||||||||||
ra-send-mtu |
Enable/disable sending link MTU in RA packet. |
option |
- |
enable |
||||||||||||||||||
|
|
|||||||||||||||||||||
ip6-reachable-time |
IPv6 reachable time (milliseconds; 0 means unspecified). |
integer |
Minimum value: 0 Maximum value: 3600000 |
0 |
||||||||||||||||||
ip6-retrans-time |
IPv6 retransmit time (milliseconds; 0 means unspecified). |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||
ip6-default-life |
Default life (sec). |
integer |
Minimum value: 0 Maximum value: 9000 |
1800 |
||||||||||||||||||
ip6-hop-limit |
Hop limit (0 means unspecified). |
integer |
Minimum value: 0 Maximum value: 255 |
0 |
||||||||||||||||||
autoconf |
Enable/disable address auto config. |
option |
- |
disable |
||||||||||||||||||
|
|
|||||||||||||||||||||
unique-autoconf-addr |
Enable/disable unique auto config address. |
option |
- |
disable |
||||||||||||||||||
|
|
|||||||||||||||||||||
interface-identifier |
IPv6 interface identifier. |
ipv6-address |
Not Specified |
:: |
||||||||||||||||||
ip6-prefix-mode |
Assigning a prefix from DHCP or RA. |
option |
- |
dhcp6 |
||||||||||||||||||
|
|
|||||||||||||||||||||
ip6-upstream-interface |
Interface name providing delegated information. |
string |
Maximum length: 15 |
|
||||||||||||||||||
ip6-delegated-prefix-iaid |
IAID of obtained delegated-prefix from the upstream interface. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||
ip6-subnet |
Subnet to routing prefix. Syntax: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx. |
ipv6-prefix |
Not Specified |
::/0 |
||||||||||||||||||
dhcp6-relay-service |
Enable/disable DHCPv6 relay. |
option |
- |
disable |
||||||||||||||||||
|
|
|||||||||||||||||||||
dhcp6-relay-type |
DHCPv6 relay type. |
option |
- |
regular |
||||||||||||||||||
|
|
|||||||||||||||||||||
dhcp6-relay-ip |
DHCPv6 relay IP address. |
user |
Not Specified |
|
||||||||||||||||||
dhcp6-client-options |
DHCPv6 client options. |
option |
- |
|
||||||||||||||||||
|
|
|||||||||||||||||||||
dhcp6-prefix-delegation |
Enable/disable DHCPv6 prefix delegation. |
option |
- |
disable |
||||||||||||||||||
|
|
|||||||||||||||||||||
dhcp6-information-request |
Enable/disable DHCPv6 information request. |
option |
- |
disable |
||||||||||||||||||
|
|
|||||||||||||||||||||
cli-conn6-status |
CLI IPv6 connection status. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
config ip6-extra-addr
Parameter |
Description |
Type |
Size |
Default |
---|---|---|---|---|
prefix |
IPv6 address prefix. |
ipv6-prefix |
Not Specified |
::/0 |
config ip6-prefix-list
Parameter |
Description |
Type |
Size |
Default |
||||||
---|---|---|---|---|---|---|---|---|---|---|
prefix |
IPv6 prefix. |
ipv6-network |
Not Specified |
::/0 |
||||||
autonomous-flag |
Enable/disable the autonomous flag. |
option |
- |
enable |
||||||
|
|
|||||||||
onlink-flag |
Enable/disable the onlink flag. |
option |
- |
enable |
||||||
|
|
|||||||||
valid-life-time |
Valid life time (sec). |
integer |
Minimum value: 0 Maximum value: 4294967295 |
2592000 |
||||||
preferred-life-time |
Preferred life time (sec). |
integer |
Minimum value: 0 Maximum value: 4294967295 |
604800 |
||||||
rdnss |
Recursive DNS server option. |
user |
Not Specified |
|
||||||
dnssl |
DNS search list option. Domain name. |
string |
Maximum length: 79 |
|
config ip6-delegated-prefix-list
Parameter |
Description |
Type |
Size |
Default |
||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
prefix-id |
Prefix ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||
upstream-interface |
Name of the interface that provides delegated information. |
string |
Maximum length: 15 |
|
||||||||
delegated-prefix-iaid |
IAID of obtained delegated-prefix from the upstream interface. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||
autonomous-flag |
Enable/disable the autonomous flag. |
option |
- |
enable |
||||||||
|
|
|||||||||||
onlink-flag |
Enable/disable the onlink flag. |
option |
- |
enable |
||||||||
|
|
|||||||||||
subnet |
Add subnet ID to routing prefix. |
ipv6-network |
Not Specified |
::/0 |
||||||||
rdnss-service |
Recursive DNS service option. |
option |
- |
specify |
||||||||
|
|
|||||||||||
rdnss |
Recursive DNS server option. |
user |
Not Specified |
|
config dhcp6-iapd-list
Parameter |
Description |
Type |
Size |
Default |
---|---|---|---|---|
iaid |
Identity association identifier. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
prefix-hint |
DHCPv6 prefix that will be used as a hint to the upstream DHCPv6 server. |
ipv6-network |
Not Specified |
::/0 |
prefix-hint-plt |
DHCPv6 prefix hint preferred life time (sec), 0 means unlimited lease time. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
604800 |
prefix-hint-vlt |
DHCPv6 prefix hint valid life time (sec). |
integer |
Minimum value: 0 Maximum value: 4294967295 |
2592000 |