Skip to content

Commit 9bae076

Browse files
davidrapandavidrapan
authored
Add documentation for IPv6 address generation mode & privacy extensions (#2670)
1 parent bc3e175 commit 9bae076

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
@@ -2461,16 +2461,27 @@ Update the settings for a network interface.
24612461

24622462
| key | type | optional | description |
24632463
| ------- | ------ | -------- | ---------------------------------------------------------------------- |
2464-
| enabled | bool | True | Enable/Disable an ethernet interface / VLAN got removed with disabled |
2465-
| ipv4 | dict | True | A struct with ipv4 interface settings |
2464+
| enabled | bool | True | Enable/Disable an ethernet interface / VLAN got removed with disabled |
24662465
| ipv6 | dict | True | A struct with ipv6 interface settings |
2466+
| ipv4 | dict | True | A struct with ipv4 interface settings |
24672467
| wifi | dict | True | A struct with Wireless connection settings |
24682468

2469-
**ipv4 / ipv6:**
2469+
**ipv6:**
2470+
2471+
| key | type | optional | description |
2472+
| ------------- | ------ | -------- | --------------------------------------------------------------------------------------------------- |
2473+
| method | string | True | Set IP configuration method can be `auto` for DHCP or Router Advertisements, `static` or `disabled` |
2474+
| addr_gen_mode | string | True | Address generation mode can be `eui64`, `stable-privacy`, `default-or-eui64` or `default` |
2475+
| ip6_privacy | string | True | Privacy extensions options are `disabled`, `enabled-prefer-public`, `enabled` or `default` |
2476+
| address | list | True | The new IP address for the interface in the ::/XX format as list |
2477+
| nameservers | list | True | List of DNS servers to use |
2478+
| gateway | string | True | The gateway the interface should use |
2479+
2480+
**ipv4:**
24702481

24712482
| key | type | optional | description |
24722483
| ----------- | ------ | -------- | ------------------------------------------------------------------------------------- |
2473-
| method | string | True | Set IP configuration method can be `auto` for DHCP or Router Advertisements (only IPv6), `static` or `disabled` |
2484+
| method | string | True | Set IP configuration method can be `auto` for DHCP, `static` or `disabled` |
24742485
| address | list | True | The new IP address for the interface in the X.X.X.X/XX format as list |
24752486
| nameservers | list | True | List of DNS servers to use |
24762487
| gateway | string | True | The gateway the interface should use |
@@ -2479,7 +2490,7 @@ Update the settings for a network interface.
24792490

24802491
| key | type | optional | description |
24812492
| ------ | ------ | -------- | ------------------------------------------------------------------------------ |
2482-
| mode | string | True | Set the mode `infrastructure` (default), `mesh`, `adhoc` or `ap` |
2493+
| mode | string | True | Set the mode `infrastructure` (default), `mesh`, `adhoc` or `ap` |
24832494
| auth | string | True | Set the auth mode: `open` (default), `web`, `wpa-psk` |
24842495
| ssid | string | True | Set the SSID for connect into |
24852496
| psk | string | True | The shared key which is used with `web` or `wpa-psk` |
@@ -2496,7 +2507,7 @@ Return a list of available [Access Points](api/supervisor/models.md#access-point
24962507

24972508
| key | description |
24982509
| ------------ | ---------------------------------------------------------------------- |
2499-
| accesspoints | A list of [Access Points](api/supervisor/models.md#access-points) |
2510+
| accesspoints | A list of [Access Points](api/supervisor/models.md#access-points) |
25002511

25012512
**Example response:**
25022513

@@ -2526,8 +2537,8 @@ Create a new VLAN *id* on this network interface.
25262537

25272538
| key | type | optional | description |
25282539
| ------- | ------ | -------- | ---------------------------------------------------------------------- |
2529-
| ipv4 | dict | True | A struct with ipv4 interface settings |
25302540
| ipv6 | dict | True | A struct with ipv6 interface settings |
2541+
| ipv4 | dict | True | A struct with ipv4 interface settings |
25312542

25322543
</ApiEndpoint>
25332544

@@ -2751,8 +2762,8 @@ Move datadisk to a new location, **This will also reboot the device!**
27512762

27522763
**Payload:**
27532764

2754-
| key | type | description |
2755-
| ------- | ------ | ----------------------------------------------------------------- |
2765+
| key | type | description |
2766+
| ------- | ------ | ------------------------------------------------------------------------------- |
27562767
| device | string | ID of the disk device which should be used as the target for the data migration |
27572768

27582769
</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)