Ratan Gupta | 4c8247b | 2017-03-16 16:23:06 +0530 | [diff] [blame] | 1 | description: > |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 2 | This defines an ethernet interface. An object implementing this interface |
| 3 | must implement xyz.openbmc_project.State.OperationalStatus. |
Ratan Gupta | 4c8247b | 2017-03-16 16:23:06 +0530 | [diff] [blame] | 4 | |
Ratan Gupta | 4c8247b | 2017-03-16 16:23:06 +0530 | [diff] [blame] | 5 | properties: |
| 6 | - name: InterfaceName |
| 7 | type: string |
Jiaqing Zhao | 9ac2778 | 2022-04-14 10:55:35 +0800 | [diff] [blame] | 8 | flags: |
| 9 | - const |
Ratan Gupta | 4c8247b | 2017-03-16 16:23:06 +0530 | [diff] [blame] | 10 | description: > |
| 11 | Name of the ethernet interface. |
Ratan Gupta | 4c8247b | 2017-03-16 16:23:06 +0530 | [diff] [blame] | 12 | - name: Speed |
| 13 | type: uint32 |
Jiaqing Zhao | 13feabc | 2022-04-14 10:36:16 +0800 | [diff] [blame] | 14 | flags: |
| 15 | - readonly |
Ratan Gupta | 4c8247b | 2017-03-16 16:23:06 +0530 | [diff] [blame] | 16 | description: > |
| 17 | Current speed of the ethernet interface, in Mbps. |
| 18 | - name: AutoNeg |
| 19 | type: boolean |
Jiaqing Zhao | 13feabc | 2022-04-14 10:36:16 +0800 | [diff] [blame] | 20 | flags: |
| 21 | - readonly |
Ratan Gupta | 4c8247b | 2017-03-16 16:23:06 +0530 | [diff] [blame] | 22 | description: > |
| 23 | This indicates if the speed and duplex are automatically negotiated |
| 24 | and configured on this ethernet interface. |
Tejas Patil | 0ef46c1 | 2021-07-19 17:34:57 +0530 | [diff] [blame] | 25 | - name: MTU |
| 26 | type: size |
| 27 | default: 0 |
| 28 | description: > |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 29 | This indicates the size in bytes of largest protocol data unit, which |
| 30 | can be passed in an Ethernet frame on the interface. |
Ratan Gupta | 4c8247b | 2017-03-16 16:23:06 +0530 | [diff] [blame] | 31 | - name: DomainName |
| 32 | type: array[string] |
| 33 | description: > |
| 34 | Domain names of the ethernet interface. |
| 35 | - name: DHCPEnabled |
Johnathan Mantey | 1977059 | 2020-06-16 09:25:19 -0700 | [diff] [blame] | 36 | type: enum[self.DHCPConf] |
Ratan Gupta | 4c8247b | 2017-03-16 16:23:06 +0530 | [diff] [blame] | 37 | description: > |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 38 | Address mode of the ethernet interface. Deprecated in favor of split |
| 39 | options to avoid combinatorics. |
William A. Kennington III | bcb24e1 | 2022-07-06 16:01:31 -0700 | [diff] [blame] | 40 | - name: DHCP4 |
| 41 | type: boolean |
| 42 | description: > |
| 43 | Enable or disable IPv4 DHCP. |
| 44 | - name: DHCP6 |
| 45 | type: boolean |
| 46 | description: > |
| 47 | Enable or disable IPv6 DHCP. |
Ratan Gupta | 4c8247b | 2017-03-16 16:23:06 +0530 | [diff] [blame] | 48 | - name: Nameservers |
| 49 | type: array[string] |
| 50 | description: > |
Manojkiran Eda | 496741a | 2019-10-13 18:46:11 +0530 | [diff] [blame] | 51 | DNS servers that are currently in use on this interface. |
William A. Kennington III | 6a0b503 | 2022-08-25 14:39:56 -0700 | [diff] [blame] | 52 | flags: |
| 53 | - readonly |
Manojkiran Eda | 496741a | 2019-10-13 18:46:11 +0530 | [diff] [blame] | 54 | - name: StaticNameServers |
| 55 | type: array[string] |
| 56 | description: > |
| 57 | A statically defined set of DNS server IP addresses to be used when |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 58 | DHCP provisioning is not enabled for name server configuration. As an |
| 59 | implementation option this may also be used in addition to DHCP |
Manojkiran Eda | 496741a | 2019-10-13 18:46:11 +0530 | [diff] [blame] | 60 | provided addresses, or in cases where the DHCP server provides no DNS |
| 61 | assigments. |
| 62 | errors: |
Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 63 | - xyz.openbmc_project.Common.Error.InvalidArgument |
Ratan Gupta | a51dea7 | 2017-08-23 18:13:33 +0530 | [diff] [blame] | 64 | - name: NTPServers |
| 65 | type: array[string] |
| 66 | description: > |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 67 | NTP servers that are currently in use on this interface. This includes |
| 68 | both DHCP and static NTP server addresses. |
Sunitha Harish | e11e2fa | 2022-02-03 04:25:31 -0600 | [diff] [blame] | 69 | - name: StaticNTPServers |
| 70 | type: array[string] |
| 71 | description: > |
| 72 | This property describes statically defined NTPServers on the |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 73 | interface. This property supports read/write operation. Configure the |
| 74 | NTP servers on the system during write operation. |
Ravi Teja | 0edc82d | 2019-04-24 00:57:20 -0500 | [diff] [blame] | 75 | - name: LinkLocalAutoConf |
| 76 | type: enum[self.LinkLocalConf] |
| 77 | description: > |
| 78 | This indicates link local auto configuration on this ethernet |
| 79 | interface and configured on this ethernet interface. |
Johnathan Mantey | 8d6cb9b | 2019-06-25 09:20:50 -0700 | [diff] [blame] | 80 | - name: IPv6AcceptRA |
| 81 | type: boolean |
| 82 | description: > |
William A. Kennington III | bcb24e1 | 2022-07-06 16:01:31 -0700 | [diff] [blame] | 83 | Boolean for accepting router advertisements in IPv6. |
Johnathan Mantey | b43056f | 2019-10-29 16:15:18 -0700 | [diff] [blame] | 84 | - name: NICEnabled |
| 85 | type: boolean |
| 86 | description: > |
| 87 | Boolean for to enabling or disabling the ethernet port |
Johnathan Mantey | 97b5129 | 2020-01-08 10:56:19 -0800 | [diff] [blame] | 88 | - name: LinkUp |
| 89 | type: boolean |
| 90 | flags: |
Jiaqing Zhao | 1bf1b7b | 2022-04-13 15:59:17 +0800 | [diff] [blame] | 91 | - readonly |
Johnathan Mantey | 97b5129 | 2020-01-08 10:56:19 -0800 | [diff] [blame] | 92 | description: > |
| 93 | This property reports the link status for the NIC. The read-only |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 94 | boolean value is TRUE when the network cable is inserted, or there is |
| 95 | a carrier signal. It is FALSE when the cable is unplugged, or the |
Johnathan Mantey | 97b5129 | 2020-01-08 10:56:19 -0800 | [diff] [blame] | 96 | carrier signal is missing. |
Ravi Teja | 0f57291 | 2020-07-06 09:37:59 -0500 | [diff] [blame] | 97 | - name: DefaultGateway |
| 98 | type: string |
| 99 | description: > |
| 100 | Default IPv4 gateway of the ethernet interface. |
| 101 | errors: |
Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 102 | - xyz.openbmc_project.Common.Error.InvalidArgument |
Ravi Teja | 0f57291 | 2020-07-06 09:37:59 -0500 | [diff] [blame] | 103 | - name: DefaultGateway6 |
| 104 | type: string |
| 105 | description: > |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 106 | Default IPv6 gateway of the ethernet interface. For supported address |
| 107 | formats refer RFC 2373. Refer below man page for both v4 and v6 |
| 108 | address format details |
Ravi Teja | 0f57291 | 2020-07-06 09:37:59 -0500 | [diff] [blame] | 109 | https://man7.org/linux/man-pages/man3/inet_pton.3.html |
| 110 | errors: |
Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 111 | - xyz.openbmc_project.Common.Error.InvalidArgument |
Ravi Teja | 0edc82d | 2019-04-24 00:57:20 -0500 | [diff] [blame] | 112 | |
| 113 | enumerations: |
| 114 | - name: LinkLocalConf |
| 115 | description: > |
| 116 | Possible link local auto configuration values. |
| 117 | values: |
Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 118 | - name: fallback |
| 119 | - name: both |
| 120 | - name: v4 |
| 121 | - name: v6 |
| 122 | - name: none |
Andrew Geissler | fcc419b | 2020-06-04 10:26:16 -0500 | [diff] [blame] | 123 | |
Johnathan Mantey | 1977059 | 2020-06-16 09:25:19 -0700 | [diff] [blame] | 124 | - name: DHCPConf |
| 125 | description: > |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 126 | High level definitions of available DHCP states. These definitions do |
| 127 | not have a 1:1 correlation to the systemd.network configuration file |
| 128 | contents. both: Enable IPv4 DHCP and IPv6 Stateful DHCP v4v6stateless: |
| 129 | Enable IPv4 DHCP and IPv6 SLAAC v6: Enable IPv6 Stateful DHCP |
| 130 | v6stateless: Enable IPv6 SLAAC v4: Enable IPv4 DHCP none: Disable DHCP |
| 131 | for IPv4 and IPv6 |
Johnathan Mantey | 1977059 | 2020-06-16 09:25:19 -0700 | [diff] [blame] | 132 | values: |
Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 133 | - name: both |
Johnathan Mantey | 8db5d8d | 2021-12-22 14:40:37 -0800 | [diff] [blame] | 134 | - name: v4v6stateless |
Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 135 | - name: v6 |
Johnathan Mantey | 8db5d8d | 2021-12-22 14:40:37 -0800 | [diff] [blame] | 136 | - name: v6stateless |
| 137 | - name: v4 |
Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 138 | - name: none |