openbmc_project/Network/README.md

1 # Network Management
5 A Network Manager is a daemon which handles network management operations. It
6 must implement the `xyz.openbmc_project.Network.SystemConfiguration.interface`
9 When the network manager daemon comes up, it should create objects implementing
11 `xyz.openbmc_project.Network.EthernetInterface` or
12 `xyz.openbmc_project.Network.VLANInterface` on the system.
35 E.g. `/xyz/openbmc_project/network/<interfacename>`
44 `/xyz/openbmc_project/network/<interface>/ipv4/<id>`
48 `/xyz/openbmc_project/network/<interface>/ipv6/<id>`
50 ### Network Configuration Object
52 The network configuration object will have system configuration parameters:
54 `/xyz/openbmc_project/network/conf`
61 busctl call xyz.openbmc_project.Network \
62     /xyz/openbmc_project/network/<interface> \
63     xyz.openbmc_project.Network.IP.Create \
64     IP ssys "xyz.openbmc_project.Network.IP.Protocol.IPv4" \
65     "<IP Address>" <Netmask Prefix> "<Network Gateway>"
72                 "xyz.openbmc_project.Network.IP.Protocol.IPv4",
75                 "<Network Gateway>"
78     https://${bmc}/xyz/openbmc_project/network/<interface>/action/IP
87                 "xyz.openbmc_project.Network.IP.Protocol.IPv4",
93     https://${bmc}/xyz/openbmc_project/network/eth0/action/IP
96 Note: After creating the IP address object enumerate the network interface
102 busctl call xyz.openbmc_project.Network \
103     /xyz/openbmc_project/network/<interface>/ipv4/<id> \
109     https://${bmc}/xyz/openbmc_project/network/<interface>/ipv4/<id>
117 busctl get-property xyz.openbmc_project.Network \
118     /xyz/openbmc_project/network/config \
119     xyz.openbmc_project.Network.SystemConfiguration DefaultGateway
124     https://${bmc}/xyz/openbmc_project/network/config/attr/DefaultGateway
130 busctl set-property xyz.openbmc_project.Network \
131     /xyz/openbmc_project/network/config \
132     xyz.openbmc_project.Network.SystemConfiguration \
139     https://${bmc}/xyz/openbmc_project/network/config/attr/DefaultGateway
149 busctl get-property xyz.openbmc_project.Network \
150     /xyz/openbmc_project/network/config \
151     xyz.openbmc_project.Network.SystemConfiguration HostName
156     https://${bmc}/xyz/openbmc_project/network/config/attr/HostName
162 busctl set-property xyz.openbmc_project.Network \
163     /xyz/openbmc_project/network/config \
164     xyz.openbmc_project.Network.SystemConfiguration HostName s "<HostName>"
170     https://${bmc}/xyz/openbmc_project/network/config/attr/HostName
178 busctl get-property xyz.openbmc_project.Network \
179     /xyz/openbmc_project/network/eth0 \
180     xyz.openbmc_project.Network.EthernetInterface DHCPEnabled
185     https://${bmc}/xyz/openbmc_project/network/eth0/attr/DHCPEnabled
191 busctl set-property xyz.openbmc_project.Network \
192     /xyz/openbmc_project/network/eth0 \
193     xyz.openbmc_project.Network.EthernetInterface DHCPEnabled b 1
199     https://${bmc}/xyz/openbmc_project/network/eth0/attr/DHCPEnabled
207 busctl get-property xyz.openbmc_project.Network \
208     /xyz/openbmc_project/network/eth0 \
209     xyz.openbmc_project.Network.MACAddress MACAddress
214     https://${bmc}/xyz/openbmc_project/network/<interface>/attr/MACAddress
220 busctl set-property xyz.openbmc_project.Network \
221     /xyz/openbmc_project/network/<interface> \
222     xyz.openbmc_project.Network.MACAddress MACAddress s "<MAC Address>"
228     https://${bmc}/xyz/openbmc_project/network/<interface>/attr/MACAddress
234 ### Network Factory Reset
237 busctl call xyz.openbmc_project.Network /xyz/openbmc_project/network \
243     -d '{"data":[] }' https://${bmc}/xyz/openbmc_project/network/action/Reset
251 busctl call xyz.openbmc_project.Network /xyz/openbmc_project/network \
252     xyz.openbmc_project.Network.VLAN.Create VLAN su "<interface>" <VLAN id>
258     https://${bmc}/xyz/openbmc_project/network/action/VLAN
266     https://${bmc}/xyz/openbmc_project/network/action/VLAN
272 busctl call xyz.openbmc_project.Network \
273     /xyz/openbmc_project/network/<VLAN interface> \
279     https://${bmc}/xyz/openbmc_project/network/<VLAN interface>
286     https://${bmc}/xyz/openbmc_project/network/eth0_50
293     https://${bmc}/xyz/openbmc_project/network/<VLAN interface>/enumerate