@@ -278,31 +278,31 @@ the `404` code.
278
278
279
279
Publishes the current IP configuration of all network adapters (excluding those
280
280
directly assigned to applications).
281
- The response may optionally include updated configuration for one or more
282
- adapters, which EVE will validate and apply if permitted.
281
+ The response may optionally include a locally-declared desired configuration
282
+ for one or more adapters, which EVE will validate and apply if permitted.
283
283
284
284
``` http
285
285
POST /api/v1/network
286
286
```
287
287
288
288
Return codes:
289
289
290
- * Success, with modified network configuration included in the response
290
+ * Success, with locally-declared network configuration included in the response
291
291
for EVE to apply: ` 200 `
292
- * Success, no configuration changes requested; any existing local modifications
293
- remain in effect: ` 204 `
292
+ * Success, no local network configuration updates requested; any existing
293
+ local configuration remains in effect: ` 204 `
294
294
* Not implemented, or intentionally used by the local server to throttle
295
295
the periodic network information updates: ` 404 `
296
- When ` 404 ` is returned, any previously submitted configuration changes
297
- from LPS are reverted.
296
+ When ` 404 ` is returned, any previously submitted local network configuration
297
+ is reverted.
298
298
299
299
Request:
300
300
301
301
The request MIME type MUST be ` application/x-proto-binary ` .
302
302
The request MUST contain the body of a single protobuf message of type
303
303
[ NetworkInfo] ( ./proto/profile/network.proto ) .
304
304
Device publishes network information repeatedly to keep LPS updated and
305
- to allow the server to submit configuration changes .
305
+ to allow the server to submit local configuration updates .
306
306
Local server MAY throttle or cancel this communication stream by returning
307
307
the ` 404 ` code.
308
308
@@ -312,61 +312,67 @@ the `404` code.
312
312
* Status of controller connectivity
313
313
* A fallback network configuration, used when the latest configuration
314
314
fails to provide working controller connectivity.
315
- * Status of any locally-made configuration changes submitted previously
316
- by the Local Profile Server (LPS), indicating success or errors if changes
317
- failed .
315
+ * Status of the local network configuration submitted previously
316
+ by the Local Profile Server (LPS), indicating whether it was successfully
317
+ applied or if errors occurred .
318
318
319
319
Response:
320
320
321
321
The response MAY contain the body of a single protobuf message of type
322
- [ NetworkConfigChange ] ( ./proto/profile/network.proto ) , encoded as
322
+ [ LocalNetworkConfig ] ( ./proto/profile/network.proto ) , encoded as
323
323
` application/x-proto-binary ` .
324
- If no changes are required, the Local Profile Server MAY return HTTP 204
325
- (` No Content ` ).
324
+ If no further updates are needed to the local configuration, the server MAY return
325
+ HTTP 204 (` No Content ` ), and EVE will continue using the most recently submitted
326
+ local configuration.
326
327
327
- ` NetworkConfigChange ` contains:
328
+ ` LocalNetworkConfig ` contains:
328
329
329
330
* An authorization token (` server_token ` ) to verify the request against
330
331
the controller-provisioned secret.
331
- * New or updated network configuration for one or more adapters .
332
+ * Declarative network configuration for ports managed locally .
332
333
333
334
Behavior:
334
335
335
- * EVE validates the received configuration to ensure it is well-formed and only
336
- includes adapters for which local modifications are permitted by the
337
- controller user.
338
- * Locally-modifiable fields include the IP configuration, wireless settings,
336
+ * EVE validates the received local configuration to ensure it is well-formed
337
+ and that the submitted ` server_token ` matches the value provisioned
338
+ by the controller.
339
+ * The controller may specify, on a per-port basis, whether local modifications
340
+ are allowed (see ` SystemAdapter.allow_local_modifications ` ).
341
+ Ports that are not permitted to receive local configuration are skipped,
342
+ and an error is reported for each such port in ` LocalNetworkConfigInfo ` .
343
+ * If the controller revokes local modification permissions or un-configures LPS,
344
+ EVE reverts affected adapters to the controller configuration.
345
+ * Locally-manageable fields include the IP configuration, wireless settings,
339
346
and proxy configuration — the attributes defined in [ NetworkPortConfig] ( proto/profile/network.proto ) .
340
347
Fields that affect overall network topology, such as interface usage, cost,
341
- or assigned labels, are not locally-modifiable and remain under controller
348
+ or assigned labels, are not locally-manageable and remain under controller
342
349
management.
343
- * Any local modification to a port replaces the entire set of locally-modifiable
350
+ * Local port configuration overrides the entire set of locally-manageable
344
351
fields. Partial updates are not supported — fields omitted or set to empty/zero
345
352
values are applied as such, rather than inheriting values from the controller
346
- configuration. The locally-modifiable portion is treated as a single unit,
353
+ configuration. The locally-manageable portion is treated as a single unit,
347
354
so the controller cannot manage some of these fields while the local user
348
355
manages others.
349
- * Fields that are not included in the set of locally-changeable attributes
356
+ * Fields that are not included in the set of locally-manageable attributes
350
357
(e.g., interface usage, cost) continue to follow the controller-provided
351
358
configuration, either the latest or the active fallback configuration,
352
359
as appropriate.
353
- * If the controller revokes local modification permissions or un-configures LPS,
354
- EVE reverts affected adapters to the controller configuration.
355
360
* When LPS (temporarily or indefinitely) throttles/cancels the communication
356
- stream by returning ` 404 ` , all previously submitted network configuration
357
- changes are reverted.
358
- * If LPS becomes inaccessible or unresponsive, previously submitted network
359
- configuration changes remain in effect. To revert these changes from a crashed
361
+ stream by returning ` 404 ` , previously submitted local network configuration
362
+ is reverted.
363
+ * If LPS becomes inaccessible or unresponsive, a previously submitted network
364
+ configuration remains in effect. To revert local config received from a crashed
360
365
or misbehaving LPS, the controller user must explicitly revoke permissions
361
366
or disable the LPS.
362
- * EVE disables fallback mechanism only for locally modified adapters with respect
363
- to fields that can be locally changed. All other adapters, or fields that are
364
- not locally-changeable, such as interface usage or cost, continue using either
365
- the latest or fallback controller configuration, depending on connectivity status.
366
- * The current controller connectivity status is included in the request to help
367
- the local operator make informed changes.
368
- * When configuration changes fail validation or application, EVE reports errors
369
- back in ` NetworkInfo ` .
367
+ * EVE disables fallback mechanism only for adapters with a local configuration
368
+ with respect to fields that can be locally managed. All other adapters, or fields
369
+ that are not locally-manageable, such as interface usage or cost, continue using
370
+ either the latest or fallback controller configuration, depending on connectivity
371
+ status.
372
+ * The published controller connectivity status helps the local operator create
373
+ a local configuration that ensures proper connectivity.
374
+ * When local configuration fails validation or application, EVE reports errors
375
+ back in ` NetworkInfo.local_config ` .
370
376
371
377
## Security
372
378
0 commit comments