diff options
Diffstat (limited to 'docs/api/html/ref-settings.html')
| -rw-r--r-- | docs/api/html/ref-settings.html | 227 |
1 files changed, 208 insertions, 19 deletions
diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html index b1737585..7278b958 100644 --- a/docs/api/html/ref-settings.html +++ b/docs/api/html/ref-settings.html @@ -23,7 +23,7 @@ <div class="titlepage"><div><div><h2 class="title"> <a name="ref-settings"></a>Network Configuration Setting Specification</h2></div></div></div> <div class="toc"><dl> -<dt><span class="section"><a href="ref-settings.html#id543085">Configuration Settings</a></span></dt> +<dt><span class="section"><a href="ref-settings.html#id561824">Configuration Settings</a></span></dt> <dt><span class="section"><a href="secrets-flags.html">Secret flag types</a></span></dt> </dl></div> <p> @@ -35,11 +35,11 @@ </p> <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> -<a name="id543085"></a>Configuration Settings</h2></div></div></div> +<a name="id561824"></a>Configuration Settings</h2></div></div></div> <p> </p> <div class="table"> -<a name="id520594"></a><p class="title"><b>Table 1. 802-1x setting</b></p> +<a name="id543615"></a><p class="title"><b>Table 1. 802-1x setting</b></p> <div class="table-contents"><table summary="802-1x setting" border="1"> <colgroup> <col> @@ -79,6 +79,12 @@ <td>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</td> </tr> <tr> +<td><pre class="screen">pac-file</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>UTF-8 encoded file path containing PAC for EAP-FAST.</td> +</tr> +<tr> <td><pre class="screen">ca-cert</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen">[]</pre></td> @@ -181,6 +187,18 @@ <td>Flags indicating how to handle the 802.1x password. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> </tr> <tr> +<td><pre class="screen">password-raw</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>Password used for EAP authentication methods as a byte array</td> +</tr> +<tr> +<td><pre class="screen">password-raw-flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>Flags indicating how to handle the 802.1x password byte array. (see <a class="xref" href="secrets-flags.html" title="Secret flag types">the section called “Secret flag types”</a> for flag values)</td> +</tr> +<tr> <td><pre class="screen">private-key</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen">[]</pre></td> @@ -228,7 +246,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id529209"></a><p class="title"><b>Table 2. bluetooth setting</b></p> +<a name="id547978"></a><p class="title"><b>Table 2. bluetooth setting</b></p> <div class="table-contents"><table summary="bluetooth setting" border="1"> <colgroup> <col> @@ -267,7 +285,46 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id529342"></a><p class="title"><b>Table 3. cdma setting</b></p> +<a name="id548111"></a><p class="title"><b>Table 3. bond setting</b></p> +<div class="table-contents"><table summary="bond setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">bond</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">interface-name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The name of the virtual in-kernel bonding network interface</td> +</tr> +<tr> +<td><pre class="screen">options</pre></td> +<td><pre class="screen">dict of (string::string)</pre></td> +<td><pre class="screen">[ ]</pre></td> +<td>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id548244"></a><p class="title"><b>Table 4. cdma setting</b></p> <div class="table-contents"><table summary="cdma setting" border="1"> <colgroup> <col> @@ -318,7 +375,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id529540"></a><p class="title"><b>Table 4. connection setting</b></p> +<a name="id548442"></a><p class="title"><b>Table 5. connection setting</b></p> <div class="table-contents"><table summary="connection setting" border="1"> <colgroup> <col> @@ -381,13 +438,31 @@ <td><pre class="screen">FALSE</pre></td> <td>If TRUE, the connection is read-only and cannot be changed by the user or any other mechanism. This is normally set for system connections whose plugin cannot yet write updated connections back out.</td> </tr> +<tr> +<td><pre class="screen">zone</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The trust level of a the connection.Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.</td> +</tr> +<tr> +<td><pre class="screen">master</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Interface name of the master device or UUID of the master connection</td> +</tr> +<tr> +<td><pre class="screen">slave-type</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>Setting name describing the type of slave this connection is (ie, 'bond') or NULL if this connection is not a slave.</td> +</tr> </tbody> </table></div> </div> <p><br class="table-break"> </p> <div class="table"> -<a name="id529841"></a><p class="title"><b>Table 5. gsm setting</b></p> +<a name="id548833"></a><p class="title"><b>Table 6. gsm setting</b></p> <div class="table-contents"><table summary="gsm setting" border="1"> <colgroup> <col> @@ -480,7 +555,52 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id530266"></a><p class="title"><b>Table 6. ipv4 setting</b></p> +<a name="id578510"></a><p class="title"><b>Table 7. infiniband setting</b></p> +<div class="table-contents"><table summary="infiniband setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">infiniband</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">mac-address</pre></td> +<td><pre class="screen">byte array</pre></td> +<td><pre class="screen">[]</pre></td> +<td>If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</td> +</tr> +<tr> +<td><pre class="screen">mtu</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</td> +</tr> +<tr> +<td><pre class="screen">transport-mode</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>The IPoIB transport mode. Either 'datagram' or 'connected'.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id578649"></a><p class="title"><b>Table 8. ipv4 setting</b></p> <div class="table-contents"><table summary="ipv4 setting" border="1"> <colgroup> <col> @@ -570,7 +690,7 @@ <tr> <td><pre class="screen">may-fail</pre></td> <td><pre class="screen">boolean</pre></td> -<td><pre class="screen">FALSE</pre></td> +<td><pre class="screen">TRUE</pre></td> <td>If TRUE, allow overall network configuration to proceed even if IPv4 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</td> </tr> </tbody> @@ -579,7 +699,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id559244"></a><p class="title"><b>Table 7. ipv6 setting</b></p> +<a name="id579045"></a><p class="title"><b>Table 9. ipv6 setting</b></p> <div class="table-contents"><table summary="ipv6 setting" border="1"> <colgroup> <col> @@ -654,13 +774,19 @@ <td><pre class="screen">TRUE</pre></td> <td>If TRUE, allow overall network configuration to proceed even if IPv6 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv4-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully.</td> </tr> +<tr> +<td><pre class="screen">ip6-privacy</pre></td> +<td><pre class="screen">int32</pre></td> +<td><pre class="screen">-1</pre></td> +<td>Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</td> +</tr> </tbody> </table></div> </div> <p><br class="table-break"> </p> <div class="table"> -<a name="id559562"></a><p class="title"><b>Table 8. 802-11-olpc-mesh setting</b></p> +<a name="id579392"></a><p class="title"><b>Table 10. 802-11-olpc-mesh setting</b></p> <div class="table-contents"><table summary="802-11-olpc-mesh setting" border="1"> <colgroup> <col> @@ -705,7 +831,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id559700"></a><p class="title"><b>Table 9. ppp setting</b></p> +<a name="id579530"></a><p class="title"><b>Table 11. ppp setting</b></p> <div class="table-contents"><table summary="ppp setting" border="1"> <colgroup> <col> @@ -840,7 +966,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id560230"></a><p class="title"><b>Table 10. pppoe setting</b></p> +<a name="id580187"></a><p class="title"><b>Table 12. pppoe setting</b></p> <div class="table-contents"><table summary="pppoe setting" border="1"> <colgroup> <col> @@ -891,7 +1017,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id560395"></a><p class="title"><b>Table 11. serial setting</b></p> +<a name="id580393"></a><p class="title"><b>Table 13. serial setting</b></p> <div class="table-contents"><table summary="serial setting" border="1"> <colgroup> <col> @@ -948,7 +1074,70 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id560589"></a><p class="title"><b>Table 12. vpn setting</b></p> +<a name="id580632"></a><p class="title"><b>Table 14. vlan setting</b></p> +<div class="table-contents"><table summary="vlan setting" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen">vlan</pre></td> +<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td> +</tr> +<tr> +<td><pre class="screen">interface-name</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>If given, specifies the kernel name of the VLAN interface. If not given, a default name will be constructed from the interface described by the parent interface and the 'id' property, ex 'eth2.1'. The parent interface may be given by the 'parent' property or by a hardware address property, eg the 'wired' or 'infiniband' settings' 'mac-address' property.</td> +</tr> +<tr> +<td><pre class="screen">parent</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain a hardware address in a hardware-specific setting, like the 'wired' or 'infiniband' settings' 'mac-address' property.</td> +</tr> +<tr> +<td><pre class="screen">id</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>The VLAN indentifier the interface created by this connection should be assigned.</td> +</tr> +<tr> +<td><pre class="screen">flags</pre></td> +<td><pre class="screen">uint32</pre></td> +<td><pre class="screen">0</pre></td> +<td>One or more flags which control the behavior and features of the VLAN interface. Flags include reordering of output packet headers (0x01), use of the GVRP protocol (0x02), and loose binding of the interface to its master device's operating state (0x04).</td> +</tr> +<tr> +<td><pre class="screen">ingress-priority-map</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.</td> +</tr> +<tr> +<td><pre class="screen">egress-priority-map</pre></td> +<td><pre class="screen">array of string</pre></td> +<td><pre class="screen">[]</pre></td> +<td>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"> +</p> +<div class="table"> +<a name="id580907"></a><p class="title"><b>Table 15. vpn setting</b></p> <div class="table-contents"><table summary="vpn setting" border="1"> <colgroup> <col> @@ -999,7 +1188,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id560795"></a><p class="title"><b>Table 13. wimax setting</b></p> +<a name="id581112"></a><p class="title"><b>Table 16. wimax setting</b></p> <div class="table-contents"><table summary="wimax setting" border="1"> <colgroup> <col> @@ -1038,7 +1227,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id560933"></a><p class="title"><b>Table 14. 802-3-ethernet setting</b></p> +<a name="id581251"></a><p class="title"><b>Table 17. 802-3-ethernet setting</b></p> <div class="table-contents"><table summary="802-3-ethernet setting" border="1"> <colgroup> <col> @@ -1131,7 +1320,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id561374"></a><p class="title"><b>Table 15. 802-11-wireless setting</b></p> +<a name="id581691"></a><p class="title"><b>Table 18. 802-11-wireless setting</b></p> <div class="table-contents"><table summary="802-11-wireless setting" border="1"> <colgroup> <col> @@ -1236,7 +1425,7 @@ <p><br class="table-break"> </p> <div class="table"> -<a name="id561883"></a><p class="title"><b>Table 16. 802-11-wireless-security setting</b></p> +<a name="id582200"></a><p class="title"><b>Table 19. 802-11-wireless-security setting</b></p> <div class="table-contents"><table summary="802-11-wireless-security setting" border="1"> <colgroup> <col> |