1description: >
2    This defines an ethernet interface.
3    An object implementing this interface must implement
4    xyz.openbmc_project.State.OperationalStatus.
5
6properties:
7    - name: InterfaceName
8      type: string
9      description: >
10          Name of the ethernet interface.
11    - name: Speed
12      type: uint32
13      description: >
14          Current speed of the ethernet interface, in Mbps.
15    - name: AutoNeg
16      type: boolean
17      description: >
18          This indicates if the speed and duplex are automatically negotiated
19          and configured on this ethernet interface.
20    - name: MTU
21      type: size
22      default: 0
23      description: >
24          This indicates the size in bytes of largest protocol data unit,
25          which can be passed in an Ethernet frame on the interface.
26    - name: DomainName
27      type: array[string]
28      description: >
29          Domain names of the ethernet interface.
30    - name: DHCPEnabled
31      type: enum[self.DHCPConf]
32      description: >
33          Address mode of the ethernet interface.
34    - name: Nameservers
35      type: array[string]
36      description: >
37          DNS servers that are currently in use on this interface.
38      errors:
39          - xyz::openbmc_project.Common.Error.NotAllowed
40    - name: StaticNameServers
41      type: array[string]
42      description: >
43          A statically defined set of DNS server IP addresses to be used when
44          DHCP provisioning is not enabled for name server configuration. As
45          an implementation option this may also be used in addition to DHCP
46          provided addresses, or in cases where the DHCP server provides no DNS
47          assigments.
48      errors:
49          - xyz.openbmc_project.Common.Error.InvalidArgument
50    - name: NTPServers
51      type: array[string]
52      description: >
53          This property describes the NTP Servers on the interface.
54          Implementation of this Dbus-interface is required to implement this property.
55          This property supports read/write operation.
56          Configure the NTP servers on the system during write operation.
57    - name: LinkLocalAutoConf
58      type: enum[self.LinkLocalConf]
59      description: >
60          This indicates link local auto configuration on this ethernet
61          interface and configured on this ethernet interface.
62    - name: IPv6AcceptRA
63      type: boolean
64      description: >
65          Boolean for accepting router advertisements in IPv6. This control is
66          being deprecated in favor of the DHCPConf enumerations
67          below. Removal of this entry is deferred.
68    - name: NICEnabled
69      type: boolean
70      description: >
71          Boolean for to enabling or disabling the ethernet port
72    - name: LinkUp
73      type: boolean
74      flags:
75          - const
76      description: >
77          This property reports the link status for the NIC. The read-only
78          boolean value is TRUE when the network cable is inserted, or there
79          is a carrier signal. It is FALSE when the cable is unplugged, or the
80          carrier signal is missing.
81    - name: DefaultGateway
82      type: string
83      description: >
84          Default IPv4 gateway of the ethernet interface.
85      errors:
86          - xyz.openbmc_project.Common.Error.InvalidArgument
87    - name: DefaultGateway6
88      type: string
89      description: >
90          Default IPv6 gateway of the ethernet interface.
91          For supported address formats refer RFC 2373.
92          Refer below man page for both v4 and v6 address format details
93          https://man7.org/linux/man-pages/man3/inet_pton.3.html
94      errors:
95          - xyz.openbmc_project.Common.Error.InvalidArgument
96
97enumerations:
98    - name: LinkLocalConf
99      description: >
100          Possible link local auto configuration values.
101      values:
102          - name: fallback
103          - name: both
104          - name: v4
105          - name: v6
106          - name: none
107
108    - name: DHCPConf
109      description: >
110          High level definitions of available DHCP states.
111          These definitions do not have a 1:1 correlation to the
112          systemd.network configuration file contents.
113          both: Enable IPv4 DHCP and IPv6 Stateful DHCP
114          v4v6stateless: Enable IPv4 DHCP and IPv6 SLAAC
115          v6: Enable IPv6 Stateful DHCP
116          v6stateless: Enable IPv6 SLAAC
117          v4: Enable IPv4 DHCP
118          none: Disable DHCP for IPv4 and IPv6
119      values:
120          - name: both
121          - name: v4v6stateless
122          - name: v6
123          - name: v6stateless
124          - name: v4
125          - name: none
126