From d1c7f00bed5c3ebbec2a11046e996f6615291146 Mon Sep 17 00:00:00 2001
From: f0o <f0o@devilcode.org>
Date: Sun, 19 Jan 2014 13:52:34 +0100
Subject: [PATCH] Added wiki page. as discussed in #70

---
 doc/Interface-Description-Parsing.md | 55 ++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 doc/Interface-Description-Parsing.md

diff --git a/doc/Interface-Description-Parsing.md b/doc/Interface-Description-Parsing.md
new file mode 100644
index 0000000000..290541388d
--- /dev/null
+++ b/doc/Interface-Description-Parsing.md
@@ -0,0 +1,55 @@
+Table of Content:
+-   [About](#about)
+   -   [Setup](#setup)
+-   [Keywords](#keywords)
+   -   [Type-keywords](#type-keywords)
+   -   [Info-keywords](#info-keywords)
+-   [Examples](#examples)
+-   [Sourcecode](#source)
+
+# <a name="about">About</a>:
+
+Librenms can interpret, display and group certain additional information on ports.
+For this a small `bash` script is supplied in `librenms/scripts` called `ifAlias`. 
+
+<a name="setup">Setup</a>:
+
+This requires a little bit of setup on the monitored Server (Not the server running librenms!):
+
+*   Add `ifAlias` from `/path/to/librenms/scripts/` or download it from [here](#source) to the Server and make
+    it executeable `chmod +x /path/to/ifAlias`
+*   Add to `snmpd.conf` something like:
+    ``pass .1.3.6.1.2.1.31.1.1.1.18 /path/to/ifAlias``
+*   Restart your `net-snmpd`
+
+There are no changes to be made or additions to insteall for the polling librenms.
+
+Now you can set up your [keywords](#keywords) in your `/etc/network/interfaces`
+``//Add more distributions than just Debian based``
+
+# <a name="keywords">Keywords</a>:
+
+See [examples](#examples) for formats.
+
+* <a name="type-keywords">Type-keywords</a>:
+ * `Cust`    - Customer
+ * `Transit` - Transit link
+ * `Peering` - Peering link
+ * `Core`    - Infrastructure link (non-customer)
+ * `Server`  - Server link (non-customer)
+* <a name="info-keywords">Info-keywords</a>:
+ * `()` contains a note
+ * `{}` contains *your* circuit id
+ * `[]` contains the service type or speed
+
+# <a name="examples">Examples</a>:
+```text
+# eth3: Cust: Example Customer [10Mbit] (T1 Telco Y CCID129031) {EXAMP0001}`
+# eth0: Transit: Example Provider (AS65000)`
+# eth1: Core: core.router01 FastEthernet0/0 (Telco X CCID023141)`
+# eth2: Peering: Peering Exchange
+```
+
+# <a name="source">Sourcecode</a>:
+
+* https://github.com/librenms/librenms/blob/master/scripts/ifAlias
\ No newline at end of file