Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(380)

Side by Side Diff: components/onc/docs/onc_spec.html

Issue 749013003: ONC: Add IPAddressConfigType and NameServersConfigType (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: . Created 6 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 <!DOCTYPE html> 1 <!DOCTYPE html>
2 <html> 2 <html>
3 <head> 3 <head>
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <link rel="stylesheet" href="onc_spec.css" > 5 <link rel="stylesheet" href="onc_spec.css" >
6 <script src="onc_spec.js"></script> 6 <script src="onc_spec.js"></script>
7 <title>Open Network Configuration Format</title> 7 <title>Open Network Configuration Format</title>
8 </head> 8 </head>
9 <body> 9 <body>
10 10
(...skipping 233 matching lines...) Expand 10 before | Expand all | Expand 10 after
244 <dd> 244 <dd>
245 <span class="field_meta"> 245 <span class="field_meta">
246 (required) 246 (required)
247 <span class="type">string</span> 247 <span class="type">string</span>
248 </span> 248 </span>
249 A unique identifier for this network connection, which exists to make it 249 A unique identifier for this network connection, which exists to make it
250 possible to update previously imported configurations. Must be a non-empty 250 possible to update previously imported configurations. Must be a non-empty
251 string. 251 string.
252 </dd> 252 </dd>
253 253
254 <dt class="field">IPAddressConfigType</dt>
255 <dd>
256 <span class="field_meta">
257 (optional if <span class="field">Remove</span> is
258 <span class="value">false</span>, otherwise ignored. Defaults to
259 <span class="value">DHCP</span>)
260 <span class="type">string</span>
261 </span>
262 <span class="rule">
263 <span class="rule_id"></span>
264 Allowed values are <span class="value">DHCP</span> and
265 <span class="value">Static</span>.
266 </span>
267 Determines whether the IP Address configuration is statically configured,
268 see <span class="field">StaticIPConfig</span>, or automatically configured
269 using DHCP.
270 </dd>
271
272 <dt class="field">NameServersConfigType</dt>
273 <dd>
274 <span class="field_meta">
275 (optional if <span class="field">Remove</span> is
276 <span class="value">false</span>, otherwise ignored. Defaults to
277 <span class="value">DHCP</span>)
278 <span class="type">string</span>
279 </span>
280 <span class="rule">
281 <span class="rule_id"></span>
282 Allowed values are <span class="value">DHCP</span> and
283 <span class="value">Static</span>.
284 </span>
285 Determines whether the NameServers configuration is statically configured,
286 see <span class="field">StaticIPConfig</span>, or automatically configured
287 using DHCP.
288 </dd>
289
254 <dt class="field">IPConfigs</dt> 290 <dt class="field">IPConfigs</dt>
255 <dd> 291 <dd>
256 <span class="field_meta"> 292 <span class="field_meta">
257 (optional for connected networks, read-only) 293 (optional for connected networks, read-only)
258 <span class="type">array of IPConfig</span> 294 <span class="type">array of IPConfig</span>
259 </span> 295 </span>
260 Array of IPConfig properties associated with this connection. 296 Array of IPConfig properties associated with this connection.
261 </dd> 297 </dd>
262 298
263 <dt class="field">StaticIPConfig</dt> 299 <dt class="field">StaticIPConfig</dt>
264 <dd> 300 <dd>
265 <span class="field_meta"> 301 <span class="field_meta">
266 (optional if <span class="field">Remove</span> is 302 (required if <span class="field">IPAddressConfigType</span> or
267 <span class="value">false</span>, otherwise ignored) 303 <span class="field">NameServersConfigType</span> is set to
304 <span class="value">Static</span>)
268 <span class="type">IPConfig</span> 305 <span class="type">IPConfig</span>
269 </span> 306 </span>
270 Each property set in this IPConfig object overrides the respective 307 Each property set in this IPConfig object overrides the respective
271 parameter received over DHCP. 308 parameter received over DHCP. If either
309 <span class="field">IPAddressConfigType</span> or
310 <span class="field">NameServersConfigType</span> is set to
311 <span class="value">Static</span>, then this must be provided and any
312 non-default values in the object must be specified.
pneubeck (no reviews) 2015/01/04 11:18:01 The part 'any non-default values ...' is not clear
stevenjb 2015/01/05 21:16:19 Done.
272 </dd> 313 </dd>
273 314
274 <dt class="field">SavedIPConfig</dt> 315 <dt class="field">SavedIPConfig</dt>
275 <dd> 316 <dd>
276 <span class="field_meta"> 317 <span class="field_meta">
277 (optional for connected networks, read-only) 318 (optional for connected networks, read-only)
278 <span class="type">IPConfig</span> 319 <span class="type">IPConfig</span>
279 </span> 320 </span>
280 IPConfig property containing the configuration that was received from the 321 IPConfig property containing the configuration that was received from the
281 DHCP server prior to applying any StaticIPConfig parameters. 322 DHCP server prior to applying any StaticIPConfig parameters.
(...skipping 23 matching lines...) Expand all
305 <dt class="field">ProxySettings</dt> 346 <dt class="field">ProxySettings</dt>
306 <dd> 347 <dd>
307 <span class="field_meta"> 348 <span class="field_meta">
308 (optional if <span class="field">Remove</span> is 349 (optional if <span class="field">Remove</span> is
309 <span class="value">false</span>, otherwise ignored) 350 <span class="value">false</span>, otherwise ignored)
310 <span class="type">ProxySettings</span> 351 <span class="type">ProxySettings</span>
311 </span> 352 </span>
312 Proxy settings for this network 353 Proxy settings for this network
313 </dd> 354 </dd>
314 355
315 <dt class="field">NameServers</dt>
316 <dd>
317 <span class="field_meta">
318 (optional if <span class="field">Remove</span> is
319 <span class="value">false</span>, otherwise ignored)
320 <span class="type">array of string</span>
321 </span>
322 Array of addresses to use for name servers. If not specified, DHCP values
323 will be used.
324 </dd>
325
326 <dt class="field">SearchDomains</dt> 356 <dt class="field">SearchDomains</dt>
327 <dd> 357 <dd>
328 <span class="field_meta"> 358 <span class="field_meta">
329 (optional if <span class="field">Remove</span> is 359 (optional if <span class="field">Remove</span> is
330 <span class="value">false</span>, otherwise ignored) 360 <span class="value">false</span>, otherwise ignored)
331 <span class="type">array of string</span> 361 <span class="type">array of string</span>
332 </span> 362 </span>
333 Array of strings to append to names for resolution. Items in this array 363 Array of strings to append to names for resolution. Items in this array
334 should not start with a dot. Example: 364 should not start with a dot. Example:
335 <span class="snippet">["corp.acme.org", "acme.org"]</span>. If not 365 <span class="snippet">["corp.acme.org", "acme.org"]</span>. If not
(...skipping 199 matching lines...) Expand 10 before | Expand all | Expand 10 after
535 Field <span class="field">IPConfigs</span> is an array 565 Field <span class="field">IPConfigs</span> is an array
536 of <span class="type">IPConfig</span> 566 of <span class="type">IPConfig</span>
537 objects. Each <span class="type">IPConfig</span> object describes a 567 objects. Each <span class="type">IPConfig</span> object describes a
538 particular static IP configuration and contains the following fields: 568 particular static IP configuration and contains the following fields:
539 </p> 569 </p>
540 570
541 <dl class="field_list"> 571 <dl class="field_list">
542 <dt class="field">Type</dt> 572 <dt class="field">Type</dt>
543 <dd> 573 <dd>
544 <span class="field_meta"> 574 <span class="field_meta">
545 (required) 575 (required)
pneubeck (no reviews) 2015/01/04 11:18:01 at least, IPAddress should be marked 'optional'. I
stevenjb 2015/01/05 21:16:19 Changed to (optional).
546 <span class="type">string</span> 576 <span class="type">string</span>
547 </span> 577 </span>
548 <span class="rule"> 578 <span class="rule">
549 <span class="rule_id"></span> 579 <span class="rule_id"></span>
550 Allowed values are <span class="value">IPv4</span> 580 Allowed values are <span class="value">IPv4</span>
551 and <span class="value">IPv6</span> 581 and <span class="value">IPv6</span>
552 </span> 582 </span>
553 Describes the type of configuration this is. 583 Describes the type of configuration this is.
554 </dd> 584 </dd>
555 585
(...skipping 15 matching lines...) Expand all
571 <span class="type">integer</span> 601 <span class="type">integer</span>
572 </span> 602 </span>
573 <span class="rule"> 603 <span class="rule">
574 <span class="rule_id"></span> 604 <span class="rule_id"></span>
575 Must be a number in the range [1, 32] for IPv4 and [1, 128] for IPv6 605 Must be a number in the range [1, 32] for IPv4 and [1, 128] for IPv6
576 addresses. 606 addresses.
577 </span> 607 </span>
578 Describes the routing prefix. 608 Describes the routing prefix.
579 </dd> 609 </dd>
580 610
581 <dt class="field">Gateway</dt> 611 <dt class="field">Gateway</dt>
pneubeck (no reviews) 2015/01/04 11:18:01 how is Gateway handled now? is it always required
stevenjb 2015/01/05 21:16:19 I don't know what Shill will do if Gateway is not
582 <dd> 612 <dd>
583 <span class="field_meta"> 613 <span class="field_meta">
584 (optional) 614 (optional)
585 <span class="type">string</span> 615 <span class="type">string</span>
586 </span> 616 </span>
587 Describes the gateway address to use for the configuration. Must match 617 Describes the gateway address to use for the configuration. Must match
588 address type specified in <span class="field">Type</span> field. If not 618 address type specified in <span class="field">Type</span> field. If not
589 specified, DHCP values will be used. 619 specified, DHCP values will be used.
590 </dd> 620 </dd>
591 621
(...skipping 2431 matching lines...) Expand 10 before | Expand all | Expand 10 after
3023 is transmitted or saved to disk should be secure. On client device, when 3053 is transmitted or saved to disk should be secure. On client device, when
3024 user names for connections that are user-specific are persisted to disk, 3054 user names for connections that are user-specific are persisted to disk,
3025 they should be stored in a location that is encrypted. Users can also opt in 3055 they should be stored in a location that is encrypted. Users can also opt in
3026 these cases to not save their user credentials in the config file and will 3056 these cases to not save their user credentials in the config file and will
3027 instead be prompted when they are needed. 3057 instead be prompted when they are needed.
3028 </p> 3058 </p>
3029 </section> 3059 </section>
3030 </section> 3060 </section>
3031 </body> 3061 </body>
3032 </html> 3062 </html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698