upd readme, snmplib

infrasonar · Feb 6, 2023 · 5328ecf · 5328ecf
1 parent 481fdf7
commit 5328ecf
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -22,3 +22,36 @@ Variable            | Default                        | Description
 ```
 docker build -t synology-probe . --no-cache
 ```
+
+## Config
+
+See the [SNMP probe](https://github.com/infrasonar/snmp-probe#config).
+
+## Dry run
+
+Available checks:
+- `disk`
+- `diskSMART`
+- `ebox`
+- `iSCSILUN`
+- `raid`
+- `service`
+- `spaceIO`
+- `storageIO`
+- `system`
+
+Create a yaml file, for example _(test.yaml)_:
+
+```yaml
+asset:
+  name: "foo.local"
+  check: "system"
+  config:
+    address: "192.168.1.2"
+```
+
+Run the probe with the `DRY_RUN` environment variable set the the yaml file above.
+
+```
+DRY_RUN=test.yaml python main.py
+```
diff --git a/lib/version.py b/lib/version.py
@@ -1,4 +1,4 @@
 # Version string. Examples:
 #  '3.0.0'
 #  '3.0.0-alpha9'
-__version__ = '3.0.1-alpha1'
+__version__ = '3.0.1-alpha2'
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,2 @@
-asyncsnmplib==0.1.8
+asyncsnmplib==0.1.9
 libprobe==0.2.27