OLD | NEW |
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 Loading... |
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> if |
| 260 <span class="field">NameServersConfigType</span> is specified) |
| 261 <span class="type">string</span> |
| 262 </span> |
| 263 <span class="rule"> |
| 264 <span class="rule_id"></span> |
| 265 Allowed values are <span class="value">DHCP</span> and |
| 266 <span class="value">Static</span>. |
| 267 </span> |
| 268 Determines whether the IP Address configuration is statically configured, |
| 269 see <span class="field">StaticIPConfig</span>, or automatically configured |
| 270 using DHCP. |
| 271 </dd> |
| 272 |
| 273 <dt class="field">NameServersConfigType</dt> |
| 274 <dd> |
| 275 <span class="field_meta"> |
| 276 (optional if <span class="field">Remove</span> is |
| 277 <span class="value">false</span>, otherwise ignored. Defaults to |
| 278 <span class="value">DHCP</span> if |
| 279 <span class="field">IPAddressConfigType</span> is specified) |
| 280 <span class="type">string</span> |
| 281 </span> |
| 282 <span class="rule"> |
| 283 <span class="rule_id"></span> |
| 284 Allowed values are <span class="value">DHCP</span> and |
| 285 <span class="value">Static</span>. |
| 286 </span> |
| 287 Determines whether the NameServers configuration is statically configured, |
| 288 see <span class="field">StaticIPConfig</span>, or automatically configured |
| 289 using DHCP. |
| 290 </dd> |
| 291 |
254 <dt class="field">IPConfigs</dt> | 292 <dt class="field">IPConfigs</dt> |
255 <dd> | 293 <dd> |
256 <span class="field_meta"> | 294 <span class="field_meta"> |
257 (optional for connected networks, read-only) | 295 (optional for connected networks, read-only) |
258 <span class="type">array of IPConfig</span> | 296 <span class="type">array of IPConfig</span> |
259 </span> | 297 </span> |
260 Array of IPConfig properties associated with this connection. | 298 Array of IPConfig properties associated with this connection. |
261 </dd> | 299 </dd> |
262 | 300 |
263 <dt class="field">StaticIPConfig</dt> | 301 <dt class="field">StaticIPConfig</dt> |
264 <dd> | 302 <dd> |
265 <span class="field_meta"> | 303 <span class="field_meta"> |
266 (optional if <span class="field">Remove</span> is | 304 (required if <span class="field">IPAddressConfigType</span> or |
267 <span class="value">false</span>, otherwise ignored) | 305 <span class="field">NameServersConfigType</span> is set to |
| 306 <span class="value">Static</span>) |
268 <span class="type">IPConfig</span> | 307 <span class="type">IPConfig</span> |
269 </span> | 308 </span> |
270 Each property set in this IPConfig object overrides the respective | 309 Each property set in this IPConfig object overrides the respective |
271 parameter received over DHCP. | 310 parameter received over DHCP. |
| 311 If <span class="field">IPAddressConfigType</span> is set to |
| 312 <span class="value">Static</span>, <span class="field">IPAddress</span> |
| 313 and <span class="field">Gateway</span> are required. |
| 314 If <span class="field">NameServersConfigType</span> is set to |
| 315 <span class="value">Static</span>, <span class="field">NameServers</span> |
| 316 is required. |
272 </dd> | 317 </dd> |
273 | 318 |
274 <dt class="field">SavedIPConfig</dt> | 319 <dt class="field">SavedIPConfig</dt> |
275 <dd> | 320 <dd> |
276 <span class="field_meta"> | 321 <span class="field_meta"> |
277 (optional for connected networks, read-only) | 322 (optional for connected networks, read-only) |
278 <span class="type">IPConfig</span> | 323 <span class="type">IPConfig</span> |
279 </span> | 324 </span> |
280 IPConfig property containing the configuration that was received from the | 325 IPConfig property containing the configuration that was received from the |
281 DHCP server prior to applying any StaticIPConfig parameters. | 326 DHCP server prior to applying any StaticIPConfig parameters. |
(...skipping 244 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
526 <span class="rule_id"></span> | 571 <span class="rule_id"></span> |
527 Allowed values are <span class="value">IPv4</span> | 572 Allowed values are <span class="value">IPv4</span> |
528 and <span class="value">IPv6</span> | 573 and <span class="value">IPv6</span> |
529 </span> | 574 </span> |
530 Describes the type of configuration this is. | 575 Describes the type of configuration this is. |
531 </dd> | 576 </dd> |
532 | 577 |
533 <dt class="field">IPAddress</dt> | 578 <dt class="field">IPAddress</dt> |
534 <dd> | 579 <dd> |
535 <span class="field_meta"> | 580 <span class="field_meta"> |
536 (required) | 581 (optional) |
537 <span class="type">string</span> | 582 <span class="type">string</span> |
538 </span> | 583 </span> |
539 Describes the IPv4 or IPv6 address of a connection, depending on the value | 584 Describes the IPv4 or IPv6 address of a connection, depending on the value |
540 of <span class="field">Type</span> field. It should not contain the | 585 of <span class="field">Type</span> field. It should not contain the |
541 routing prefix (i.e. should not end in something like /64). | 586 routing prefix (i.e. should not end in something like /64). |
542 </dd> | 587 </dd> |
543 | 588 |
544 <dt class="field">RoutingPrefix</dt> | 589 <dt class="field">RoutingPrefix</dt> |
545 <dd> | 590 <dd> |
546 <span class="field_meta"> | 591 <span class="field_meta"> |
547 (required if <span class="field">IPAddress</span> is set. Otherwise | 592 (required if <span class="field">IPAddress</span> is set. Otherwise |
548 ignored.) | 593 ignored.) |
549 <span class="type">integer</span> | 594 <span class="type">integer</span> |
550 </span> | 595 </span> |
551 <span class="rule"> | 596 <span class="rule"> |
552 <span class="rule_id"></span> | 597 <span class="rule_id"></span> |
553 Must be a number in the range [1, 32] for IPv4 and [1, 128] for IPv6 | 598 Must be a number in the range [1, 32] for IPv4 and [1, 128] for IPv6 |
554 addresses. | 599 addresses. |
555 </span> | 600 </span> |
556 Describes the routing prefix. | 601 Describes the routing prefix. |
557 </dd> | 602 </dd> |
558 | 603 |
559 <dt class="field">Gateway</dt> | 604 <dt class="field">Gateway</dt> |
560 <dd> | 605 <dd> |
561 <span class="field_meta"> | 606 <span class="field_meta"> |
562 (optional) | 607 (required if <span class="field">IPAddress</span> is set. Otherwise |
| 608 ignored.) |
563 <span class="type">string</span> | 609 <span class="type">string</span> |
564 </span> | 610 </span> |
565 Describes the gateway address to use for the configuration. Must match | 611 Describes the gateway address to use for the configuration. Must match |
566 address type specified in <span class="field">Type</span> field. If not | 612 address type specified in <span class="field">Type</span> field. If not |
567 specified, DHCP values will be used. | 613 specified, DHCP values will be used. |
568 </dd> | 614 </dd> |
569 | 615 |
570 <dt class="field">NameServers</dt> | 616 <dt class="field">NameServers</dt> |
571 <dd> | 617 <dd> |
572 <span class="field_meta"> | 618 <span class="field_meta"> |
(...skipping 2426 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2999 is transmitted or saved to disk should be secure. On client device, when | 3045 is transmitted or saved to disk should be secure. On client device, when |
3000 user names for connections that are user-specific are persisted to disk, | 3046 user names for connections that are user-specific are persisted to disk, |
3001 they should be stored in a location that is encrypted. Users can also opt in | 3047 they should be stored in a location that is encrypted. Users can also opt in |
3002 these cases to not save their user credentials in the config file and will | 3048 these cases to not save their user credentials in the config file and will |
3003 instead be prompted when they are needed. | 3049 instead be prompted when they are needed. |
3004 </p> | 3050 </p> |
3005 </section> | 3051 </section> |
3006 </section> | 3052 </section> |
3007 </body> | 3053 </body> |
3008 </html> | 3054 </html> |
OLD | NEW |