diff options
| author | Victor Hu <whowutwut@gmail.com> | 2017-05-18 22:06:17 -0400 |
|---|---|---|
| committer | Patrick Williams <patrick@stwcx.xyz> | 2017-06-02 11:53:25 +0000 |
| commit | f1ba67758a153513bc7cf86b0070866c9b0d612b (patch) | |
| tree | 1a912bbd823305b41ccbd821cde0e07208618007 | |
| parent | 4b271e18b96bbb45492b098591bc8d7525a1522f (diff) | |
| download | phosphor-dbus-interfaces-f1ba67758a153513bc7cf86b0070866c9b0d612b.tar.gz phosphor-dbus-interfaces-f1ba67758a153513bc7cf86b0070866c9b0d612b.zip | |
Update README.md
Formatted the headings of the Network README file and fixed the
formatting that caused the eg. endpoints to not render correctly on the webpage.
Change-Id: I32863a668b9bba03f4a95eb762ad7d7203b7a601
Signed-off-by: Victor Hu <whowutwut@gmail.com>
| -rw-r--r-- | xyz/openbmc_project/Network/README.md | 45 |
1 files changed, 20 insertions, 25 deletions
diff --git a/xyz/openbmc_project/Network/README.md b/xyz/openbmc_project/Network/README.md index 9cf6101..9391c65 100644 --- a/xyz/openbmc_project/Network/README.md +++ b/xyz/openbmc_project/Network/README.md @@ -1,21 +1,20 @@ - Network Management - ================== -Overview -========= +# Network Management + +## Overview + A Network Manager is a daemon which handles network management operations. -It must implement the xyz.openbmc_project.Network.SystemConfiguration.interface -and org.freedesktop.DBus.ObjectManager. +It must implement the `xyz.openbmc_project.Network.SystemConfiguration.interface` +and `org.freedesktop.DBus.ObjectManager`. When the network manager daemon comes up, it should create objects implementing physical link/virtual interfaces such as -xyz.openbmc_project.Network.EthernetInterface or -xyz.openbmc_project.Network.VLANInterface on the system. +`xyz.openbmc_project.Network.EthernetInterface` or +`xyz.openbmc_project.Network.VLANInterface` on the system. IP address(v4 and v6) objects must be children objects of the physical/virtual interface object. -Interfaces -========== +## Interfaces 1. SystemConfiguration: This describes the system specific parameters. 2. EthernetInterface: This describes the interface specific parameters. @@ -24,36 +23,32 @@ Interfaces 5. VLANInterface: This describes the VLAN specific properties. 6. Bond: This describes the interface bonding parameters. -DbusObjects: +# DbusObjects + +## Interface Objects -Interface Objects -================= Interface objects can be physical as well as virtual. If the object is physical interface, it can't be deleted, but if it is a virtual interface object it can be deleted. -eg: -/xyz/openbmc_project/network/<interfacename>: +eg: `/xyz/openbmc_project/network/<interfacename>` + +## IPAddress Objects -IPAddress Objects -================= There can be multiple ip address objects under an interface object. These objects can be deleted by the delete function. IPv4 object will have the following dbus object path. -eg: -/xyz/openbmc_project/network/<interface>/<ipv4>/0/ +eg: `/xyz/openbmc_project/network/<interface>/<ipv4>/<id>/` IPv6 object will have the following dbus object path. -eg: -/xyz/openbmc_project/network/<interface>/<ipv6>/0/ +eg: `/xyz/openbmc_project/network/<interface>/<ipv6>/<id>/` + +## Conf Object -Conf Object -=========== This object will have the system configuration related parameters. -eg: -/xyz/openbmc_project/network/conf +eg: `/xyz/openbmc_project/network/conf` |
