Skip to content

Commit efce09b

Browse files
davidrapandavidrapan
committed
feat: Add IPv6 address generation mode & privacy extensions
Signed-off-by: David Rapan <[email protected]>
1 parent 7db53b6 commit efce09b

File tree

2 files changed

+53
-31
lines changed

2 files changed

+53
-31
lines changed

‎docs/api/supervisor/endpoints.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2383,16 +2383,27 @@ Update the settings for a network interface.
23832383

23842384
| key | type | optional | description |
23852385
| ------- | ------ | -------- | ---------------------------------------------------------------------- |
2386-
| enabled | bool | True | Enable/Disable an ethernet interface / VLAN got removed with disabled |
2387-
| ipv4 | dict | True | A struct with ipv4 interface settings |
2386+
| enabled | bool | True | Enable/Disable an ethernet interface / VLAN got removed with disabled |
23882387
| ipv6 | dict | True | A struct with ipv6 interface settings |
2388+
| ipv4 | dict | True | A struct with ipv4 interface settings |
23892389
| wifi | dict | True | A struct with Wireless connection settings |
23902390

2391-
**ipv4 / ipv6:**
2391+
**ipv6:**
2392+
2393+
| key | type | optional | description |
2394+
| ------------- | ------ | -------- | --------------------------------------------------------------------------------------------------- |
2395+
| method | string | True | Set IP configuration method can be `auto` for DHCP or Router Advertisements, `static` or `disabled` |
2396+
| addr_gen_mode | string | True | Address generation mode can be `eui64`, `stable-privacy`, `default-or-eui64` or `default` |
2397+
| ip6_privacy | string | True | Privacy extensions options are `disabled`, `enabled-prefer-public`, `enabled` or `default` |
2398+
| address | list | True | The new IP address for the interface in the ::/XX format as list |
2399+
| nameservers | list | True | List of DNS servers to use |
2400+
| gateway | string | True | The gateway the interface should use |
2401+
2402+
**ipv4:**
23922403

23932404
| key | type | optional | description |
23942405
| ----------- | ------ | -------- | ------------------------------------------------------------------------------------- |
2395-
| method | string | True | Set IP configuration method can be `auto` for DHCP or Router Advertisements (only IPv6), `static` or `disabled` |
2406+
| method | string | True | Set IP configuration method can be `auto` for DHCP, `static` or `disabled` |
23962407
| address | list | True | The new IP address for the interface in the X.X.X.X/XX format as list |
23972408
| nameservers | list | True | List of DNS servers to use |
23982409
| gateway | string | True | The gateway the interface should use |
@@ -2401,7 +2412,7 @@ Update the settings for a network interface.
24012412

24022413
| key | type | optional | description |
24032414
| ------ | ------ | -------- | ------------------------------------------------------------------------------ |
2404-
| mode | string | True | Set the mode `infrastructure` (default), `mesh`, `adhoc` or `ap` |
2415+
| mode | string | True | Set the mode `infrastructure` (default), `mesh`, `adhoc` or `ap` |
24052416
| auth | string | True | Set the auth mode: `open` (default), `web`, `wpa-psk` |
24062417
| ssid | string | True | Set the SSID for connect into |
24072418
| psk | string | True | The shared key which is used with `web` or `wpa-psk` |
@@ -2418,7 +2429,7 @@ Return a list of available [Access Points](api/supervisor/models.md#access-point
24182429

24192430
| key | description |
24202431
| ------------ | ---------------------------------------------------------------------- |
2421-
| accesspoints | A list of [Access Points](api/supervisor/models.md#access-points) |
2432+
| accesspoints | A list of [Access Points](api/supervisor/models.md#access-points) |
24222433

24232434
**Example response:**
24242435

@@ -2448,8 +2459,8 @@ Create a new VLAN *id* on this network interface.
24482459

24492460
| key | type | optional | description |
24502461
| ------- | ------ | -------- | ---------------------------------------------------------------------- |
2451-
| ipv4 | dict | True | A struct with ipv4 interface settings |
24522462
| ipv6 | dict | True | A struct with ipv6 interface settings |
2463+
| ipv4 | dict | True | A struct with ipv4 interface settings |
24532464

24542465
</ApiEndpoint>
24552466

@@ -2673,8 +2684,8 @@ Move datadisk to a new location, **This will also reboot the device!**
26732684

26742685
**Payload:**
26752686

2676-
| key | type | description |
2677-
| ------- | ------ | ----------------------------------------------------------------- |
2687+
| key | type | description |
2688+
| ------- | ------ | ------------------------------------------------------------------------------- |
26782689
| device | string | ID of the disk device which should be used as the target for the data migration |
26792690

26802691
</ApiEndpoint>

‎docs/api/supervisor/models.md

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -93,19 +93,30 @@ These models are describing objects that are getting returned from the superviso
9393

9494
## Network interface
9595

96-
| key | type | description |
97-
| ----------- | ------- | ---------------------------------------------------------------------------- |
98-
| interface | string | The interface name i.e eth0. |
99-
| type | string | The interface type: `ethernet`, `wireless` or `vlan`. |
100-
| enabled | boolean | Return True if the interface is enabled. |
101-
| connected | boolean | Return True if the interface is connected to the network. |
102-
| primary | boolean | `true` if it's the primary network interface. |
103-
| ipv4 | struct or null | An IP config struct with IPv4 connection details. |
104-
| ipv6 | struct or null | An IP config struct with IPv6 connection details. |
105-
| wifi | struct or null | A Wifi config struct with wireless connection details. |
106-
| vlan | struct or null | A Vlan config struct with details about the vlan. |
107-
108-
### IP configuration
96+
| key | type | description |
97+
| ----------- | ------- | --------------------------------------------------------------------------------------------- |
98+
| interface | string | The interface name i.e eth0. |
99+
| type | string | The interface type: `ethernet`, `wireless` or `vlan`. |
100+
| enabled | boolean | Return True if the interface is enabled. |
101+
| connected | boolean | Return True if the interface is connected to the network. |
102+
| primary | boolean | `true` if it's the primary network interface. |
103+
| ipv6 | struct or null | An [IPv6 configuration](#ipv6-configuration) struct with IPv6 connection details. |
104+
| ipv4 | struct or null | An [IPv4 configuration](#ipv4-configuration) struct with IPv4 connection details. |
105+
| wifi | struct or null | A [Wifi configuration](#wifi-configuration) struct with wireless connection details. |
106+
| vlan | struct or null | A [VLAN configuration](#vlan-configuration) struct with details about the vlan. |
107+
108+
### IPv6 configuration
109+
110+
| key | type | description |
111+
| ------------- | ------- | ------------------------------------------------------------------------------------------- |
112+
| method | string | The method used to set the IP can be `static`, `auto` or `disabled`. |
113+
| addr_gen_mode | string | Address generation mode can be `eui64` or `stable-privacy`, `default-or-eui64` or `default` |
114+
| ip6_privacy | string | Privacy extensions options are `disabled`, `enabled-prefer-public`, `enabled` or `default` |
115+
| address | list | A list with IP address and the netmask in a ::/XXX format. |
116+
| gateway | string | The IP address of the gateway. |
117+
| nameservers | list | A list containing the IP addresses of the configured nameservers as strings. |
118+
119+
### IPv4 configuration
109120

110121
| key | type | description |
111122
| ----------- | ------- | ---------------------------------------------------------------------------- |
@@ -169,15 +180,15 @@ These models are describing objects that are getting returned from the superviso
169180

170181
## Backup
171182

172-
| key | type | description |
173-
| --------- | ------- | --------------------------------------------------------------------- |
174-
| slug | string | A generated slug for the backup |
175-
| date | string | ISO date string representation of the date the backup was created |
176-
| name | string | The name given to the backup |
177-
| type | string | The type of backup (full, partial) |
178-
| protected | boolean | `true` if the backup is password protected |
179-
| content | dictionary | A dictionary describing the content of the backup |
180-
| compressed | boolean | `true` if the backup is saved in a compressed archive |
183+
| key | type | description |
184+
| --------- | ------- | -------------------------------------------------------------------------- |
185+
| slug | string | A generated slug for the backup |
186+
| date | string | ISO date string representation of the date the backup was created |
187+
| name | string | The name given to the backup |
188+
| type | string | The type of backup (full, partial) |
189+
| protected | boolean | `true` if the backup is password protected |
190+
| content | dictionary | Details of the backup content. See [Backup -> content](#backup---content) |
191+
| compressed | boolean | `true` if the backup is saved in a compressed archive |
181192

182193
### Backup -> content
183194

0 commit comments

Comments
 (0)