snmp-configuration: fix markdownlint issues
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I6efa7c47090f6ec9bbb639c7b15d4bb45e33004d
diff --git a/docs/snmp-configuration.md b/docs/snmp-configuration.md
index 2745bbe..a11ba66 100644
--- a/docs/snmp-configuration.md
+++ b/docs/snmp-configuration.md
@@ -1,5 +1,7 @@
# SNMP trap
+## Overview
+
phosphor-snmp currently only supports sending traps for error log entries.
Enabling that for a system can be done by adding phosphor-dbus-monitor rules.
@@ -16,37 +18,38 @@
call the library function.
The OpenBMC Notification management information base (MIB) extension can be
-found at the following location. It defines the object descriptions needed for a
-management application to be notified of an error entry in the OpenBMC log.
+found at the following [location][MIB]. It defines the object descriptions
+needed for a management application to be notified of an error entry in the
+OpenBMC log.
-https://github.com/openbmc/phosphor-snmp/tree/master/mibs
+[MIB]: https://github.com/openbmc/phosphor-snmp/tree/master/mibs
The phosphor-snmp repository exposes the following lib and the D-Bus service
libsnmp: Exposes the API to send the SNMP trap phosphor-network-snmpconf: Used
for configuring the SNMP manager(Client).
-# SNMP Manager Configuration
+## SNMP Manager Configuration
The administrator can configure one or more SNMP managers to receive the OpenBMC
traps.
-## Add the SNMP Manager
+### Add the SNMP Manager
-### REST
+#### Add via REST
`curl -c cjar -b cjar -k -H "Content-Type: application/json" -X POST -d '{"data": ["<snmp manager ip>", <port>] }' https://<hostname/ip>/xyz/openbmc_project/network/snmp/manager/action/Client`
-### busctl
+#### Add with busctl
`busctl call xyz.openbmc_project.Network.SNMP /xyz/openbmc_project/network/snmp/manager xyz.openbmc_project.Network.Client.Create Client sqs "<snmp manager ip>" <port>`
-## Delete the SNMP Manager
+### Delete the SNMP Manager
-### REST
+#### Delete via REST
`curl -c cjar -b cjar -k -H "Content-Type: application/json" -X DELETE https://<hostname/ip>/xyz/openbmc_project/network/snmp/manager/<id>`
-### busctl
+#### Delete with busctl
`busctl call xyz.openbmc_project.Network.SNMP /xyz/openbmc_project/network/snmp/manager/<id> xyz.openbmc_project.Object.Delete Delete`