Difference between revisions of "Manual:Interface"

From MikroTik Wiki
Jump to navigation Jump to search
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Versions|v3, v4}}
{{Versions|v3, v4 +}}


<div class=manual>
<div class=manual>


<h2>Summary</h2>
==Sub Categories==
<p><b>Sub-menu:</b> <code>/interface</code></p>
 
<br />
{{ycgu-cooltable-3
<p>
|title-left='''List of reference sub-pages'''
MikroTik RouterOS supports a variety of Network Interface Cards as well as virtual interfaces (like Bonding, Bridge, VLAN etc.). Each of them has its own submenu, but common properties of all interfaces can be configured and read in general interface menu.
|title-center='''Case studies'''
</p>
|title-right='''List of examples'''
|content-left=
<splist
showparent=yes
/>
 
|content-center=
<DynamicPageList>
category = Interface
category = Manual
category = Case Studies
namespace = Manual
shownamespace = false
</DynamicPageList>
 
 
|content-right=
<DynamicPageList>
category = Manual
category = Interface
category = Examples
namespace = Manual
shownamespace = false
</DynamicPageList>
 
}}
 
==Summary==
<p id="shbox"><b>Sub-menu:</b> <code>/interface</code></p>
 
MikroTik RouterOS supports a variety of Network Interface Cards as well as virtual interfaces (e.g. Bonding, Bridge, VLAN etc.). Each of them have their own sub-menu, but common properties of all interfaces can be configured and read in the general interface menu.


<h2>Properties</h2>
==Properties==


<br />
<table class="styled_table">


{{Mr-arg-table-h
{{Mr-arg-table-h
Line 34: Line 62:
}}
}}


{{Mr-arg-table
{{Mr-arg-table-end
|arg=name
|arg=name
|type=string
|type=string
Line 42: Line 70:




</table>
===Read-only properties===
 
<h3>Read-only properties</h3>
 
<table class="styled_table">


{{Mr-arg-table-h
{{Mr-arg-table-h
Line 54: Line 78:


{{Mr-arg-ro-table
{{Mr-arg-ro-table
|arg=bytes
|arg=bindstr
|type=integer/integer
|type=
|desc=Total received and transmitted bytes by interface since startup. [[#Stats | Read more>> ]]
|desc=
}}
 
{{Mr-arg-ro-table
|arg=bindstr2
|type=
|desc=
}}
}}


{{Mr-arg-ro-table
{{Mr-arg-ro-table
|arg=drops
|arg=caps
|type=integer/integer
|type=
|desc=packets not sent/received because interface queue is full (no free descriptors), dma engine overrun/underrun. [[#Stats | Read more>> ]]
|desc=
}}
}}
{{Mr-arg-ro-table
|arg=default-name
|type=
|desc=
}}


{{Mr-arg-ro-table
{{Mr-arg-ro-table
|arg=dynamic
|arg=dynamic
|type=<nowiki>yes|no</nowiki>
|type=yes{{!}}no
|desc=Whether interface is dynamically created
|desc=Whether interface is dynamically created
}}
}}


{{Mr-arg-ro-table
{{Mr-arg-ro-table
|arg=errors
|arg=default-name
|type=integer/integer
|type=
|desc=Packets received with some kind of error or not transimitted because of some error. [[#Stats | Read more>> ]]
|desc=
}}
 
{{Mr-arg-ro-table
|arg=fast-path
|type=yes {{!}} no
|desc=
}}
 
{{Mr-arg-ro-table
|arg=flags
|type=
|desc=
}}
 
{{Mr-arg-ro-table
|arg=id
|type=integer
|desc=interface id
}}
 
{{Mr-arg-ro-table
|arg=ifindex
|type=integer
|desc=interface index
}}
 
{{Mr-arg-ro-table
|arg=ifname
|type=string
|desc=interface name in Linux kernel
}}
 
{{Mr-arg-ro-table
|arg=mac-address
|type=MAC
|desc=
}}
}}


{{Mr-arg-ro-table
{{Mr-arg-ro-table
|arg=packets
|arg=max-l2mtu
|type=integer/integer
|type=integer
|desc=Total count of packets on interface since startup. [[#Stats | Read more>> ]]
|desc=Max supported L2MTU
}}
}}


Line 86: Line 159:
|arg=running
|arg=running
|type=<nowiki>yes|no</nowiki>
|type=<nowiki>yes|no</nowiki>
|desc=Whether interface is running. Note that some interface does not have running check and they are always reported as "running"
|desc=Whether interface is running. Note that some interfaces may not have a 'running check' and they will always be reported as "running" (e.g. [[EoIP]])
}}
 
{{Mr-arg-ro-table
|arg=rx-byte
|type=integer
|desc=Number of received bytes. [[#Stats | Read more>> ]]
}}
 
{{Mr-arg-ro-table
|arg=rx-drop
|type=integer
|desc=Number of received packets being dropped [[#Stats | Read more>> ]]
}}
 
{{Mr-arg-ro-table
|arg=rx-errors
|type=integer
|desc=Packets received with some kind of an error. [[#Stats | Read more>> ]]
}}
 
{{Mr-arg-ro-table
|arg=rx-packet
|type=integer
|desc=Number of packets received. [[#Stats | Read more>> ]]
}}
}}


Line 96: Line 193:


{{Mr-arg-ro-table
{{Mr-arg-ro-table
|arg=dynamic
|arg=status
|type=<nowiki>yes|no</nowiki>
|type=string
|desc=Whether interface is dynamically created
|desc=
}}
 
{{Mr-arg-ro-table
|arg=tx-byte
|type=integer
|desc=Number of transmitted bytes. [[#Stats | Read more>> ]]
}}
}}


{{Mr-arg-ro-table
{{Mr-arg-ro-table
|arg=type
|arg=tx-drop
|type=string
|type=integer
|desc=Type of an interface (ethernet, wireless, etc.)
|desc=Number of transmitted packets being dropped [[#Stats | Read more>> ]]
}}
}}


</table>
{{Mr-arg-ro-table
|arg=tx-errors
|type=integer
|desc=Packets transmitted with some kind of an error. [[#Stats | Read more>> ]]
}}


<h2>Traffic monitor</h2>
{{Mr-arg-ro-table-end
|arg=tx-packet
|type=integer
|desc=Number of transmitted packets. [[#Stats | Read more>> ]]
}}
 
==Traffic monitor==
<br />
<br />
The traffic passing through any interface can be monitored using following command: <br />
The traffic passing through any interface can be monitored using following command: <br />
Line 127: Line 240:
</pre>
</pre>


<h2>Stats</h2>
==Stats==


RouterOS v3.22 introduces a new command:
RouterOS v3.22 introduces a new command:
 
<pre>
  /interface print stats
  /interface print stats
 
</pre>


This command prints total [[#Read-only_properties | packets, bytes, drops and errors]].
This command prints total [[#Read-only_properties | packets, bytes, drops and errors]].
Line 140: Line 253:


[[#Traffic_monitor | Traffic monitor]] now also displays errors per second, in addition to the usual stats:  
[[#Traffic_monitor | Traffic monitor]] now also displays errors per second, in addition to the usual stats:  
 
<pre>
  /interface monitor-traffic
  /interface monitor-traffic
 
</pre>
<code>/interface ethernet print stats</code> will display all kinds of other statistics if the interface is supporting them (currently only RB450G ether2-ether5 and also RB750 ether2-ether5).  
<code>/interface ethernet print stats</code> will display all kinds of other statistics if the interface is supporting them (currently only RB450G ether2-ether5 and also RB750 ether2-ether5).  


</div>
</div>


{{Cont}}
{{Cont}}


[[Category:Manual]]
[[Category:Manual|I]]
[[Category:Routerboard]]
[[Category:Routerboard|I]]
[[Category:Hardware]]
[[Category:Hardware|I]]

Latest revision as of 15:02, 3 March 2014

Version.png

Applies to RouterOS: v3, v4 +

Sub Categories

List of reference sub-pages

Case studies

List of examples

Summary

Sub-menu: /interface

MikroTik RouterOS supports a variety of Network Interface Cards as well as virtual interfaces (e.g. Bonding, Bridge, VLAN etc.). Each of them have their own sub-menu, but common properties of all interfaces can be configured and read in the general interface menu.

Properties

Property Description
l2mtu (integer; Default: ) Layer2 Maximum transmission unit. Note that this property can not be configured on all interfaces. Read more>>
mtu (integer; Default: ) Layer3 Maximum transmission unit
name (string; Default: ) Name of an interface


Read-only properties

Property Description
bindstr ()
bindstr2 ()
caps ()
default-name ()
dynamic (yes|no) Whether interface is dynamically created
default-name ()
fast-path (yes | no)
flags ()
id (integer) interface id
ifindex (integer) interface index
ifname (string) interface name in Linux kernel
mac-address (MAC)
max-l2mtu (integer) Max supported L2MTU
running (yes|no) Whether interface is running. Note that some interfaces may not have a 'running check' and they will always be reported as "running" (e.g. EoIP)
rx-byte (integer) Number of received bytes. Read more>>
rx-drop (integer) Number of received packets being dropped Read more>>
rx-errors (integer) Packets received with some kind of an error. Read more>>
rx-packet (integer) Number of packets received. Read more>>
slave (yes|no) Whether interface is configured as a slave of another interface (for example Bonding)
status (string)
tx-byte (integer) Number of transmitted bytes. Read more>>
tx-drop (integer) Number of transmitted packets being dropped Read more>>
tx-errors (integer) Packets transmitted with some kind of an error. Read more>>
tx-packet (integer) Number of transmitted packets. Read more>>

Traffic monitor


The traffic passing through any interface can be monitored using following command:
/interface monitor-traffic [id | name]

For example monitor ether2 and aggregate traffic. Aggregate is used to monitor total ammount of traffic handled by the router:

[maris@maris_main] > /interface monitor-traffic ether2,aggregate 
    rx-packets-per-second: 9        14
      rx-drops-per-second: 0        0
     rx-errors-per-second: 0        0
       rx-bits-per-second: 6.6kbps  10.2kbps
    tx-packets-per-second: 9        12
      tx-drops-per-second: 0        0
     tx-errors-per-second: 0        0
       tx-bits-per-second: 13.6kbps 15.8kbps

Stats

RouterOS v3.22 introduces a new command:

 /interface print stats

This command prints total packets, bytes, drops and errors.

All interfaces that support this feature will be displayed. Some interfaces are not supporting Error and Drop counters at the moment (RB4XX except RB450G ether 2-5), these devices will not display these counters.


Traffic monitor now also displays errors per second, in addition to the usual stats:

 /interface monitor-traffic

/interface ethernet print stats will display all kinds of other statistics if the interface is supporting them (currently only RB450G ether2-ether5 and also RB750 ether2-ether5).


[ Top | Back to Content ]