prettier: re-format
Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.
Change-Id: I98fc77e75fa4bcfc331074e90c206f2bc8187e37
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
diff --git a/docs/snmp-configuration.md b/docs/snmp-configuration.md
index 87dcb78..2745bbe 100644
--- a/docs/snmp-configuration.md
+++ b/docs/snmp-configuration.md
@@ -6,8 +6,8 @@
There are a couple of ways through which the user can configure the Dbus-monitor
to generate the SNMP trap.
-* Interface added signal on the D-Bus object.
-* Properties changed signal on the D-Bus object.
+- Interface added signal on the D-Bus object.
+- Properties changed signal on the D-Bus object.
Other OpenBMC applications can still send the SNMP trap as needed. These
applications must use the API exposed by the libsnmp.
@@ -16,16 +16,15 @@
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. 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
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).
+libsnmp: Exposes the API to send the SNMP trap phosphor-network-snmpconf: Used
+for configuring the SNMP manager(Client).
# SNMP Manager Configuration
@@ -36,19 +35,18 @@
### 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```
+`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
-```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>```
+`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
### REST
-```curl -c cjar -b cjar -k -H "Content-Type: application/json" -X DELETE https://<hostname/ip>/xyz/openbmc_project/network/snmp/manager/<id>```
+`curl -c cjar -b cjar -k -H "Content-Type: application/json" -X DELETE https://<hostname/ip>/xyz/openbmc_project/network/snmp/manager/<id>`
### busctl
-```busctl call xyz.openbmc_project.Network.SNMP /xyz/openbmc_project/network/snmp/manager/<id> xyz.openbmc_project.Object.Delete Delete```
-
+`busctl call xyz.openbmc_project.Network.SNMP /xyz/openbmc_project/network/snmp/manager/<id> xyz.openbmc_project.Object.Delete Delete`