Warning, /frameworks/networkmanager-qt/src/dbus/introspection/org.freedesktop.NetworkManager.Device.xml is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" encoding="UTF-8"?>
0002 <node name="/">
0003   <interface name="org.freedesktop.NetworkManager.Device">
0004 
0005     <!--
0006         Udi:
0007 
0008         Operating-system specific transient device hardware identifier. This is an
0009         opaque string representing the underlying hardware for the device, and
0010         shouldn't be used to keep track of individual devices. For some device
0011         types (Bluetooth, Modems) it is an identifier used by the hardware service
0012         (ie bluez or ModemManager) to refer to that device, and client programs
0013         use it get additional information from those services which NM does not
0014         provide. The Udi is not guaranteed to be consistent across reboots or
0015         hotplugs of the hardware. If you're looking for a way to uniquely track
0016         each device in your application, use the object path. If you're looking
0017         for a way to track a specific piece of hardware across reboot or hotplug,
0018         use a MAC address or USB serial number.
0019     -->
0020     <property name="Udi" type="s" access="read"/>
0021 
0022     <!--
0023         Interface:
0024 
0025         The name of the device's control (and often data) interface.
0026     -->
0027     <property name="Interface" type="s" access="read"/>
0028 
0029     <!--
0030         IpInterface:
0031 
0032         The name of the device's data interface when available. This property may
0033         not refer to the actual data interface until the device has successfully
0034         established a data connection, indicated by the device's State becoming
0035         ACTIVATED.
0036     -->
0037     <property name="IpInterface" type="s" access="read"/>
0038 
0039     <!--
0040         Driver:
0041 
0042         The driver handling the device.
0043     -->
0044     <property name="Driver" type="s" access="read"/>
0045 
0046     <!--
0047         DriverVersion:
0048 
0049         The version of the driver handling the device.
0050     -->
0051     <property name="DriverVersion" type="s" access="read"/>
0052 
0053     <!--
0054         FirmwareVersion:
0055 
0056         The firmware version for the device.
0057     -->
0058     <property name="FirmwareVersion" type="s" access="read"/>
0059 
0060     <!--
0061         Capabilities:
0062 
0063         Flags describing the capabilities of the device.
0064 
0065         Returns: <link linkend="NMDeviceCapabilities">NMDeviceCapabilities</link>
0066     -->
0067     <property name="Capabilities" type="u" access="read"/>
0068 
0069     <!--
0070         Ip4Address:
0071 
0072         DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object
0073         instead.
0074     -->
0075     <property name="Ip4Address" type="u" access="read"/>
0076 
0077     <!--
0078         State:
0079 
0080         The current state of the device.
0081 
0082         Returns: <link linkend="NMDeviceState">NMDeviceState</link>
0083     -->
0084     <property name="State" type="u" access="read"/>
0085 
0086     <!--
0087         StateReason:
0088 
0089         The current state and reason for changing to that state.
0090 
0091         Returns: A tuple of  <link linkend="NMDeviceState">NMDeviceState</link> and  <link linkend="NMDeviceStateReason">NMDeviceStateReason</link>.
0092     -->
0093     <property name="StateReason" type="(uu)" access="read">
0094         <annotation name="org.qtproject.QtDBus.QtTypeName"  value="DeviceDBusStateReason"/>
0095     </property>
0096     <!--
0097         ActiveConnection:
0098 
0099         Object path of an ActiveConnection object that "owns" this device during
0100         activation. The ActiveConnection object tracks the life-cycle of a
0101         connection to a specific network and implements the
0102         org.freedesktop.NetworkManager.Connection.Active D-Bus interface.
0103     -->
0104     <property name="ActiveConnection" type="o" access="read"/>
0105 
0106     <!--
0107         Ip4Config:
0108 
0109         Object path of the Ip4Config object describing the configuration of the
0110         device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED
0111         state.
0112     -->
0113     <property name="Ip4Config" type="o" access="read"/>
0114 
0115     <!--
0116         Dhcp4Config:
0117 
0118         Object path of the Dhcp4Config object describing the DHCP options returned
0119         by the DHCP server. Only valid when the device is in the
0120         NM_DEVICE_STATE_ACTIVATED state.
0121     -->
0122     <property name="Dhcp4Config" type="o" access="read"/>
0123 
0124     <!--
0125         Ip6Config:
0126 
0127         Object path of the Ip6Config object describing the configuration of the
0128         device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED
0129         state.
0130     -->
0131     <property name="Ip6Config" type="o" access="read"/>
0132 
0133     <!--
0134         Dhcp6Config:
0135 
0136         Object path of the Dhcp6Config object describing the DHCP options returned
0137         by the DHCP server. Only valid when the device is in the
0138         NM_DEVICE_STATE_ACTIVATED state.
0139     -->
0140     <property name="Dhcp6Config" type="o" access="read"/>
0141 
0142     <!--
0143         Managed:
0144 
0145         Whether or not this device is managed by NetworkManager. Setting this
0146         property has a similar effect to configuring the device as unmanaged via
0147         the keyfile.unmanaged-devices setting in NetworkManager.conf. Changes to
0148         this value are not persistent and lost after NetworkManager restart.
0149     -->
0150     <property name="Managed" type="b" access="readwrite"/>
0151 
0152     <!--
0153         Autoconnect:
0154 
0155         If TRUE, indicates the device is allowed to autoconnect. If FALSE, manual
0156         intervention is required before the device will automatically connect to a
0157         known network, such as activating a connection using the device, or
0158         setting this property to TRUE. This property cannot be set to TRUE for
0159         default-unmanaged devices, since they never autoconnect.
0160     -->
0161     <property name="Autoconnect" type="b" access="readwrite"/>
0162 
0163     <!--
0164         FirmwareMissing:
0165 
0166         If TRUE, indicates the device is likely missing firmware necessary for its
0167         operation.
0168     -->
0169     <property name="FirmwareMissing" type="b" access="read"/>
0170 
0171     <!--
0172         NmPluginMissing:
0173 
0174         If TRUE, indicates the NetworkManager plugin for the device is likely
0175         missing or misconfigured.
0176     -->
0177     <property name="NmPluginMissing" type="b" access="read"/>
0178 
0179     <!--
0180         DeviceType:
0181 
0182         The general type of the network device; ie Ethernet, WiFi, etc.
0183 
0184         Returns: <link linkend="NMDeviceType">NMDeviceType</link>
0185     -->
0186     <property name="DeviceType" type="u" access="read"/>
0187 
0188     <!--
0189         AvailableConnections:
0190 
0191         An array of object paths of every configured connection that is currently
0192         'available' through this device.
0193     -->
0194     <property name="AvailableConnections" type="ao" access="read"/>
0195 
0196     <!--
0197         PhysicalPortId:
0198 
0199         If non-empty, an (opaque) indicator of the physical network port
0200         associated with the device. This can be used to recognize when two
0201         seemingly-separate hardware devices are actually just different virtual
0202         interfaces to the same physical port.
0203     -->
0204     <property name="PhysicalPortId" type="s" access="read"/>
0205 
0206     <!--
0207         Mtu:
0208 
0209         The device MTU (maximum transmission unit).
0210     -->
0211     <property name="Mtu" type="u" access="read"/>
0212 
0213     <!--
0214         Metered:
0215 
0216         Whether the amount of traffic flowing through the device is subject to
0217         limitations, for example set by service providers.
0218 
0219         Returns: <link linkend="NMMetered">NMMetered</link>
0220     -->
0221     <property name="Metered" type="u" access="read"/>
0222 
0223     <!--
0224         LldpNeighbors:
0225 
0226         Array of LLDP neighbors; each element is a dictionary mapping LLDP TLV
0227         names to variant boxed values.
0228     -->
0229     <property name="LldpNeighbors" type="aa{sv}" access="read">
0230         <annotation name="org.qtproject.QtDBus.QtTypeName" value="NMVariantMapList"/>
0231     </property>
0232     <!--
0233         Real:
0234 
0235         True if the device exists, or False for placeholder devices that do not
0236         yet exist but could be automatically created by NetworkManager if one of
0237         their AvailableConnections was activated.
0238     -->
0239     <property name="Real" type="b" access="read"/>
0240 
0241     <!--
0242         Reapply:
0243         @connection: The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarly differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses.
0244         @version_id: If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply.
0245         @flags: Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0.
0246 
0247         Attempts to update the configuration of a device without deactivating it.
0248         NetworkManager has the concept of connections, which are profiles that
0249         contain the configuration for a networking device. Those connections are
0250         exposed via D-Bus as individual objects that can be created, modified and
0251         deleted. When activating such a settings-connection on a device, the
0252         settings-connection is cloned to become an applied-connection and used to
0253         configure the device (see GetAppliedConnection). Subsequent modification
0254         of the settings-connection don't propagate automatically to the device's
0255         applied-connection (with exception of the firewall-zone and the metered
0256         property). For the changes to take effect, you can either re-activate the
0257         settings-connection, or call Reapply. The Reapply call allows you to
0258         directly update the applied-connection and reconfigure the device. Reapply
0259         can also be useful if the currently applied-connection is equal to the
0260         connection that is about to be reapplied. This allows to reconfigure the
0261         device and revert external changes like removing or adding an IP address
0262         (which NetworkManager doesn't revert automatically because it is assumed
0263         that the user made these changes intentionally outside of NetworkManager).
0264         Reapply can make the applied-connection different from the
0265         settings-connection, just like updating the settings-connection can make
0266         them different.
0267     -->
0268     <method name="Reapply">
0269       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMapMap"/>
0270       <arg name="connection" type="a{sa{sv}}" direction="in"/>
0271       <arg name="version_id" type="t" direction="in"/>
0272       <arg name="flags" type="u" direction="in"/>
0273       </method>
0274 
0275     <!--
0276         GetAppliedConnection:
0277         @flags: Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0.
0278         @connection: The effective connection settings that the connection has currently applied.
0279         @version_id: The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail.
0280 
0281         Get the currently applied connection on the device. This is a snapshot of
0282         the last activated connection on the device, that is the configuration
0283         that is currently applied on the device. Usually this is the same as
0284         GetSettings of the referenced settings connection. However, it can differ
0285         if the settings connection was subsequently modified or the applied
0286         connection was modified by Reapply. The applied connection is set when
0287         activating a device or when calling Reapply.
0288     -->
0289     <method name="GetAppliedConnection">
0290       <arg name="flags" type="u" direction="in"/>
0291       <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="NMVariantMapMap"/>
0292       <arg name="connection" type="a{sa{sv}}" direction="out"/>
0293       <arg name="version_id" type="t" direction="out"/>
0294       </method>
0295 
0296     <!--
0297         Disconnect:
0298 
0299         Disconnects a device and prevents the device from automatically activating
0300         further connections without user intervention.
0301     -->
0302     <method name="Disconnect"/>
0303 
0304     <!--
0305         Delete:
0306 
0307         Deletes a software device from NetworkManager and removes the interface
0308         from the system. The method returns an error when called for a hardware
0309         device.
0310     -->
0311     <method name="Delete"/>
0312 
0313     <!--
0314         StateChanged:
0315         @new_state: (<link linkend="NMDeviceState">NMDeviceState</link>) The new state of the device.
0316         @old_state: (<link linkend="NMDeviceState">NMDeviceState</link>) The previous state of the device.
0317         @reason: (<link linkend="NMDeviceStateReason">NMDeviceStateReason</link>) A reason for the state transition.
0318     -->
0319     <signal name="StateChanged">
0320       <arg name="new_state" type="u"/>
0321       <arg name="old_state" type="u"/>
0322       <arg name="reason" type="u"/>
0323     </signal>
0324   </interface>
0325 </node>