about summary refs log tree commit diff
path: root/docs/api/html/settings-ip-tunnel.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/html/settings-ip-tunnel.html')
-rw-r--r--docs/api/html/settings-ip-tunnel.html30
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/api/html/settings-ip-tunnel.html b/docs/api/html/settings-ip-tunnel.html
index 4f35a153..a012de37 100644
--- a/docs/api/html/settings-ip-tunnel.html
+++ b/docs/api/html/settings-ip-tunnel.html
@@ -38,7 +38,7 @@
             Properties
         </h2>
 <div class="table">
-<a name="id-1.3.3.19.2.2.1"></a><p class="title"><b>Table 65. </b></p>
+<a name="id-1.3.3.19.2.2.1"></a><p class="title"><b>Table 53. </b></p>
 <div class="table-contents"><table class="table" border="1">
 <colgroup>
 <col>
@@ -57,85 +57,85 @@
 <td><pre class="screen">encapsulation-limit</pre></td>
 <td><pre class="screen">uint32</pre></td>
 <td><pre class="screen">0</pre></td>
-<td> </td>
+<td>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1) to ip-tunnel flags.</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> </td>
+<td>Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</td>
 </tr>
 <tr>
 <td><pre class="screen">flow-label</pre></td>
 <td><pre class="screen">uint32</pre></td>
 <td><pre class="screen">0</pre></td>
-<td> </td>
+<td>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</td>
 </tr>
 <tr>
 <td><pre class="screen">fwmark</pre></td>
 <td><pre class="screen">uint32</pre></td>
 <td><pre class="screen">0</pre></td>
-<td> </td>
+<td>The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.</td>
 </tr>
 <tr>
 <td><pre class="screen">input-key</pre></td>
 <td><pre class="screen">string</pre></td>
 <td><pre class="screen"></pre></td>
-<td> </td>
+<td>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</td>
 </tr>
 <tr>
 <td><pre class="screen">local</pre></td>
 <td><pre class="screen">string</pre></td>
 <td><pre class="screen"></pre></td>
-<td> </td>
+<td>The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</td>
 </tr>
 <tr>
 <td><pre class="screen">mode</pre></td>
 <td><pre class="screen">uint32</pre></td>
 <td><pre class="screen">0</pre></td>
-<td> </td>
+<td>The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</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> </td>
+<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</td>
 </tr>
 <tr>
 <td><pre class="screen">output-key</pre></td>
 <td><pre class="screen">string</pre></td>
 <td><pre class="screen"></pre></td>
-<td> </td>
+<td>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</td>
 </tr>
 <tr>
 <td><pre class="screen">parent</pre></td>
 <td><pre class="screen">string</pre></td>
 <td><pre class="screen"></pre></td>
-<td> </td>
+<td>If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</td>
 </tr>
 <tr>
 <td><pre class="screen">path-mtu-discovery</pre></td>
 <td><pre class="screen">boolean</pre></td>
 <td><pre class="screen">TRUE</pre></td>
-<td> </td>
+<td>Whether to enable Path MTU Discovery on this tunnel.</td>
 </tr>
 <tr>
 <td><pre class="screen">remote</pre></td>
 <td><pre class="screen">string</pre></td>
 <td><pre class="screen"></pre></td>
-<td> </td>
+<td>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</td>
 </tr>
 <tr>
 <td><pre class="screen">tos</pre></td>
 <td><pre class="screen">uint32</pre></td>
 <td><pre class="screen">0</pre></td>
-<td> </td>
+<td>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</td>
 </tr>
 <tr>
 <td><pre class="screen">ttl</pre></td>
 <td><pre class="screen">uint32</pre></td>
 <td><pre class="screen">0</pre></td>
-<td> </td>
+<td>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</td>
 </tr>
 </tbody>
 </table></div>