xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Network/IP.interface.yaml (revision a1347418307d31a94bd21f22897aa508df938dcf)
1b1b4d261SWilliam A. Kennington IIIdescription: >
2b1b4d261SWilliam A. Kennington III    This defines an IP address.
3b1b4d261SWilliam A. Kennington III
4b1b4d261SWilliam A. Kennington III# TODO Fix it through https://github.com/openbmc/openbmc/issues/1438
5b1b4d261SWilliam A. Kennington III# creatable: true
6b1b4d261SWilliam A. Kennington III
7b1b4d261SWilliam A. Kennington IIIproperties:
8b1b4d261SWilliam A. Kennington III    - name: Address
9b1b4d261SWilliam A. Kennington III      type: string
10b1b4d261SWilliam A. Kennington III      description: >
11*a1347418SPatrick Williams          The value of this property shall be an IP address assigned to the
12*a1347418SPatrick Williams          ethernet interface.
13b1b4d261SWilliam A. Kennington III      errors:
149f2fee82SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.NotAllowed
15b1b4d261SWilliam A. Kennington III
16b1b4d261SWilliam A. Kennington III    - name: PrefixLength
17b1b4d261SWilliam A. Kennington III      type: byte
18b1b4d261SWilliam A. Kennington III      description: >
19b1b4d261SWilliam A. Kennington III          This is the number of network bits in the ipaddress.
20b1b4d261SWilliam A. Kennington III      errors:
219f2fee82SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.NotAllowed
22b1b4d261SWilliam A. Kennington III
23b1b4d261SWilliam A. Kennington III    - name: Origin
24b1b4d261SWilliam A. Kennington III      type: enum[self.AddressOrigin]
25b1b4d261SWilliam A. Kennington III      description: >
26b1b4d261SWilliam A. Kennington III          This indicates how the address was determined.
27b1b4d261SWilliam A. Kennington III      errors:
289f2fee82SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.NotAllowed
29b1b4d261SWilliam A. Kennington III
30b1b4d261SWilliam A. Kennington III    - name: Gateway
31b1b4d261SWilliam A. Kennington III      type: string
32b1b4d261SWilliam A. Kennington III      description: >
33b1b4d261SWilliam A. Kennington III          This is the IP gateway for this address.
34b1b4d261SWilliam A. Kennington III      errors:
359f2fee82SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.NotAllowed
36b1b4d261SWilliam A. Kennington III
37b1b4d261SWilliam A. Kennington III    - name: Type
38b1b4d261SWilliam A. Kennington III      type: enum[self.Protocol]
39b1b4d261SWilliam A. Kennington III      description: >
40b1b4d261SWilliam A. Kennington III          IP protocol type which can be IPv4 or IPv6 etc.
41b1b4d261SWilliam A. Kennington III      errors:
429f2fee82SWilliam A. Kennington III          - xyz.openbmc_project.Common.Error.NotAllowed
43b1b4d261SWilliam A. Kennington III
44b1b4d261SWilliam A. Kennington IIIenumerations:
45b1b4d261SWilliam A. Kennington III    - name: Protocol
46b1b4d261SWilliam A. Kennington III      description: >
47b1b4d261SWilliam A. Kennington III          Possible IP protocol types.
48b1b4d261SWilliam A. Kennington III      values:
49b1b4d261SWilliam A. Kennington III          - name: IPv4
50b1b4d261SWilliam A. Kennington III          - name: IPv6
51b1b4d261SWilliam A. Kennington III
52b1b4d261SWilliam A. Kennington III    - name: AddressOrigin
53b1b4d261SWilliam A. Kennington III      description: >
54b1b4d261SWilliam A. Kennington III          Possible IP address origin types.
55b1b4d261SWilliam A. Kennington III      values:
56b1b4d261SWilliam A. Kennington III          - name: Static
57b1b4d261SWilliam A. Kennington III            description: >
58b1b4d261SWilliam A. Kennington III                Static address configured by the server.
59b1b4d261SWilliam A. Kennington III          - name: DHCP
60b1b4d261SWilliam A. Kennington III            description: >
61b1b4d261SWilliam A. Kennington III                Address is provided by a DHCP service.
62b1b4d261SWilliam A. Kennington III          - name: LinkLocal
63b1b4d261SWilliam A. Kennington III            description: >
64b1b4d261SWilliam A. Kennington III                Address is valid only for this network segment.
65b1b4d261SWilliam A. Kennington III          - name: SLAAC
66b1b4d261SWilliam A. Kennington III            description: >
67b1b4d261SWilliam A. Kennington III                Address is provided by a Stateless Address Autoconfiguration.
68