summary refs log tree commit diff
path: root/docs/api/dbus-org.freedesktop.NetworkManager.Device.IPTunnel.xml
blob: f57e395f2e8e7d3cd9e042ebf6d1a6ad1b273bc5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry id="gdbus-org.freedesktop.NetworkManager.Device.IPTunnel">
  <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-NetworkManager-Device-IPTunnel.top_of_page">org.freedesktop.NetworkManager.Device.IPTunnel</refentrytitle>
  <indexterm zone="gdbus-interface-org-freedesktop-NetworkManager-Device-IPTunnel.top_of_page"><primary sortas=".Device.IPTunnel">org.freedesktop.NetworkManager.Device.IPTunnel</primary></indexterm>
  </refmeta>  <refnamediv>    <refname>org.freedesktop.NetworkManager.Device.IPTunnel</refname>    <refpurpose>IP Tunneling Device.</refpurpose>  </refnamediv>  <refsect1 role="properties">
    <title role="properties.title">Properties</title>
    <synopsis>
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Mode">Mode</link>                readable   u
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Parent">Parent</link>              readable   o
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Local">Local</link>               readable   s
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Remote">Remote</link>              readable   s
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Ttl">Ttl</link>                 readable   y
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Tos">Tos</link>                 readable   y
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.PathMtuDiscovery">PathMtuDiscovery</link>    readable   b
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.InputKey">InputKey</link>            readable   s
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.OutputKey">OutputKey</link>           readable   s
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.EncapsulationLimit">EncapsulationLimit</link>  readable   y
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.FlowLabel">FlowLabel</link>           readable   u
<link linkend="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Flags">Flags</link>               readable   u
</synopsis>
  </refsect1>
<refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-Device-IPTunnel">
  <title role="desc.title">Description</title>
  <para></para>
</refsect1>
<refsect1 role="details" id="gdbus-properties-org.freedesktop.NetworkManager.Device.IPTunnel">
  <title role="details.title">Property Details</title>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Mode">
  <title>The "Mode" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Mode"><primary sortas=".Device.IPTunnel:Mode">org.freedesktop.NetworkManager.Device.IPTunnel:Mode</primary></indexterm>
<programlisting>
Mode  readable   u
</programlisting>
<para>        The tunneling mode.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Parent">
  <title>The "Parent" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Parent"><primary sortas=".Device.IPTunnel:Parent">org.freedesktop.NetworkManager.Device.IPTunnel:Parent</primary></indexterm>
<programlisting>
Parent  readable   o
</programlisting>
<para>        The object path of the parent device.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Local">
  <title>The "Local" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Local"><primary sortas=".Device.IPTunnel:Local">org.freedesktop.NetworkManager.Device.IPTunnel:Local</primary></indexterm>
<programlisting>
Local  readable   s
</programlisting>
<para>        The local endpoint of the tunnel.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Remote">
  <title>The "Remote" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Remote"><primary sortas=".Device.IPTunnel:Remote">org.freedesktop.NetworkManager.Device.IPTunnel:Remote</primary></indexterm>
<programlisting>
Remote  readable   s
</programlisting>
<para>        The remote endpoint of the tunnel.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Ttl">
  <title>The "Ttl" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Ttl"><primary sortas=".Device.IPTunnel:Ttl">org.freedesktop.NetworkManager.Device.IPTunnel:Ttl</primary></indexterm>
<programlisting>
Ttl  readable   y
</programlisting>
<para>        The TTL assigned to tunneled packets. 0 is a special value meaning that
        packets inherit the TTL value
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Tos">
  <title>The "Tos" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Tos"><primary sortas=".Device.IPTunnel:Tos">org.freedesktop.NetworkManager.Device.IPTunnel:Tos</primary></indexterm>
<programlisting>
Tos  readable   y
</programlisting>
<para>        The type of service (IPv4) or traffic class (IPv6) assigned to tunneled
        packets.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.PathMtuDiscovery">
  <title>The "PathMtuDiscovery" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.PathMtuDiscovery"><primary sortas=".Device.IPTunnel:PathMtuDiscovery">org.freedesktop.NetworkManager.Device.IPTunnel:PathMtuDiscovery</primary></indexterm>
<programlisting>
PathMtuDiscovery  readable   b
</programlisting>
<para>        Whether path MTU discovery is enabled on this tunnel.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.InputKey">
  <title>The "InputKey" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.InputKey"><primary sortas=".Device.IPTunnel:InputKey">org.freedesktop.NetworkManager.Device.IPTunnel:InputKey</primary></indexterm>
<programlisting>
InputKey  readable   s
</programlisting>
<para>        The key used for incoming packets.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.OutputKey">
  <title>The "OutputKey" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.OutputKey"><primary sortas=".Device.IPTunnel:OutputKey">org.freedesktop.NetworkManager.Device.IPTunnel:OutputKey</primary></indexterm>
<programlisting>
OutputKey  readable   s
</programlisting>
<para>        The key used for outgoing packets.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.EncapsulationLimit">
  <title>The "EncapsulationLimit" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.EncapsulationLimit"><primary sortas=".Device.IPTunnel:EncapsulationLimit">org.freedesktop.NetworkManager.Device.IPTunnel:EncapsulationLimit</primary></indexterm>
<programlisting>
EncapsulationLimit  readable   y
</programlisting>
<para>        How many additional levels of encapsulation are permitted to be prepended
        to packets. This property applies only to IPv6 tunnels.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.FlowLabel">
  <title>The "FlowLabel" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.FlowLabel"><primary sortas=".Device.IPTunnel:FlowLabel">org.freedesktop.NetworkManager.Device.IPTunnel:FlowLabel</primary></indexterm>
<programlisting>
FlowLabel  readable   u
</programlisting>
<para>        The flow label to assign to tunnel packets. This property applies only to
        IPv6 tunnels.
</para>
</refsect2>
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Flags">
  <title>The "Flags" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Device-IPTunnel.Flags"><primary sortas=".Device.IPTunnel:Flags">org.freedesktop.NetworkManager.Device.IPTunnel:Flags</primary></indexterm>
<programlisting>
Flags  readable   u
</programlisting>
<para>        Tunnel flags.
</para>
</refsect2>
</refsect1>
</refentry>