blob: b18f6c7033cd95cd9b091cd45df90ec1b8606464 [file] [log] [blame]
Ratan Gupta4c8247b2017-03-16 16:23:06 +05301description: >
2 This defines an ethernet interface.
3 An object implementing this interface must implement
4 xyz.openbmc_project.State.OperationalStatus.
5
6
7properties:
8 - name: InterfaceName
9 type: string
10 description: >
11 Name of the ethernet interface.
Ratan Gupta4c8247b2017-03-16 16:23:06 +053012 - name: Speed
13 type: uint32
14 description: >
15 Current speed of the ethernet interface, in Mbps.
16 - name: AutoNeg
17 type: boolean
18 description: >
19 This indicates if the speed and duplex are automatically negotiated
20 and configured on this ethernet interface.
21 - name: DomainName
22 type: array[string]
23 description: >
24 Domain names of the ethernet interface.
25 - name: DHCPEnabled
Brad Bishop2d3b6372019-11-20 10:44:14 -050026 type: boolean
Ratan Gupta4c8247b2017-03-16 16:23:06 +053027 description: >
28 Address mode of the ethernet interface.
29 - name: Nameservers
30 type: array[string]
31 description: >
Manojkiran Eda496741a2019-10-13 18:46:11 +053032 DNS servers that are currently in use on this interface.
Manojkiran Eda83968c32019-08-22 11:59:13 +053033 errors:
Manojkiran Eda262ac242019-08-08 14:35:06 +053034 - xyz::openbmc_project.Common.Error.NotAllowed
Manojkiran Eda496741a2019-10-13 18:46:11 +053035 - name: StaticNameServers
36 type: array[string]
37 description: >
38 A statically defined set of DNS server IP addresses to be used when
39 DHCP provisioning is not enabled for name server configuration. As
40 an implementation option this may also be used in addition to DHCP
41 provided addresses, or in cases where the DHCP server provides no DNS
42 assigments.
43 errors:
44 - xyz.openbmc_project.Common.Error.InvalidArgument
Ratan Guptaa51dea72017-08-23 18:13:33 +053045 - name: NTPServers
46 type: array[string]
47 description: >
48 This property describes the NTP Servers on the interface.
49 Implementation of this Dbus-interface is required to implement this property.
50 This property supports read/write operation.
51 Configure the NTP servers on the system during write operation.
Ravi Teja0edc82d2019-04-24 00:57:20 -050052 - name: LinkLocalAutoConf
53 type: enum[self.LinkLocalConf]
54 description: >
55 This indicates link local auto configuration on this ethernet
56 interface and configured on this ethernet interface.
Johnathan Mantey8d6cb9b2019-06-25 09:20:50 -070057 - name: IPv6AcceptRA
58 type: boolean
59 description: >
60 Boolean for accepting router advertisements in IPv6
Johnathan Manteyb43056f2019-10-29 16:15:18 -070061 - name: NICEnabled
62 type: boolean
63 description: >
64 Boolean for to enabling or disabling the ethernet port
Johnathan Mantey97b51292020-01-08 10:56:19 -080065 - name: LinkUp
66 type: boolean
67 flags:
68 - const
69 description: >
70 This property reports the link status for the NIC. The read-only
71 boolean value is TRUE when the network cable is inserted, or there
72 is a carrier signal. It is FALSE when the cable is unplugged, or the
73 carrier signal is missing.
Ravi Teja0edc82d2019-04-24 00:57:20 -050074
75enumerations:
76 - name: LinkLocalConf
77 description: >
78 Possible link local auto configuration values.
79 values:
Ravi Teja55f1eee2019-09-19 05:59:31 -050080 - name: fallback
Ravi Teja0edc82d2019-04-24 00:57:20 -050081 - name: both
82 - name: v4
83 - name: v6
84 - name: none
Brad Bishop2d3b6372019-11-20 10:44:14 -050085