NetworkManager/introspection/nm-device-vxlan.xml
Lubomir Rintel 618373a14f dbus: use the annotations for documentation
gdbus only understands those (and gtk docstrings, which we should eventually
use) when generating the documentation.
2016-03-26 11:28:19 +01:00

129 lines
4.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.Device.Vxlan">
<property name="Parent" type="o" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The object path of the parent device (if the VXLAN is not
purely internal to this host).
" />
</property>
<property name="HwAddress" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Hardware address of the device.
" />
</property>
<property name="Id" type="u" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The VXLAN Network Identifier (VNI).
" />
</property>
<property name="Group" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The IP (v4 or v6) multicast group used to communicate with other physical
hosts on this VXLAN.
" />
</property>
<property name="Local" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The local IPv4 or IPv6 address to use when sending VXLAN packets to other
physical hosts.
" />
</property>
<property name="Tos" type="y" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The value to use in the IP ToS field for VXLAN packets sent to
other physical hosts.
" />
</property>
<property name="Ttl" type="y" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The value to use in the IP TTL field for VXLAN packets sent to
other physical hosts.
" />
</property>
<property name="Learning" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
True if the VXLAN dynamically learns remote IP addresses.
" />
</property>
<property name="Ageing" type="u" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The interval in seconds at which the kernel purges stale
cached addresses.
" />
</property>
<property name="Limit" type="u" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The maximum number of entries that can be added to the VXLAN's
forwarding table.
" />
</property>
<property name="DstPort" type="q" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Destination port for outgoing VXLAN packets.
" />
</property>
<property name="SrcPortMin" type="q" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The lowest source port number to use for outgoing VXLAN packets.
" />
</property>
<property name="SrcPortMax" type="q" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The highest source port number to use for outgoing VXLAN packets.
" />
</property>
<property name="Proxy" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
True if the VXLAN is implementing DOVE ARP proxying for remote
clients.
" />
</property>
<property name="Rsc" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
True if the VXLAN is implementing DOVE route short-circuiting
of known remote IP addresses.
" />
</property>
<property name="L2miss" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
True if the VXLAN will emit netlink notifications of L2 switch
misses.
" />
</property>
<property name="L3miss" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
True if the VXLAN will emit netlink notifications of L3 switch
misses.
" />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
" />
</arg>
</signal>
</interface>
</node>