| Ratan Gupta | 632b80b | 2017-03-16 16:38:03 +0530 | [diff] [blame] | 1 | description: > |
| 2 | This defines an IP address. |
| 3 | |
| 4 | # TODO Fix it through https://github.com/openbmc/openbmc/issues/1438 |
| 5 | # creatable: true |
| 6 | |
| 7 | properties: |
| 8 | - name: Address |
| 9 | type: string |
| 10 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 11 | The value of this property shall be an IP address assigned to the |
| 12 | ethernet interface. |
| Ravi Teja | 6891f19 | 2019-06-13 13:31:34 -0500 | [diff] [blame] | 13 | errors: |
| William A. Kennington III | 9f2fee8 | 2022-09-01 12:54:52 -0700 | [diff] [blame] | 14 | - xyz.openbmc_project.Common.Error.NotAllowed |
| Ravi Teja | 6891f19 | 2019-06-13 13:31:34 -0500 | [diff] [blame] | 15 | |
| Ratan Gupta | 632b80b | 2017-03-16 16:38:03 +0530 | [diff] [blame] | 16 | - name: PrefixLength |
| 17 | type: byte |
| 18 | description: > |
| 19 | This is the number of network bits in the ipaddress. |
| Ravi Teja | 6891f19 | 2019-06-13 13:31:34 -0500 | [diff] [blame] | 20 | errors: |
| William A. Kennington III | 9f2fee8 | 2022-09-01 12:54:52 -0700 | [diff] [blame] | 21 | - xyz.openbmc_project.Common.Error.NotAllowed |
| Ravi Teja | 6891f19 | 2019-06-13 13:31:34 -0500 | [diff] [blame] | 22 | |
| Ratan Gupta | 632b80b | 2017-03-16 16:38:03 +0530 | [diff] [blame] | 23 | - name: Origin |
| 24 | type: enum[self.AddressOrigin] |
| 25 | description: > |
| 26 | This indicates how the address was determined. |
| Ravi Teja | 6891f19 | 2019-06-13 13:31:34 -0500 | [diff] [blame] | 27 | errors: |
| William A. Kennington III | 9f2fee8 | 2022-09-01 12:54:52 -0700 | [diff] [blame] | 28 | - xyz.openbmc_project.Common.Error.NotAllowed |
| Ravi Teja | 6891f19 | 2019-06-13 13:31:34 -0500 | [diff] [blame] | 29 | |
| Ratan Gupta | 632b80b | 2017-03-16 16:38:03 +0530 | [diff] [blame] | 30 | - name: Gateway |
| 31 | type: string |
| 32 | description: > |
| 33 | This is the IP gateway for this address. |
| Ravi Teja | 6891f19 | 2019-06-13 13:31:34 -0500 | [diff] [blame] | 34 | errors: |
| William A. Kennington III | 9f2fee8 | 2022-09-01 12:54:52 -0700 | [diff] [blame] | 35 | - xyz.openbmc_project.Common.Error.NotAllowed |
| Ravi Teja | 6891f19 | 2019-06-13 13:31:34 -0500 | [diff] [blame] | 36 | |
| Ratan Gupta | 487b02b | 2017-05-11 16:06:46 +0530 | [diff] [blame] | 37 | - name: Type |
| 38 | type: enum[self.Protocol] |
| 39 | description: > |
| 40 | IP protocol type which can be IPv4 or IPv6 etc. |
| Ravi Teja | 6891f19 | 2019-06-13 13:31:34 -0500 | [diff] [blame] | 41 | errors: |
| William A. Kennington III | 9f2fee8 | 2022-09-01 12:54:52 -0700 | [diff] [blame] | 42 | - xyz.openbmc_project.Common.Error.NotAllowed |
| Ratan Gupta | 632b80b | 2017-03-16 16:38:03 +0530 | [diff] [blame] | 43 | |
| 44 | enumerations: |
| Ratan Gupta | 487b02b | 2017-05-11 16:06:46 +0530 | [diff] [blame] | 45 | - name: Protocol |
| 46 | description: > |
| 47 | Possible IP protocol types. |
| 48 | values: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 49 | - name: IPv4 |
| 50 | - name: IPv6 |
| Ratan Gupta | 487b02b | 2017-05-11 16:06:46 +0530 | [diff] [blame] | 51 | |
| Ratan Gupta | 632b80b | 2017-03-16 16:38:03 +0530 | [diff] [blame] | 52 | - name: AddressOrigin |
| 53 | description: > |
| 54 | Possible IP address origin types. |
| 55 | values: |
| Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 56 | - name: Static |
| 57 | description: > |
| 58 | Static address configured by the server. |
| 59 | - name: DHCP |
| 60 | description: > |
| 61 | Address is provided by a DHCP service. |
| 62 | - name: LinkLocal |
| 63 | description: > |
| 64 | Address is valid only for this network segment. |
| 65 | - name: SLAAC |
| 66 | description: > |
| 67 | Address is provided by a Stateless Address Autoconfiguration. |