Difference between revisions of "Manual:Routing/MME"

From MikroTik Wiki
Jump to: navigation, search
m (Protected "MME command reference": will be in manual [edit=sysop:move=sysop])
Line 1: Line 1:
This is MME configuration reference only; for description of the protocol and configuration examples see [[MME wireless routing protocol]].
+
{{Versions|v3, v4+}}
 +
 
 +
__TOC__
 +
 
 +
<div class=manual>
  
==Specifications==
+
==Summary==
Packages required: '''routing'''
+
<p id="shbox"><b>Sub-menu:</b> <code>/routing mme</code>
 +
<br />
 +
<b>Packages required:</b> <code>routing</code>
 +
</p>
 +
<br />
  
License required: Level1
+
<p>
 +
MME (Mesh Made Easy) is a MikroTik routing protocol suited for IP level routing in wireless mesh networks. It is based on ideas from B.A.T.M.A.N. (Better Approach To Mobile Ad-hoc Networking) routing protocol.
 +
</p>
  
Submenu level: '''/routing mme'''
+
<p>
 +
This is MME configuration reference only; for description of the protocol and configuration examples see [[MME wireless routing protocol]].
 +
</p>
  
 
==General Setup==
 
==General Setup==
  
====Property Description====
+
{{Mr-arg-table-h
 +
|prop=Property
 +
|desc=Description
 +
}}
  
'''origination-interval''' (''time''; default: '''5s''') - interval between originator messages. Obviously, this value should be less than '''timeout''' value.
+
{{Mr-arg-table
 +
|arg=origination-interval
 +
|type=time
 +
|default=5s
 +
|desc=Interval between originator messages. Obviously, this value should be less than '''timeout''' value.
 +
}}
  
'''timeout''' (''time''; default: '''1m''') - node timeout. If no messages at all are received from an originator node during this interval,
+
{{Mr-arg-table
 +
|arg=timeout
 +
|type=time
 +
|default=1m
 +
|desc=Node timeout. If no messages at all are received from an originator node during this interval,
 
that node is purged from protocol tables, and so are all routes it has announced.
 
that node is purged from protocol tables, and so are all routes it has announced.
 +
}}
  
'''bidirectional-timeout''' (''integer''; default: '''2''') - how many originator messages from a node can be lost in sequence, while still considering it a bidirectional neighbor. We are assuming that every node originates messages with the same rate as this router (i.e. the value from '''origination-interval''').
+
{{Mr-arg-table
 
+
|arg=bidirectional-timeout
'''ttl''' (''integer''; default: '''50''') - how many times to forward originator messages.
+
|type=integer
 +
|default=2
 +
|desc=How many originator messages from a node can be lost in sequence, while still considering it a bidirectional neighbor. We are assuming that every node originates messages with the same rate as this router (i.e. the value from '''origination-interval''').
 +
}}
  
'''gateway-class''' (''none | 56-KBit | 64-KBit | 128-KBit | 256-KBit | 512-KBit | 1-MBit | 2-MBit | 3-MBit | 5-MBit | 6-MBit | >6-MBit | integer''; default: '''none''') - announce internet gateway capability in the originator messages sent by this node.
+
{{Mr-arg-table
 +
|arg=ttl
 +
|type=integer
 +
|default=50
 +
|desc=How many times to forward originator messages.
 +
}}
  
The node running MME with gateway-class option is supposed to have a link to Internet and a default route to that. The symbolic values are compatible with B.A.T.M.A.N. This table describes the mapping from integers to symbolic values:
+
{{Mr-arg-table
          0 no gateway
+
|arg=gateway-class
          1 modem
+
|type=<nowiki>none | 56-KBit | 64-KBit | 128-KBit | 256-KBit | 512-KBit | 1-MBit | 2-MBit | 3-MBit | 5-MBit | 6-MBit | >6-MBit | integer</nowiki>
          2 ISDN
+
|default=none
          3 Double ISDN
+
|desc=Announce internet gateway capability in the originator messages sent by this node.
          3 256 KBit
+
}}
          5 UMTS/ 0.5 MBit
 
          6 1 MBit
 
          7 2 MBit
 
          8 3 MBit
 
          9 5 MBit
 
          10 6 MBit
 
          11 >6 MBit
 
Entering integer value > 11 means even better gateway class.
 
  
'''gateway-selection''' (''no-gateway | best-adjusted | best-statistic''; default: '''no-gateway''') - this node is a MME gateway protocol client.
+
{{Mr-arg-table
 +
|arg=gateway-selection
 +
|type=<nowiki>no-gateway | best-adjusted | best-statistic</nowiki>
 +
|default=no-gateway
 +
|desc=This node is a MME gateway protocol client.
 
* '''no-gateway''' - don't install default route via MME.
 
* '''no-gateway''' - don't install default route via MME.
 
* '''best-adjusted''' - select best gateway node based on received message statistics and announced gateway class;
 
* '''best-adjusted''' - select best gateway node based on received message statistics and announced gateway class;
 
* '''best-statistic''' - select best gateway node based only on received message statistics;
 
* '''best-statistic''' - select best gateway node based only on received message statistics;
 +
}}
  
'''gateway-keepalive''' (''time''; default: '''1m''') - the time interval between successive gateway keepalive messages.
+
{{Mr-arg-table
 +
|arg=gateway-keepalive
 +
|type=time
 +
|default=1m
 +
|desc=The time interval between successive gateway keepalive messages.
 
For gateway client, this specifies how often to send out keepalive messages.
 
For gateway client, this specifies how often to send out keepalive messages.
 
For gateway server, as client hold time is used 3 * '''gateway-keepalive''' seconds. If the server does not receive keepalive messages from a client during this time interval, the client is considered dead. All state information associated with it are deleted, including the dynamic IPIP tunnel.
 
For gateway server, as client hold time is used 3 * '''gateway-keepalive''' seconds. If the server does not receive keepalive messages from a client during this time interval, the client is considered dead. All state information associated with it are deleted, including the dynamic IPIP tunnel.
 +
}}
 +
 +
{{Mr-arg-table
 +
|arg=preferred-gateway
 +
|type=IP
 +
|default=0.0.0.0
 +
|desc=Always prefer this node as internet gateway to any others, if it is present in originator tables.
 +
}}
 +
 +
</table>
 +
 +
 +
{{ Note |
 +
The node running MME with gateway-class option is supposed to have a link to Internet and a default route to that. }}
 +
The symbolic values of <var>gateway-class</var> are compatible with B.A.T.M.A.N. This table describes the mapping from integers to symbolic values:
 +
<ul class="bullets">
 +
<li> 0 no gateway
 +
<li> 1 modem
 +
<li> 2 ISDN
 +
<li> 3 Double ISDN
 +
<li> 4 256 KBit
 +
<li> 5 UMTS/ 0.5 MBit
 +
<li> 6 1 MBit
 +
<li> 7 2 MBit
 +
<li> 8 3 MBit
 +
<li> 9 5 MBit
 +
<li> 10 6 MBit
 +
<li> <nowiki>11 >6 MBit</nowiki>
 +
</ul>
 +
Entering integer value > 11 means even better gateway class.
  
'''preferred-gateway''' (''IP address''; default: '''0.0.0.0''') - always prefer this node as internet gateway to any others, if it is present in originator tables.
 
  
 
==Interfaces==
 
==Interfaces==
Submenu level: '''/routing mme interface'''
+
<p id="shbox"><b>Sub-menu:</b> <code>/routing mme interface</code></p>
 +
<br />
 +
 
 +
<p> List of interfaces on which to run the MME protocol.</p>
  
''Description:'' List of interfaces on which to run the MME protocol.
+
{{Mr-arg-table-h
 +
|prop=Property
 +
|desc=Description
 +
}}
  
'''interface''' (''name''; default: '''all''') - interface on which MME will run
+
{{Mr-arg-table
 +
|arg=interface
 +
|type=string
 +
|default=all
 +
|desc=Interface on which MME will run
 
* '''all''' - is used for the interfaces not having any specific settings  
 
* '''all''' - is used for the interfaces not having any specific settings  
 +
}}
 +
 +
{{Mr-arg-table
 +
|arg=passive
 +
|type=<nowiki>yes | no </nowiki>
 +
|default=no
 +
|desc=If true, do not send originator messages via this interface, only receive.
 +
}}
 +
 +
{{Mr-arg-table
 +
|arg=primary
 +
|type=<nowiki>yes | no </nowiki>
 +
|default=no
 +
|desc=Include routing information (i.e. network announcements) in self-originated packets send via this interface. (For forwared packets the information is always included.) Only one interface can be primary. If no interfaces are configured as primary, one is selected automatically in a random fashion.
 +
}}
 +
</table>
 +
  
'''passive''' (''yes | no''; default: '''no''') - if true, do not send originator messages via this interface, only receive.
+
Command <code>/routing mme interface print status </code> allows to view status of interfaces.
  
'''primary''' (''yes | no''; default: '''no''') - include routing information (i.e. network announcements) in self-originated packets send via this interface. (For forwared packets the information is always included.) Only one interface can be primary. If no interfaces are configured as primary, one is selected automatically in a random fashion.
+
{{Mr-arg-table-h
 +
|prop=Property
 +
|desc=Description
 +
}}
  
'''messages-tx''' (''read only: integer'') - originator messages transmitted via this interface. For '''all''' interface: cumulative statistics.
+
{{Mr-arg-ro-table
 +
|arg=messages-tx
 +
|type=integer
 +
|desc=Originator messages transmitted via this interface. For '''all''' interface: cumulative statistics
 +
}}
  
'''messages-rx''' (''read only: integer'') - originator messages received via this interface. For '''all''' interface: cumulative statistics.
+
{{Mr-arg-ro-table
 +
|arg=messages-rx
 +
|type=integer
 +
|desc=Originator messages received via this interface. For '''all''' interface: cumulative statistics.
 +
}}
 +
</table>
  
 
==Networks==
 
==Networks==
Line 90: Line 192:
  
 
'''last-packet-before''' (''read-only: time'') - seconds elapsed since last received packet.
 
'''last-packet-before''' (''read-only: time'') - seconds elapsed since last received packet.
 +
 +
</div>
  
 
[[Category:Routing]]
 
[[Category:Routing]]

Revision as of 15:20, 6 May 2010

Version.png

Applies to RouterOS: v3, v4+

Summary

Sub-menu: /routing mme
Packages required: routing


MME (Mesh Made Easy) is a MikroTik routing protocol suited for IP level routing in wireless mesh networks. It is based on ideas from B.A.T.M.A.N. (Better Approach To Mobile Ad-hoc Networking) routing protocol.

This is MME configuration reference only; for description of the protocol and configuration examples see MME wireless routing protocol.

General Setup

Property Description
origination-interval (time; Default: 5s) Interval between originator messages. Obviously, this value should be less than timeout value.
timeout (time; Default: 1m) Node timeout. If no messages at all are received from an originator node during this interval, that node is purged from protocol tables, and so are all routes it has announced.
bidirectional-timeout (integer; Default: 2) How many originator messages from a node can be lost in sequence, while still considering it a bidirectional neighbor. We are assuming that every node originates messages with the same rate as this router (i.e. the value from origination-interval).
ttl (integer; Default: 50) How many times to forward originator messages.
gateway-class (none | 56-KBit | 64-KBit | 128-KBit | 256-KBit | 512-KBit | 1-MBit | 2-MBit | 3-MBit | 5-MBit | 6-MBit | >6-MBit | integer; Default: none) Announce internet gateway capability in the originator messages sent by this node.
gateway-selection (no-gateway | best-adjusted | best-statistic; Default: no-gateway) This node is a MME gateway protocol client.
  • no-gateway - don't install default route via MME.
  • best-adjusted - select best gateway node based on received message statistics and announced gateway class;
  • best-statistic - select best gateway node based only on received message statistics;
gateway-keepalive (time; Default: 1m) The time interval between successive gateway keepalive messages.

For gateway client, this specifies how often to send out keepalive messages.

For gateway server, as client hold time is used 3 * gateway-keepalive seconds. If the server does not receive keepalive messages from a client during this time interval, the client is considered dead. All state information associated with it are deleted, including the dynamic IPIP tunnel.
preferred-gateway (IP; Default: 0.0.0.0) Always prefer this node as internet gateway to any others, if it is present in originator tables.


Icon-note.png

Note: The node running MME with gateway-class option is supposed to have a link to Internet and a default route to that.


The symbolic values of gateway-class are compatible with B.A.T.M.A.N. This table describes the mapping from integers to symbolic values:

  • 0 no gateway
  • 1 modem
  • 2 ISDN
  • 3 Double ISDN
  • 4 256 KBit
  • 5 UMTS/ 0.5 MBit
  • 6 1 MBit
  • 7 2 MBit
  • 8 3 MBit
  • 9 5 MBit
  • 10 6 MBit
  • 11 >6 MBit

Entering integer value > 11 means even better gateway class.


Interfaces

Sub-menu: /routing mme interface


List of interfaces on which to run the MME protocol.

Property Description
interface (string; Default: all) Interface on which MME will run
  • all - is used for the interfaces not having any specific settings
passive (yes | no ; Default: no) If true, do not send originator messages via this interface, only receive.
primary (yes | no ; Default: no) Include routing information (i.e. network announcements) in self-originated packets send via this interface. (For forwared packets the information is always included.) Only one interface can be primary. If no interfaces are configured as primary, one is selected automatically in a random fashion.


Command /routing mme interface print status allows to view status of interfaces.

Property Description
messages-tx (integer) Originator messages transmitted via this interface. For all interface: cumulative statistics
messages-rx (integer) Originator messages received via this interface. For all interface: cumulative statistics.

Networks

Submenu level: /routing mme network

Description: MME Networks is a list of networks to be advertised.

network (IP prefix) - network to advertise

Notes

The usage of MME networks is similar to BGP networks, and different from IGP (i.e. RIP and OSPF) networks. They determine which networks to announce via MME, not on which networks to run the protocol.

Status

Submenu level: /routing mme status

Description: Read-only status information about the protocol. Currently has only one submenu: originators - information about active neighbor nodes.

originator (read-only: IP address) - the IP address of the node.

gateway (read-only: IP address) - the nexthop for this node.

gateway-class (read-only: none | 56-KBit | 64-KBit | 128-KBit | 256-KBit | 512-KBit | 1-MBit | 2-MBit | 3-MBit | 5-MBit | 6-MBit | >6-MBit | integer) - if none, then this node is not a gateway server. Otherwise this node is not a gateway server with specified gateway bandwidth.

last-packet-before (read-only: time) - seconds elapsed since last received packet.