Fix MD033 warnings
The following warnings are generated by using markdownlint analysis:
```
docs/Network-Configuration.md:60:70 MD033/no-inline-html Inline HTML [Element: interface]
docs/Network-Configuration.md:62:49 MD033/no-inline-html Inline HTML [Element: ip]
docs/Network-Configuration.md:62:55 MD033/no-inline-html Inline HTML [Element: subnetmask]
docs/Network-Configuration.md:63:2 MD033/no-inline-html Inline HTML [Element: networkgateway]
docs/Network-Configuration.md:66:59 MD033/no-inline-html Inline HTML [Element: ip]
docs/Network-Configuration.md:66:79 MD033/no-inline-html Inline HTML [Element: networkGateway]
docs/Network-Configuration.md:66:65 MD033/no-inline-html Inline HTML [Element: subnetmask]
docs/Network-Configuration.md:85:2 MD033/no-inline-html Inline HTML [Element: DefaultGateway]
docs/Network-Configuration.md:109:61 MD033/no-inline-html Inline HTML [Element: HostName]
docs/Network-Configuration.md:112:2 MD033/no-inline-html Inline HTML [Element: hostname]
docs/Network-Configuration.md:118:47 MD033/no-inline-html Inline HTML [Element: id]
docs/Network-Configuration.md:118:30 MD033/no-inline-html Inline HTML [Element: interface]
```
Refer to markdown-lint [1] to fix MD033
[1]: https://github.com/updownpress/markdown-lint/blob/master/rules/033-no-inline-html.md
Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: I3663a69b9a250a4fbfa071716413ce1ea21a3257
diff --git a/docs/Network-Configuration.md b/docs/Network-Configuration.md
index a5dcea5..7b7004d 100644
--- a/docs/Network-Configuration.md
+++ b/docs/Network-Configuration.md
@@ -57,6 +57,7 @@
## Configure IP address:
+```sh
busctl call xyz.openbmc_project.Network /xyz/openbmc_project/network/<interface>
xyz.openbmc_project.Network.IP.Create IP ssys
"xyz.openbmc_project.Network.IP.Protocol.IPv4" "<ip>" <subnetmask>
@@ -65,20 +66,24 @@
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X POST -d
'{"data":["xyz.openbmc_project.Network.IP.Protocol.IPv4","<ip>",<subnetmask>,"<networkGateway>"]
}' https://<hostname/ip>/xyz/openbmc_project/network/eth0/action/IP
+```
## Configure Default Gateway
### Get
+```sh
busctl get-property xyz.openbmc_project.Network
/xyz/openbmc_project/network/config
xyz.openbmc_project.Network.SystemConfiguration DefaultGateway
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET
https://<hostname/ip>/xyz/openbmc_project/network/config/attr/DefaultGateway
+```
### Set
+```sh
busctl set-property xyz.openbmc_project.Network
/xyz/openbmc_project/network/config
xyz.openbmc_project.Network.SystemConfiguration DefaultGateway s
@@ -87,6 +92,7 @@
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X PUT -d '{"data":
"x.x.x.x"}'
https://<hostname/ip>/xyz/openbmc_project/network/config/attr/DefaultGateway
+```
NOTE: Since the system does not allow unpingable gateway address, make sure the
gateway address is pingable.
@@ -95,15 +101,18 @@
### Get
+```sh
busctl get-property xyz.openbmc_project.Network
/xyz/openbmc_project/network/config
xyz.openbmc_project.Network.SystemConfiguration HostName
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET
https://<hostname/ip>/xyz/openbmc_project/network/config/attr/HostName
+```
### Set
+```sh
busctl set-property xyz.openbmc_project.Network
/xyz/openbmc_project/network/config
xyz.openbmc_project.Network.SystemConfiguration HostName s "<HostName>"
@@ -111,55 +120,67 @@
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X PUT -d '{"data":
"<hostname>"}'
https://<hostname/ip>/xyz/openbmc_project/network/config/attr/HostName
+```
## Delete IP address
+```sh
busctl call xyz.openbmc_project.Network
/xyz/openbmc_project/network/<interface>/ipv4/<id>
xyz.openbmc_project.Object.Delete Delete
+```
NOTE: How to get the ipv4/id: After creating the IP address object enumerate the
network interface object.
+```sh
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X DELETE
https://<hostname/ip>/xyz/openbmc_project/network/eth0/ipv4/fbfc29b
+```
## Configure DHCP
### Get
+```sh
busctl get-property xyz.openbmc_project.Network
/xyz/openbmc_project/network/eth0 xyz.openbmc_project.Network.EthernetInterface
DHCPEnabled
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET
https://<hostname/ip>/xyz/openbmc_project/network/eth0/attr/DHCPEnabled
+```
### Set
+```sh
busctl set-property xyz.openbmc_project.Network
/xyz/openbmc_project/network/eth0 xyz.openbmc_project.Network.EthernetInterface
DHCPEnabled b 1
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X PUT -d '{"data":
1}' https://<hostname/ip>/xyz/openbmc_project/network/eth0/attr/DHCPEnabled
+```
## Configure MACAddress
### Get
+```sh
busctl get-property xyz.openbmc_project.Network
/xyz/openbmc_project/network/eth0 xyz.openbmc_project.Network.MACAddress
MACAddress
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET
https://<hostname/ip>/xyz/openbmc_project/network/eth0/attr/MACAddress
+```
### Set
NOTE: MAC address should be LOCAL ADMIN MAC (2nd bit of first byte should be
on).
+```sh
busctl set-property xyz.openbmc_project.Network
/xyz/openbmc_project/network/eth0 xyz.openbmc_project.Network.MACAddress
MACAddress s "XX:XX:XX:XX:XX:XX"
@@ -167,35 +188,44 @@
curl -c cjar -b cjar -k -H "Content-Type: application/jon" -X PUT -d '{"data":
"XX:XX:XX:XX:XX:XX" }'
https://<hostname/ip>/xyz/openbmc_project/network/eth0/attr/MACAddress
+```
## Network factory reset
+```sh
busctl call xyz.openbmc_project.Network /xyz/openbmc_project/network
xyz.openbmc_project.Common.FactoryReset Reset
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X POST -d
'{"data":[] }' https://<hostname/ip>/xyz/openbmc_project/network/action/Reset
+```
## VLAN
### Create
+```sh
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X POST -d
'{"data":["eth0",50] }'
https://<hostname/ip>/xyz/openbmc_project/network/action/VLAN
+```
### Delete
+```sh
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X DELETE
https://<hostname/ip>/xyz/openbmc_project/network/eth0_50
busctl call xyz.openbmc_project.Network /xyz/openbmc_project/network/eth0_50
xyz.openbmc_project.Object.Delete Delete
+```
### Enumerate
+```sh
curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET
https://<hostname/ip>/xyz/openbmc_project/network/eth0_50/enumerate
+```
### Configure IP on VLAN Interface