summaryrefslogtreecommitdiffstats
path: root/census
diff options
context:
space:
mode:
authormakefu <github@syntax-fehler.de>2011-11-14 03:34:18 +0100
committermakefu <github@syntax-fehler.de>2011-11-14 03:34:18 +0100
commit9d7c537fd978f4848480b189ddb21f3b44eedec0 (patch)
tree339138bac758a4abe85389eb43f59cb23d18d2fe /census
parent397208108aebe171abded46aa4892aa32e6ff41d (diff)
//census: update Readme
Diffstat (limited to 'census')
-rw-r--r--census/README.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/census/README.md b/census/README.md
index e45d39c1..2842368d 100644
--- a/census/README.md
+++ b/census/README.md
@@ -1,13 +1,23 @@
-ARPING Users
+Census (formerly known as ARPING Users)
==========
This is a simplified python script which checks the available subnet for computers online and returns a list of users which are online based on their mac-address
+The initial idea was to find known users in the given network, now it finds and stores everyone in the given network and might try to resolve these addresses into names. This is why the name `census` is coined for the project.
-arping_users.py:
- call `python arping_users.py v` for verbose output -> print all discovered hosts
+Return Data
+----------
+after trying to reach all hosts in the selected subnets the script spits out th e following data:
+<pre>
+ { "timestamp" : 12345678, "data" : { "ip1" : ["mac1","mac2","macn"] }
+</pre>
+
+Census is meant to be put into a cronjob or some kind of wrapper scripts as it is currently really really (2-3 minutes) slow.
SNMPWALK Command
===============
+For historic reasons, this is the snmpwalk command to pull the currently registered mac-addresses on the firewall:
+<pre>
snmpwalk -c shammunity 10.42.0.1 1.3.6.1.2.1.3.1.1.2
+</pre>