phosphor-networkd/docs/Network-Configuration.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 Example: `/xyz/openbmc_project/network/eth0`
44 Example: `/xyz/openbmc_project/network/eth0/ipv4/3fd41d13/`
48 Example: `/xyz/openbmc_project/network/eth0/ipv6/5dfghilp/`
54 Example: `/xyz/openbmc_project/network/conf`
61 busctl call xyz.openbmc_project.Network /xyz/openbmc_project/network/<interface>
62 xyz.openbmc_project.Network.IP.Create IP ssys
63 "xyz.openbmc_project.Network.IP.Protocol.IPv4" "<ip>" <subnetmask>
67 '{"data":["xyz.openbmc_project.Network.IP.Protocol.IPv4","<ip>",<subnetmask>,"<networkGateway>"]
68 }' https://<hostname/ip>/xyz/openbmc_project/network/eth0/action/IP
76 busctl get-property xyz.openbmc_project.Network
77 /xyz/openbmc_project/network/config
78 xyz.openbmc_project.Network.SystemConfiguration DefaultGateway
81 https://<hostname/ip>/xyz/openbmc_project/network/config/attr/DefaultGateway
87 busctl set-property xyz.openbmc_project.Network
88 /xyz/openbmc_project/network/config
89 xyz.openbmc_project.Network.SystemConfiguration DefaultGateway s
94 https://<hostname/ip>/xyz/openbmc_project/network/config/attr/DefaultGateway
105 busctl get-property xyz.openbmc_project.Network
106 /xyz/openbmc_project/network/config
107 xyz.openbmc_project.Network.SystemConfiguration HostName
110 https://<hostname/ip>/xyz/openbmc_project/network/config/attr/HostName
116 busctl set-property xyz.openbmc_project.Network
117 /xyz/openbmc_project/network/config
118 xyz.openbmc_project.Network.SystemConfiguration HostName s "<HostName>"
122 https://<hostname/ip>/xyz/openbmc_project/network/config/attr/HostName
128 busctl call xyz.openbmc_project.Network
129 /xyz/openbmc_project/network/<interface>/ipv4/<id>
134 network interface object.
138 https://<hostname/ip>/xyz/openbmc_project/network/eth0/ipv4/fbfc29b
146 busctl get-property xyz.openbmc_project.Network
147 /xyz/openbmc_project/network/eth0 xyz.openbmc_project.Network.EthernetInterface
151 https://<hostname/ip>/xyz/openbmc_project/network/eth0/attr/DHCPEnabled
157 busctl set-property xyz.openbmc_project.Network
158 /xyz/openbmc_project/network/eth0 xyz.openbmc_project.Network.EthernetInterface
162 1}' https://<hostname/ip>/xyz/openbmc_project/network/eth0/attr/DHCPEnabled
170 busctl get-property xyz.openbmc_project.Network
171 /xyz/openbmc_project/network/eth0 xyz.openbmc_project.Network.MACAddress
175 https://<hostname/ip>/xyz/openbmc_project/network/eth0/attr/MACAddress
184 busctl set-property xyz.openbmc_project.Network
185 /xyz/openbmc_project/network/eth0 xyz.openbmc_project.Network.MACAddress
190 https://<hostname/ip>/xyz/openbmc_project/network/eth0/attr/MACAddress
193 ### Network factory reset
196 busctl call xyz.openbmc_project.Network /xyz/openbmc_project/network
200 '{"data":[] }' https://<hostname/ip>/xyz/openbmc_project/network/action/Reset
210 https://<hostname/ip>/xyz/openbmc_project/network/action/VLAN
217 https://<hostname/ip>/xyz/openbmc_project/network/eth0_50
219 busctl call xyz.openbmc_project.Network /xyz/openbmc_project/network/eth0_50
227 https://<hostname/ip>/xyz/openbmc_project/network/eth0_50/enumerate