1 <?xml version="1.0" encoding="UTF-8" ?>
3 <node name="/org/freedesktop/NetworkManager/Settings" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4 <interface name="org.freedesktop.NetworkManager.Settings">
5 <annotation name="org.gtk.GDBus.DocString" value="
6 The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager.
9 <method name="ListConnections">
10 <annotation name="org.gtk.GDBus.DocString" value="
11 List the saved network connections known to NetworkManager.
13 <arg name="connections" type="ao" direction="out">
14 <annotation name="org.gtk.GDBus.DocString" value="
20 <method name="GetConnectionByUuid">
21 <annotation name="org.gtk.GDBus.DocString" value="
22 Retrieve the object path of a connection, given that connection's UUID.
24 <arg name="uuid" type="s" direction="in">
25 <annotation name="org.gtk.GDBus.DocString" value="
26 The UUID to find the connection object path for.
29 <arg name="connection" type="o" direction="out">
30 <annotation name="org.gtk.GDBus.DocString" value="
31 The connection's object path.
36 <method name="AddConnection">
37 <annotation name="org.gtk.GDBus.DocString" value="
38 Add new connection and save it to disk. This operation does not start
39 the network connection unless (1) device is idle and able to connect to
40 the network described by the new connection, and (2) the connection
41 is allowed to be started automatically.
43 <arg name="connection" type="a{sa{sv}}" direction="in">
44 <annotation name="org.gtk.GDBus.DocString" value="
45 Connection settings and properties.
48 <arg name="path" type="o" direction="out">
49 <annotation name="org.gtk.GDBus.DocString" value="
50 Object path of the new connection that was just added.
55 <method name="AddConnectionUnsaved">
56 <annotation name="org.gtk.GDBus.DocString" value="
57 Add new connection but do not save it to disk immediately. This
58 operation does not start the network connection unless (1) device is
59 idle and able to connect to the network described by the new connection,
60 and (2) the connection is allowed to be started automatically.
62 Use the 'Save' method on the connection to save these changes
63 to disk. Note that unsaved changes will be lost if the
64 connection is reloaded from disk (either automatically on file
65 change or due to an explicit ReloadConnections call).
67 <arg name="connection" type="a{sa{sv}}" direction="in">
68 <annotation name="org.gtk.GDBus.DocString" value="
69 Connection settings and properties.
72 <arg name="path" type="o" direction="out">
73 <annotation name="org.gtk.GDBus.DocString" value="
74 Object path of the new connection that was just added.
79 <method name="LoadConnections">
80 <annotation name="org.gtk.GDBus.DocString" value="
81 Loads or reloads the indicated connections from disk. You
82 should call this after making changes directly to an on-disk
83 connection file to make sure that NetworkManager sees the
84 changes. (If "monitor-connection-files" in NetworkManager.conf
85 is "true", then this will have no real effect, but is
86 harmless.) As with AddConnection(), this operation does not
87 necessarily start the network connection.
89 <arg name="filenames" type="as" direction="in">
90 <annotation name="org.gtk.GDBus.DocString" value="
91 Array of paths to on-disk connection profiles in directories
92 monitored by NetworkManager.
95 <arg name="status" type="b" direction="out">
96 <annotation name="org.gtk.GDBus.DocString" value="
97 Success or failure of the operation as a whole. True if
98 NetworkManager at least tried to load the indicated
99 connections, even if it did not succeed. False if an error
100 occurred before trying to load the connections (eg,
104 <arg name="failures" type="as" direction="out">
105 <annotation name="org.gtk.GDBus.DocString" value="
106 Paths of connection files that could not be loaded.
111 <method name="ReloadConnections">
112 <annotation name="org.gtk.GDBus.DocString" value="
113 Tells NetworkManager to reload all connection files from disk,
114 including noticing any added or deleted connection files. By
115 default, connections are re-read automatically any time they
116 change, so you only need to use this command if you have set
117 "monitor-connection-files=false" in NetworkManager.conf.
119 <arg name="status" type="b" direction="out">
120 <annotation name="org.gtk.GDBus.DocString" value="
126 <method name="SaveHostname">
127 <annotation name="org.gtk.GDBus.DocString" value="
128 Save the hostname to persistent configuration.
130 <arg name="hostname" type="s" direction="in">
131 <annotation name="org.gtk.GDBus.DocString" value="
132 The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.
137 <property name="Connections" type="ao" access="read">
138 <annotation name="org.gtk.GDBus.DocString" value="
139 List of object paths of available network connection profiles.
143 <property name="Hostname" type="s" access="read">
144 <annotation name="org.gtk.GDBus.DocString" value="
145 The machine hostname stored in persistent configuration.
149 <property name="CanModify" type="b" access="read">
150 <annotation name="org.gtk.GDBus.DocString" value="
151 If true, adding and modifying connections is supported.
155 <signal name="PropertiesChanged">
156 <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
157 <annotation name="org.gtk.GDBus.DocString" value="
158 A dictionary mapping property names to variant boxed values
163 <signal name="NewConnection">
164 <annotation name="org.gtk.GDBus.DocString" value="
165 Emitted when a new connection has been added after NetworkManager has
166 started up and initialized. This signal is not emitted for connections
167 read while starting up, because NetworkManager's D-Bus service is only
168 available after all connections have been read, and to prevent spamming
169 listeners with too many signals at one time. To retrieve the initial
170 connection list, call the ListConnections() method once, and then listen
171 for individual Settings.NewConnection and Settings.Connection.Deleted
172 signals for further updates.
174 <arg name="connection" type="o">
175 <annotation name="org.gtk.GDBus.DocString" value="
176 Object path of the new connection.
181 <signal name="ConnectionRemoved">
182 <annotation name="org.gtk.GDBus.DocString" value="
183 Emitted when a connection is no longer available. This happens when
184 the connection is deleted or if it is no longer accessible by any of
185 the system's logged-in users. After receipt of this signal, the
186 connection no longer exists and cannot be used. Also see the
187 Settings.Connection.Removed signal.
189 <arg name="connection" type="o">
190 <annotation name="org.gtk.GDBus.DocString" value="
191 Object path of the removed connection.