org.freedesktop.NetworkManager.Settings.xml 6.43 KB
Newer Older
1 2
<?xml version="1.0" encoding="UTF-8"?>
<node name="/org/freedesktop/NetworkManager/Settings">
3

4 5
  <!--
      org.freedesktop.NetworkManager.Settings:
6
      @short_description: Connection Settings Profile Manager
7 8 9 10

      The Settings interface allows clients to view and administrate the
      connections stored and used by NetworkManager.
  -->
11
  <interface name="org.freedesktop.NetworkManager.Settings">
Dan Williams's avatar
Dan Williams committed
12

13 14 15 16
    <!--
        ListConnections:
        @connections: List of connections.

17
        List the saved network connections known to NetworkManager.
18 19 20
    -->
    <method name="ListConnections">
      <arg name="connections" type="ao" direction="out"/>
Dan Williams's avatar
Dan Williams committed
21
    </method>
22

23 24 25 26 27
    <!--
        GetConnectionByUuid:
        @uuid: The UUID to find the connection object path for.
        @connection: The connection's object path.

28
        Retrieve the object path of a connection, given that connection's UUID.
29 30 31 32
    -->
    <method name="GetConnectionByUuid">
      <arg name="uuid" type="s" direction="in"/>
      <arg name="connection" type="o" direction="out"/>
33 34
    </method>

35 36 37 38 39 40 41 42 43 44
    <!--
        AddConnection:
        @connection: Connection settings and properties.
        @path: Object path of the new connection that was just added.

        Add new connection and save it to disk. This operation does not start the
        network connection unless (1) device is idle and able to connect to the
        network described by the new connection, and (2) the connection is allowed
        to be started automatically.
    -->
45
    <method name="AddConnection">
46 47
      <arg name="connection" type="a{sa{sv}}" direction="in"/>
      <arg name="path" type="o" direction="out"/>
48 49
    </method>

50 51 52 53 54 55 56 57 58
    <!--
        AddConnectionUnsaved:
        @connection: Connection settings and properties.
        @path: Object path of the new connection that was just added.

        Add new connection but do not save it to disk immediately. This operation
        does not start the network connection unless (1) device is idle and able
        to connect to the network described by the new connection, and (2) the
        connection is allowed to be started automatically. Use the 'Save' method
59
        on the connection to save these changes to disk.
60
    -->
61
    <method name="AddConnectionUnsaved">
62 63
      <arg name="connection" type="a{sa{sv}}" direction="in"/>
      <arg name="path" type="o" direction="out"/>
64 65
    </method>

66 67 68 69 70 71 72 73 74 75 76 77 78
    <!--
        LoadConnections:
        @filenames: Array of paths to on-disk connection profiles in directories monitored by NetworkManager.
        @status: Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied).
        @failures: Paths of connection files that could not be loaded.

        Loads or reloads the indicated connections from disk. You should call this
        after making changes directly to an on-disk connection file to make sure
        that NetworkManager sees the changes. (If "monitor-connection-files" in
        NetworkManager.conf is "true", then this will have no real effect, but is
        harmless.) As with AddConnection(), this operation does not necessarily
        start the network connection.
    -->
79
    <method name="LoadConnections">
80 81 82
      <arg name="filenames" type="as" direction="in"/>
      <arg name="status" type="b" direction="out"/>
      <arg name="failures" type="as" direction="out"/>
83 84
    </method>

85 86 87 88 89 90 91 92 93 94
    <!--
        ReloadConnections:
        @status: Success or failure.

        Tells NetworkManager to reload all connection files from disk, including
        noticing any added or deleted connection files. By default, connections
        are re-read automatically any time they change, so you only need to use
        this command if you have set "monitor-connection-files=false" in
        NetworkManager.conf.
    -->
95
    <method name="ReloadConnections">
96
      <arg name="status" type="b" direction="out"/>
97 98
    </method>

99 100 101 102
    <!--
        SaveHostname:
        @hostname: The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.

103
        Save the hostname to persistent configuration.
104 105 106
    -->
    <method name="SaveHostname">
      <arg name="hostname" type="s" direction="in"/>
107 108
    </method>

109 110 111
    <!--
        Connections:

112
        List of object paths of available network connection profiles.
113 114 115 116 117
    -->
    <property name="Connections" type="ao" access="read"/>

    <!--
        Hostname:
118

119
        The machine hostname stored in persistent configuration.
120 121 122 123 124
    -->
    <property name="Hostname" type="s" access="read"/>

    <!--
        CanModify:
125 126

        If true, adding and modifying connections is supported.
127 128
    -->
    <property name="CanModify" type="b" access="read"/>
129

130 131 132
    <!--
        PropertiesChanged:
        @properties: A dictionary mapping property names to variant boxed values
133 134

        DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.
135
    -->
136
    <signal name="PropertiesChanged">
137
        <arg name="properties" type="a{sv}"/>
138 139
    </signal>

140 141 142 143
    <!--
        NewConnection:
        @connection: Object path of the new connection.

144
        Emitted when a new connection has been added after NetworkManager has
145
        started up and initialized. This signal is not emitted for connections
146 147
        read while starting up, because NetworkManager's D-Bus service is only
        available after all connections have been read, and to prevent spamming
148
        listeners with too many signals at one time. To retrieve the initial
149 150 151
        connection list, call the ListConnections() method once, and then listen
        for individual Settings.NewConnection and Settings.Connection.Deleted
        signals for further updates.
152 153 154
    -->
    <signal name="NewConnection">
      <arg name="connection" type="o"/>
Dan Williams's avatar
Dan Williams committed
155
    </signal>
Dan Williams's avatar
Dan Williams committed
156

157 158 159 160 161 162 163 164 165 166
    <!--
        ConnectionRemoved:
        @connection: Object path of the removed connection.

        Emitted when a connection is no longer available. This happens when the
        connection is deleted or if it is no longer accessible by any of the
        system's logged-in users. After receipt of this signal, the connection no
        longer exists and cannot be used. Also see the Settings.Connection.Removed
        signal.
    -->
167
    <signal name="ConnectionRemoved">
168
      <arg name="connection" type="o"/>
169
    </signal>
Dan Williams's avatar
Dan Williams committed
170
  </interface>
171
</node>