From c32c2bcca47d1523a1797563955bc1e68991da15 Mon Sep 17 00:00:00 2001 From: Lukas Macura Date: Mon, 30 Jan 2017 14:23:22 +0100 Subject: [PATCH] Added docs --- booked/README.md | 1 + csv/README.md | 11 +++++++--- iwx/README.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 64 insertions(+), 3 deletions(-) create mode 100644 iwx/README.md diff --git a/booked/README.md b/booked/README.md index eb9e268..8fab994 100644 --- a/booked/README.md +++ b/booked/README.md @@ -7,6 +7,7 @@ This is usefull for scripting and alerting. ## How to use **Note:** If you need more info about installing zaf: https://github.com/limosek/zaf + **Note**: You can find more examples on [my site](https://macura.cz/search/node?keys=zaf) First, create account in Booked with required access to system and enable API. Next, simply install diff --git a/csv/README.md b/csv/README.md index a85740f..2340b0a 100644 --- a/csv/README.md +++ b/csv/README.md @@ -17,6 +17,7 @@ Defined items: csv.discovery.fields[] csv.discovery.rows[] ## How to use **Note:** If you need more info about installing zaf: https://github.com/limosek/zaf + **Note**: You can find more examples on [my site](https://macura.cz/search/node?keys=zaf) Simply instal zaf and after, install csv plugin @@ -78,20 +79,24 @@ Parameters: delimiter ',' '' ``` To discovery columns from CSV (first line of it). +Csv: +Name|Surname|Birth +Jon|Doe|2030 + ``` { "data" : [ { - "{#NAME}" : "root", + "{#NAME}" : "Name", "{#COLUMN}" : "0" }, { - "{#NAME}" : "x", + "{#NAME}" : "Surname", "{#COLUMN}" : "1" }, { + "{#NAME}" : "Birth" "{#COLUMN}" : "2", - "{#NAME}" : "0" } ] } diff --git a/iwx/README.md b/iwx/README.md new file mode 100644 index 0000000..41ac0b5 --- /dev/null +++ b/iwx/README.md @@ -0,0 +1,55 @@ +# Wireless device support for Zaf + +This plugin can be used for autodicsovery and query of wireless devices and neighbours. + +``` +Plugin 'iwx' version 0.5: + Plugin for wifi mac80211 informations and discovery + +Url: https://raw.githubusercontent.com/limosek/zaf-plugins/master/iwx + +Defined items: iwx.if_discovery iwx.phy_discovery iwx.channels_discovery[] iwx.clients_discovery[] iwx.neigh_discovery[] iwx.client_signal[] iwx.client_rxrate[] iwx.client_txrate[] iwx.neigh_ssid[] iwx.neigh_signal[] iwx.neigh_channel[] iwx.channel_noise[] iwx.channel_activetime[] iwx.channel_busytime[] iwx.channel_txtime[] iwx.channel_rxtime[] +Test items: iwx.channels_discovery[wlan0] iwx.clients_discovery[wlan0] iwx.neigh_discovery[wlan0] + +``` + +## How to use + +**Note:** If you need more info about installing zaf: https://github.com/limosek/zaf + +**Note**: You can find more examples on [my site](https://macura.cz/search/node?keys=zaf) + +Simply instal zaf and after, install csv plugin +``` +zaf install iwx +``` + +### Items ### + +``` +Item iwx.if_discovery + +Return: json + +``` + +``` +Item iwx.phy_discovery + +Return: json +``` + +``` +Item iwx.channels_discovery + +Cache: 600 + +Parameters: + dev wlan0 '' + +Return: json + +Testparameters: wlan0 +``` + +