dbus: use the annotations for documentation
[NetworkManager.git] / introspection / nm-device-vxlan.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4   <interface name="org.freedesktop.NetworkManager.Device.Vxlan">
5
6     <property name="Parent" type="o" access="read">
7       <annotation name="org.gtk.GDBus.DocString" value="
8         The object path of the parent device (if the VXLAN is not
9         purely internal to this host).
10       " />
11     </property>
12
13     <property name="HwAddress" type="s" access="read">
14       <annotation name="org.gtk.GDBus.DocString" value="
15         Hardware address of the device.
16       " />
17     </property>
18
19     <property name="Id" type="u" access="read">
20       <annotation name="org.gtk.GDBus.DocString" value="
21         The VXLAN Network Identifier (VNI).
22       " />
23     </property>
24
25     <property name="Group" type="s" access="read">
26       <annotation name="org.gtk.GDBus.DocString" value="
27         The IP (v4 or v6) multicast group used to communicate with other physical
28         hosts on this VXLAN.
29       " />
30     </property>
31
32     <property name="Local" type="s" access="read">
33       <annotation name="org.gtk.GDBus.DocString" value="
34         The local IPv4 or IPv6 address to use when sending VXLAN packets to other
35         physical hosts.
36       " />
37     </property>
38
39     <property name="Tos" type="y" access="read">
40       <annotation name="org.gtk.GDBus.DocString" value="
41         The value to use in the IP ToS field for VXLAN packets sent to
42         other physical hosts.
43       " />
44     </property>
45
46     <property name="Ttl" type="y" access="read">
47       <annotation name="org.gtk.GDBus.DocString" value="
48         The value to use in the IP TTL field for VXLAN packets sent to
49         other physical hosts.
50       " />
51     </property>
52
53     <property name="Learning" type="b" access="read">
54       <annotation name="org.gtk.GDBus.DocString" value="
55         True if the VXLAN dynamically learns remote IP addresses.
56       " />
57     </property>
58
59     <property name="Ageing" type="u" access="read">
60       <annotation name="org.gtk.GDBus.DocString" value="
61         The interval in seconds at which the kernel purges stale
62         cached addresses.
63       " />
64     </property>
65
66     <property name="Limit" type="u" access="read">
67       <annotation name="org.gtk.GDBus.DocString" value="
68         The maximum number of entries that can be added to the VXLAN's
69         forwarding table.
70       " />
71     </property>
72
73     <property name="DstPort" type="q" access="read">
74       <annotation name="org.gtk.GDBus.DocString" value="
75         Destination port for outgoing VXLAN packets.
76       " />
77     </property>
78
79     <property name="SrcPortMin" type="q" access="read">
80       <annotation name="org.gtk.GDBus.DocString" value="
81         The lowest source port number to use for outgoing VXLAN packets.
82       " />
83     </property>
84
85     <property name="SrcPortMax" type="q" access="read">
86       <annotation name="org.gtk.GDBus.DocString" value="
87         The highest source port number to use for outgoing VXLAN packets.
88       " />
89     </property>
90
91     <property name="Proxy" type="b" access="read">
92       <annotation name="org.gtk.GDBus.DocString" value="
93         True if the VXLAN is implementing DOVE ARP proxying for remote
94         clients.
95       " />
96     </property>
97
98     <property name="Rsc" type="b" access="read">
99       <annotation name="org.gtk.GDBus.DocString" value="
100         True if the VXLAN is implementing DOVE route short-circuiting
101         of known remote IP addresses.
102       " />
103     </property>
104
105     <property name="L2miss" type="b" access="read">
106       <annotation name="org.gtk.GDBus.DocString" value="
107         True if the VXLAN will emit netlink notifications of L2 switch
108         misses.
109       " />
110     </property>
111
112     <property name="L3miss" type="b" access="read">
113       <annotation name="org.gtk.GDBus.DocString" value="
114         True if the VXLAN will emit netlink notifications of L3 switch
115         misses.
116       " />
117     </property>
118
119     <signal name="PropertiesChanged">
120         <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
121             <annotation name="org.gtk.GDBus.DocString" value="
122                 A dictionary mapping property names to variant boxed values
123             " />
124         </arg>
125     </signal>
126
127   </interface>
128 </node>