introspection/nm-settings.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2
   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     <tp:docstring>
   6       The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager.
   7     </tp:docstring>
   8
   9     <method name="ListConnections">
  10       <tp:docstring>
  11         List the saved network connections known to NetworkManager.
  12       </tp:docstring>
  13       <arg name="connections" type="ao" direction="out">
  14         <tp:docstring>
  15           List of connections.
  16         </tp:docstring>
  17       </arg>
  18     </method>
  19
  20     <method name="GetConnectionByUuid">
  21       <tp:docstring>
  22         Retrieve the object path of a connection, given that connection's UUID.
  23       </tp:docstring>
  24       <arg name="uuid" type="s" direction="in">
  25         <tp:docstring>
  26           The UUID to find the connection object path for.
  27         </tp:docstring>
  28       </arg>
  29       <arg name="connection" type="o" direction="out">
  30         <tp:docstring>
  31           The connection's object path.
  32         </tp:docstring>
  33       </arg>
  34     </method>
  35
  36     <method name="AddConnection">
  37       <tp:docstring>
  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.
  42       </tp:docstring>
  43       <arg name="connection" type="a{sa{sv}}" direction="in">
  44         <tp:docstring>
  45           Connection settings and properties.
  46         </tp:docstring>
  47       </arg>
  48       <arg name="path" type="o" direction="out">
  49         <tp:docstring>
  50           Object path of the new connection that was just added.
  51         </tp:docstring>
  52       </arg>
  53     </method>
  54
  55     <method name="AddConnectionUnsaved">
  56       <tp:docstring>
  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.
  61
  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).
  66       </tp:docstring>
  67       <arg name="connection" type="a{sa{sv}}" direction="in">
  68         <tp:docstring>
  69           Connection settings and properties.
  70         </tp:docstring>
  71       </arg>
  72       <arg name="path" type="o" direction="out">
  73         <tp:docstring>
  74           Object path of the new connection that was just added.
  75         </tp:docstring>
  76       </arg>
  77     </method>
  78
  79     <method name="LoadConnections">
  80       <tp:docstring>
  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.
  88       </tp:docstring>
  89       <arg name="filenames" type="as" direction="in">
  90         <tp:docstring>
  91           Array of paths to on-disk connection profiles in directories
  92           monitored by NetworkManager.
  93         </tp:docstring>
  94       </arg>
  95       <arg name="status" type="b" direction="out">
  96         <tp:docstring>
  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,
 101           permission denied).
 102         </tp:docstring>
 103       </arg>
 104       <arg name="failures" type="as" direction="out">
 105         <tp:docstring>
 106           Paths of connection files that could not be loaded.
 107         </tp:docstring>
 108       </arg>
 109     </method>
 110
 111     <method name="ReloadConnections">
 112       <tp:docstring>
 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.
 118       </tp:docstring>
 119       <arg name="status" type="b" direction="out">
 120         <tp:docstring>
 121           Success or failure.
 122         </tp:docstring>
 123       </arg>
 124     </method>
 125
 126     <method name="SaveHostname">
 127       <tp:docstring>
 128         Save the hostname to persistent configuration.
 129       </tp:docstring>
 130       <arg name="hostname" type="s" direction="in">
 131         <tp:docstring>
 132           The hostname to save to persistent configuration.  If blank, the persistent hostname is cleared.
 133         </tp:docstring>
 134       </arg>
 135     </method>
 136
 137     <property name="Connections" type="ao" access="read">
 138       <tp:docstring>
 139         List of object paths of available network connection profiles.
 140       </tp:docstring>
 141     </property>
 142
 143     <property name="Hostname" type="s" access="read">
 144       <tp:docstring>
 145         The machine hostname stored in persistent configuration.
 146       </tp:docstring>
 147     </property>
 148
 149     <property name="CanModify" type="b" access="read">
 150       <tp:docstring>
 151         If true, adding and modifying connections is supported.
 152       </tp:docstring>
 153     </property>
 154
 155     <signal name="PropertiesChanged">
 156         <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
 157             <tp:docstring>
 158                 A dictionary mapping property names to variant boxed values
 159             </tp:docstring>
 160         </arg>
 161     </signal>
 162
 163     <signal name="NewConnection">
 164       <tp:docstring>
 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.
 173       </tp:docstring>
 174       <arg name="connection" type="o">
 175         <tp:docstring>
 176           Object path of the new connection.
 177         </tp:docstring>
 178       </arg>
 179     </signal>
 180
 181     <signal name="ConnectionRemoved">
 182       <tp:docstring>
 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.
 188       </tp:docstring>
 189       <arg name="connection" type="o">
 190         <tp:docstring>
 191           Object path of the removed connection.
 192         </tp:docstring>
 193       </arg>
 194     </signal>
 195
 196   </interface>
 197 </node>
 198