/usr/share/gtk-doc/html/NetworkManager/spec.html is in network-manager-dev 0.9.10.0-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ascii" /><title>NetworkManager D-Bus Interface Specification version 0.9.10.0</title><style type="text/css">
body {
font-family: sans-serif;
margin: 2em;
height: 100%;
font-size: 1.2em;
}
h1 {
padding-top: 5px;
padding-bottom: 5px;
font-size: 1.6em;
background: #dadae2;
}
h2 {
font-size: 1.3em;
}
h3 {
font-size: 1.2em;
}
a:link, a:visited, a:link:hover, a:visited:hover {
font-weight: bold;
}
.topbox {
padding-top: 10px;
padding-left: 10px;
border-bottom: black solid 1px;
padding-bottom: 10px;
background: #dadae2;
font-size: 2em;
font-weight: bold;
color: #5c5c5c;
}
.topnavbox {
padding-left: 10px;
padding-top: 5px;
padding-bottom: 5px;
background: #abacba;
border-bottom: black solid 1px;
font-size: 1.2em;
}
.topnavbox a{
color: black;
font-weight: normal;
}
.sidebar {
float: left;
/* width:9em;
border-right:#abacba solid 1px;
border-left: #abacba solid 1px;
height:100%; */
border: #abacba solid 1px;
padding-left: 10px;
margin-left: 10px;
padding-right: 10px;
margin-right: 10px;
color: #5d5d5d;
background: #dadae2;
}
.sidebar a {
text-decoration: none;
border-bottom: #e29625 dotted 1px;
color: #e29625;
font-weight: normal;
}
.sidebar h1 {
font-size: 1.2em;
color: black;
}
.sidebar ul {
padding-left: 25px;
padding-bottom: 10px;
border-bottom: #abacba solid 1px;
}
.sidebar li {
padding-top: 2px;
padding-bottom: 2px;
}
.sidebar h2 {
font-style:italic;
font-size: 0.81em;
padding-left: 5px;
padding-right: 5px;
font-weight: normal;
}
.date {
font-size: 0.6em;
float: right;
font-style: italic;
}
.method {
margin-left: 1em;
margin-right: 4em;
}
.signal {
margin-left: 1em;
margin-right: 4em;
}
</style></head><body><h1 class="topbox">NetworkManager D-Bus Interface Specification</h1><h2>Version 0.9.10.0</h2><div>Copyright (C) 2008 - 2011 Red Hat, Inc.</div><div>Copyright (C) 2008 - 2009 Novell, Inc.</div><div class="license">
<p>This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
</div><h2>Interfaces</h2><ul><li><code><a href="#org.freedesktop.NetworkManager">org.freedesktop.NetworkManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AccessPoint">org.freedesktop.NetworkManager.AccessPoint</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device">org.freedesktop.NetworkManager.Device</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wired">org.freedesktop.NetworkManager.Device.Wired</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wireless">org.freedesktop.NetworkManager.Device.Wireless</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Modem">org.freedesktop.NetworkManager.Device.Modem</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bluetooth">org.freedesktop.NetworkManager.Device.Bluetooth</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.OlpcMesh">org.freedesktop.NetworkManager.Device.OlpcMesh</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.WiMax">org.freedesktop.NetworkManager.Device.WiMax</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Infiniband">org.freedesktop.NetworkManager.Device.Infiniband</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bond">org.freedesktop.NetworkManager.Device.Bond</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bridge">org.freedesktop.NetworkManager.Device.Bridge</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Team">org.freedesktop.NetworkManager.Device.Team</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Generic">org.freedesktop.NetworkManager.Device.Generic</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Vlan">org.freedesktop.NetworkManager.Device.Vlan</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Adsl">org.freedesktop.NetworkManager.Device.Adsl</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.WiMax.Nsp">org.freedesktop.NetworkManager.WiMax.Nsp</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP4Config">org.freedesktop.NetworkManager.IP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP6Config">org.freedesktop.NetworkManager.IP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP4Config">org.freedesktop.NetworkManager.DHCP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP6Config">org.freedesktop.NetworkManager.DHCP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings">org.freedesktop.NetworkManager.Settings</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings.Connection">org.freedesktop.NetworkManager.Settings.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Connection.Active">org.freedesktop.NetworkManager.Connection.Active</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AgentManager">org.freedesktop.NetworkManager.AgentManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.SecretAgent">org.freedesktop.NetworkManager.SecretAgent</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Connection">org.freedesktop.NetworkManager.VPN.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Plugin">org.freedesktop.NetworkManager.VPN.Plugin</a></code></li></ul>
<h1><a name="org.freedesktop.NetworkManager" id="org.freedesktop.NetworkManager"></a>org.freedesktop.NetworkManager</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetDevices" id="org.freedesktop.NetworkManager.GetDevices">GetDevices</a> (
) →
ao</h3><div class="docstring">
Get the list of network devices.
</div><div><h4>Returns</h4><dl><dt><code>devices</code> -
<code>ao</code></dt><dd>
List of object paths of network devices known to the system.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetDeviceByIpIface" id="org.freedesktop.NetworkManager.GetDeviceByIpIface">GetDeviceByIpIface</a> (
s: iface
) →
o</h3><div class="docstring">
Return the object path of the network device referenced by its IP
interface name. Note that some devices (usually modems) only have an
IP interface name when they are connected.
</div><div><h4>Parameters</h4><dl><dt><code>iface</code> -
<code>s</code></dt><dd>
Interface name of the device to find.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>device</code> -
<code>o</code></dt><dd>
Object path of the network device.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.ActivateConnection" id="org.freedesktop.NetworkManager.ActivateConnection">ActivateConnection</a> (
o: connection, o: device, o: specific_object
) →
o</h3><div class="docstring">
Activate a connection using the supplied device.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>o</code></dt><dd>
The connection to activate. If "/" is given, a valid device path must
be given, and NetworkManager picks the best connection to activate for
the given device. VPN connections must always pass a valid connection
path.
</dd><dt><code>device</code> -
<code>o</code></dt><dd>
The object path of device to be activated for physical connections.
This parameter is ignored for VPN connections, because the
specific_object (if provided) specifies the device to use.
</dd><dt><code>specific_object</code> -
<code>o</code></dt><dd>
The path of a connection-type-specific object this activation should use.
This parameter is currently ignored for wired and mobile broadband connections,
and the value of "/" should be used (ie, no specific object). For WiFi
connections, pass the object path of a specific AP from the card's scan
list, or "/" to pick an AP automatically. For VPN connections, pass
the object path of an ActiveConnection object that should serve as the
"base" connection (to which the VPN connections lifetime will be tied),
or pass "/" and NM will automatically use the current default device.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>active_connection</code> -
<code>o</code></dt><dd>
The path of the active connection object representing this active connection.
</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.Error.UnknownConnection</code></dt><dd>
Connection was not provided by the settings service.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.UnknownDevice</code></dt><dd>
Unknown device.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionActivating</code></dt><dd>Another connection is already activating or the same connection is already active. FIXME: check if the error name is correct. FIXME: split into 2 errors?</dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionInvalid</code></dt><dd>The connection is invalid for this device.</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.AddAndActivateConnection" id="org.freedesktop.NetworkManager.AddAndActivateConnection">AddAndActivateConnection</a> (
a{sa{sv}}: connection, o: device, o: specific_object
) →
o, o</h3><div class="docstring">
Adds a new connection using the given details (if any) as a template
(automatically filling in missing settings with the capabilities of the
given device and specific object), then activate the new connection.
Cannot be used for VPN connections at this time.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>a{sa{sv}}</code></dt><dd>
Connection settings and properties; if incomplete missing settings will
be automatically completed using the given device and specific object.
</dd><dt><code>device</code> -
<code>o</code></dt><dd>
The object path of device to be activated using the given connection.
</dd><dt><code>specific_object</code> -
<code>o</code></dt><dd>
The path of a connection-type-specific object this activation should use.
This parameter is currently ignored for wired and mobile broadband connections,
and the value of "/" should be used (ie, no specific object). For WiFi
connections, pass the object path of a specific AP from the card's scan
list, which will be used to complete the details of the newly added
connection.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>path</code> -
<code>o</code></dt><dd>
Object path of the new connection that was just added.
</dd><dt><code>active_connection</code> -
<code>o</code></dt><dd>
The path of the active connection object representing this active connection.
</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.Error.UnknownConnection</code></dt><dd>
Connection was not provided by the settings service.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.UnknownDevice</code></dt><dd>
Unknown device.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.Error.ConnectionInvalid</code></dt><dd>The connection is invalid for this device.</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.DeactivateConnection" id="org.freedesktop.NetworkManager.DeactivateConnection">DeactivateConnection</a> (
o: active_connection
) →
nothing</h3><div class="docstring">
Deactivate an active connection.
</div><div><h4>Parameters</h4><dl><dt><code>active_connection</code> -
<code>o</code></dt><dd>
The currently active connection to deactivate.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Sleep" id="org.freedesktop.NetworkManager.Sleep">Sleep</a> (
b: sleep
) →
nothing</h3><div class="docstring">
Control the NetworkManager daemon's sleep state. When asleep, all
interfaces that it manages are deactivated. When awake, devices are
available to be activated. This command should not be called directly
by users or clients; it is intended for system suspend/resume tracking.
</div><div><h4>Parameters</h4><dl><dt><code>sleep</code> -
<code>b</code></dt><dd>
Indicates whether the NetworkManager daemon should sleep or wake.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Enable" id="org.freedesktop.NetworkManager.Enable">Enable</a> (
b: enable
) →
nothing</h3><div class="docstring">
Control whether overall networking is enabled or disabled. When
disabled, all interfaces that NM manages are deactivated. When enabled,
all managed interfaces are re-enabled and available to be activated.
This command should be used by clients that provide to users the ability
to enable/disable all networking.
</div><div><h4>Parameters</h4><dl><dt><code>enable</code> -
<code>b</code></dt><dd>
If FALSE, indicates that all networking should be disabled. If TRUE,
indicates that NetworkManager should begin managing network devices.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetPermissions" id="org.freedesktop.NetworkManager.GetPermissions">GetPermissions</a> (
) →
a{ss}</h3><div class="docstring">
Returns the permissions a caller has for various authenticated operations
that NetworkManager provides, like Enable/Disable networking, changing
WiFi, WWAN, and WiMAX state, etc.
</div><div><h4>Returns</h4><dl><dt><code>permissions</code> -
<code>a{ss}</code></dt><dd>
Dictionary of available permissions and results. Each permission
is represented by a name (ie "org.freedesktop.NetworkManager.Foobar")
and each result is one of the following values: "yes" (the permission
is available), "auth" (the permission is available after a successful
authentication), or "no" (the permission is denied). Clients may use
these values in the UI to indicate the ability to perform certain
operations.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.SetLogging" id="org.freedesktop.NetworkManager.SetLogging">SetLogging</a> (
s: level, s: domains
) →
nothing</h3><div class="docstring">
Set logging verbosity and which operations are logged.
</div><div><h4>Parameters</h4><dl><dt><code>level</code> -
<code>s</code></dt><dd>
One of [ERR, WARN, INFO, DEBUG].
</dd><dt><code>domains</code> -
<code>s</code></dt><dd>
A combination of logging domains separated by commas (','), or "NONE"
to disable logging. Each domain enables logging for operations
related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER,
WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS,
VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE,
OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS,
TEAM, CONCHECK, DCB, DISPATCH].
In addition to these domains, the following special domains can be used:
[NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains
should log at a different level from the default by appending a colon (':')
and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the
log level is changed but the current set of log domains remains
unchanged.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.GetLogging" id="org.freedesktop.NetworkManager.GetLogging">GetLogging</a> (
) →
s, s</h3><div class="docstring">
Get current logging verbosity level and operations domains.
</div><div><h4>Returns</h4><dl><dt><code>level</code> -
<code>s</code></dt><dd>
One of [ERR, WARN, INFO, DEBUG].
</dd><dt><code>domains</code> -
<code>s</code></dt><dd>
For available domains see SetLogging() call.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.CheckConnectivity" id="org.freedesktop.NetworkManager.CheckConnectivity">CheckConnectivity</a> (
) →
u</h3><div class="docstring">
Re-check the network connectivity state.
</div><div><h4>Returns</h4><dl><dt><code>connectivity</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_CONNECTIVITY">NM_CONNECTIVITY</a>)
</dt><dd>
The current connectivity state.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.state" id="org.freedesktop.NetworkManager.state">state</a> (
) →
u</h3><div class="docstring">
The overall networking state as determined by the NetworkManager daemon,
based on the state of network devices under it's management.
</div><div><h4>Returns</h4><dl><dt><code>state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_STATE">NM_STATE</a>)
</dt><dd></dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.CheckPermissions" id="org.freedesktop.NetworkManager.CheckPermissions">CheckPermissions</a> (
)</h3><div class="docstring">
Emitted when system authorization details change, indicating that
clients may wish to recheck permissions with GetPermissions.
</div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.StateChanged" id="org.freedesktop.NetworkManager.StateChanged">StateChanged</a> (
u: state
)</h3><div class="docstring">
NetworkManager's state changed.
</div><div><h4>Parameters</h4><dl><dt><code>state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_STATE">NM_STATE</a>)
</dt><dd>
The new state of NetworkManager.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.PropertiesChanged" id="org.freedesktop.NetworkManager.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring">
NetworkManager's properties changed.
</div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
The changed properties.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DeviceAdded" id="org.freedesktop.NetworkManager.DeviceAdded">DeviceAdded</a> (
o: device_path
)</h3><div class="docstring">
A device was added to the system
</div><div><h4>Parameters</h4><dl><dt><code>device_path</code> -
<code>o</code></dt><dd>
The object path of the newly added device.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DeviceRemoved" id="org.freedesktop.NetworkManager.DeviceRemoved">DeviceRemoved</a> (
o: device_path
)</h3><div class="docstring">
A device was removed from the system, and is no longer available.
</div><div><h4>Parameters</h4><dl><dt><code>device_path</code> -
<code>o</code></dt><dd>
The object path of the device that was just removed.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Devices</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>
The list of network devices/interfaces NetworkManager knows about.
</dd><dt><code>NetworkingEnabled</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates if overall networking is currently enabled or not. See the
Enable() method.
</dd><dt><code>WirelessEnabled</code> -
<code>b</code> -
<code>(readwrite)</code></dt><dd>
Indicates if wireless is currently enabled or not.
</dd><dt><code>WirelessHardwareEnabled</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch.
</dd><dt><code>WwanEnabled</code> -
<code>b</code> -
<code>(readwrite)</code></dt><dd>
Indicates if mobile broadband devices are currently enabled or not.
</dd><dt><code>WwanHardwareEnabled</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates if the mobile broadband hardware is currently enabled, i.e. the state of the RF kill switch.
</dd><dt><code>WimaxEnabled</code> -
<code>b</code> -
<code>(readwrite)</code></dt><dd>
Indicates if WiMAX devices are currently enabled or not.
</dd><dt><code>WimaxHardwareEnabled</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates if the WiMAX hardware is currently enabled, i.e. the state of the RF kill switch.
</dd><dt><code>ActiveConnections</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>
List of active connection object paths.
</dd><dt><code>PrimaryConnection</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
The object path of the "primary" active connection being used
to access the network. In particular, if there is no VPN
active, or the VPN does not have the default route, then this
indicates the connection that has the default route. If there
is a VPN active with the default route, then this indicates
the connection that contains the route to the VPN endpoint.
</dd><dt><code>ActivatingConnection</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
The object path of an active connection that is currently
being activated and which is expected to become the new
PrimaryConnection when it finishes activating.
</dd><dt><code>Startup</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates whether NM is still starting up; this becomes FALSE
when NM has finished attempting to activate every connection
that it might be able to activate at startup.
</dd><dt><code>Version</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
NetworkManager version.
</dd><dt><code>State</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_STATE">NM_STATE</a>)
</dt><dd>
The overall state of the NetworkManager daemon.
</dd><dt><code>Connectivity</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_CONNECTIVITY">NM_CONNECTIVITY</a>)
</dt><dd>
The network connectivity state.
</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_STATE" id="type-NM_STATE">NM_STATE</a></h3>
Describes the overall state of the daemon.
<dl><dt><code>NM_STATE_UNKNOWN = 0</code></dt><dd>
Networking state is unknown.
</dd><dt><code>NM_STATE_ASLEEP = 10</code></dt><dd>
Networking is inactive and all devices are disabled.
</dd><dt><code>NM_STATE_DISCONNECTED = 20</code></dt><dd>
There is no active network connection.
</dd><dt><code>NM_STATE_DISCONNECTING = 30</code></dt><dd>
Network connections are being cleaned up.
</dd><dt><code>NM_STATE_CONNECTING = 40</code></dt><dd>
A network device is connecting to a network and there is no other
available network connection.
</dd><dt><code>NM_STATE_CONNECTED_LOCAL = 50</code></dt><dd>
A network device is connected, but there is only link-local connectivity.
</dd><dt><code>NM_STATE_CONNECTED_SITE = 60</code></dt><dd>
A network device is connected, but there is only site-local connectivity.
</dd><dt><code>NM_STATE_CONNECTED_GLOBAL = 70</code></dt><dd>
A network device is connected, with global network connectivity.
</dd></dl><h3><a name="type-NM_CONNECTIVITY" id="type-NM_CONNECTIVITY">NM_CONNECTIVITY</a></h3>
Describes the network-connectivity state.
<dl><dt><code>NM_CONNECTIVITY_UNKNOWN = 0</code></dt><dd>
Network connectivity is unknown.
</dd><dt><code>NM_CONNECTIVITY_NONE = 1</code></dt><dd>
The host is not connected to any network.
</dd><dt><code>NM_CONNECTIVITY_PORTAL = 2</code></dt><dd>
The host is behind a captive portal and cannot reach the
full Internet.
</dd><dt><code>NM_CONNECTIVITY_LIMITED = 3</code></dt><dd>
The host is connected to a network, but does not appear to
be able to reach the full Internet.
</dd><dt><code>NM_CONNECTIVITY_FULL = 4</code></dt><dd>
The host is connected to a network, and appears to be able
to reach the full Internet
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.AccessPoint" id="org.freedesktop.NetworkManager.AccessPoint"></a>org.freedesktop.NetworkManager.AccessPoint</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.AccessPoint.PropertiesChanged" id="org.freedesktop.NetworkManager.AccessPoint.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Flags</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_AP_FLAGS">NM_802_11_AP_FLAGS</a>)
</dt><dd>Flags describing the capabilities of the access point.</dd><dt><code>WpaFlags</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a>)
</dt><dd>Flags describing the access point's capabilities according to WPA (Wifi Protected Access).</dd><dt><code>RsnFlags</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a>)
</dt><dd>Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol.</dd><dt><code>Ssid</code> -
<code>ay</code> -
<code>(read)</code></dt><dd>The Service Set Identifier identifying the access point.</dd><dt><code>Frequency</code> -
<code>u</code> -
<code>(read)</code></dt><dd>The radio channel frequency in use by the access point, in MHz.</dd><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>The hardware address (BSSID) of the access point.</dd><dt><code>Mode</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_MODE">NM_802_11_MODE</a>)
</dt><dd>Describes the operating mode of the access point.</dd><dt><code>MaxBitrate</code> -
<code>u</code> -
<code>(read)</code></dt><dd>The maximum bitrate this access point is capable of, in kilobits/second (Kb/s).</dd><dt><code>Strength</code> -
<code>y</code> -
<code>(read)</code></dt><dd>The current signal quality of the access point, in percent.</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_802_11_AP_FLAGS" id="type-NM_802_11_AP_FLAGS">NM_802_11_AP_FLAGS</a></h3>
Flags describing the general capabilities of the access point.
<dl><dt><code>NM_802_11_AP_FLAGS_NONE = 0x0</code></dt><dd>Null capability - says nothing about the access point.</dd><dt><code>NM_802_11_AP_FLAGS_PRIVACY = 0x1</code></dt><dd>Access point supports privacy measures.</dd></dl><h3 xmlns=""><a name="type-NM_802_11_AP_SEC" id="type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a></h3>
Flags describing the security capabilities of the access point.
<dl><dt><code>NM_802_11_AP_SEC_NONE = 0x0</code></dt><dd>Null flag.</dd><dt><code>NM_802_11_AP_SEC_PAIR_WEP40 = 0x1</code></dt><dd>Access point supports pairwise 40-bit WEP encryption.</dd><dt><code>NM_802_11_AP_SEC_PAIR_WEP104 = 0x2</code></dt><dd>Access point supports pairwise 104-bit WEP encryption.</dd><dt><code>NM_802_11_AP_SEC_PAIR_TKIP = 0x4</code></dt><dd>Access point supports pairwise TKIP encryption.</dd><dt><code>NM_802_11_AP_SEC_PAIR_CCMP = 0x8</code></dt><dd>Access point supports pairwise CCMP encryption.</dd><dt><code>NM_802_11_AP_SEC_GROUP_WEP40 = 0x10</code></dt><dd>Access point supports a group 40-bit WEP cipher.</dd><dt><code>NM_802_11_AP_SEC_GROUP_WEP104 = 0x20</code></dt><dd>Access point supports a group 104-bit WEP cipher.</dd><dt><code>NM_802_11_AP_SEC_GROUP_TKIP = 0x40</code></dt><dd>Access point supports a group TKIP cipher.</dd><dt><code>NM_802_11_AP_SEC_GROUP_CCMP = 0x80</code></dt><dd>Access point supports a group CCMP cipher.</dd><dt><code>NM_802_11_AP_SEC_KEY_MGMT_PSK = 0x100</code></dt><dd>Access point supports PSK key management.</dd><dt><code>NM_802_11_AP_SEC_KEY_MGMT_802_1X = 0x200</code></dt><dd>Access point supports 802.1x key management.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device" id="org.freedesktop.NetworkManager.Device"></a>org.freedesktop.NetworkManager.Device</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Disconnect" id="org.freedesktop.NetworkManager.Device.Disconnect">Disconnect</a> (
) →
nothing</h3><div class="docstring">
Disconnects a device and prevents the device from automatically activating further connections without user intervention.
</div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.StateChanged" id="org.freedesktop.NetworkManager.Device.StateChanged">StateChanged</a> (
u: new_state, u: old_state, u: reason
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>new_state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a>)
</dt><dd>
The new state of the device.
</dd><dt><code>old_state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a>)
</dt><dd>
The previous state of the device.
</dd><dt><code>reason</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_DEVICE_STATE_REASON">NM_DEVICE_STATE_REASON</a>)
</dt><dd>
A reason for the state transition.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Udi</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Operating-system specific transient device hardware identifier. This
is an opaque string representing the underlying hardware for the device,
and shouldn't be used to keep track of individual devices. For some
device types (Bluetooth, Modems) it is an identifier used by the
hardware service (ie bluez or ModemManager) to refer to that device,
and client programs use it get additional information from those
services which NM does not provide. The Udi is not guaranteed to be
consistent across reboots or hotplugs of the hardware. If you're looking
for a way to uniquely track each device in your application, use the
object path. If you're looking for a way to track a specific piece of
hardware across reboot or hotplug, use a MAC address or USB serial
number.
</dd><dt><code>Interface</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The name of the device's control (and often data) interface.
</dd><dt><code>IpInterface</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The name of the device's data interface when available. This property
may not refer to the actual data interface until the device has
successfully established a data connection, indicated by the device's
State becoming ACTIVATED.
</dd><dt><code>Driver</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The driver handling the device.
</dd><dt><code>DriverVersion</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The version of the driver handling the device.
</dd><dt><code>FirmwareVersion</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The firmware version for the device.
</dd><dt><code>Capabilities</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_DEVICE_CAP">NM_DEVICE_CAP</a>)
</dt><dd>
Flags describing the capabilities of the device.
</dd><dt><code>Ip4Address</code> -
<code>u</code> -
<code>(read)</code></dt><dd>
DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object instead.
</dd><dt><code>State</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a>)
</dt><dd>
The current state of the device.
</dd><dt><code>StateReason</code> -
<code>(uu)</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_DEVICE_STATE_REASON_STRUCT">NM_DEVICE_STATE_REASON_STRUCT</a>)
</dt><dd>
The current state and reason for changing to that state.
</dd><dt><code>ActiveConnection</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of an ActiveConnection object that "owns" this device during
activation. The ActiveConnection object tracks the life-cycle of a
connection to a specific network and implements the
org.freedesktop.NetworkManager.Connection.Active D-Bus interface.
</dd><dt><code>Ip4Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Ip4Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
</dd><dt><code>Dhcp4Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
</dd><dt><code>Ip6Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Ip6Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
</dd><dt><code>Dhcp6Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Dhcp6Config object describing the DHCP options
returned by the DHCP server. Only valid when the device is in the
NM_DEVICE_STATE_ACTIVATED state.
</dd><dt><code>Managed</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Whether or not this device is managed by NetworkManager.
</dd><dt><code>Autoconnect</code> -
<code>b</code> -
<code>(readwrite)</code></dt><dd>
If TRUE, indicates the device is allowed to autoconnect. If FALSE,
manual intervention is required before the device will automatically
connect to a known network, such as activating a connection using the
device, or setting this property to TRUE.
</dd><dt><code>FirmwareMissing</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
If TRUE, indicates the device is likely missing firmware necessary for
its operation.
</dd><dt><code>DeviceType</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_DEVICE_TYPE">NM_DEVICE_TYPE</a>)
</dt><dd>
The general type of the network device; ie Ethernet, WiFi, etc.
</dd><dt><code>AvailableConnections</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>
An array of object paths of every configured connection that is currently 'available' through this device.
</dd><dt><code>PhysicalPortId</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
If non-empty, an (opaque) indicator of the physical network
port associated with the device. This can be used to recognize
when two seemingly-separate hardware devices are actually just
different virtual interfaces to the same physical port.
</dd><dt><code>Mtu</code> -
<code>u</code> -
<code>(read)</code></dt><dd>
The device MTU (maximum transmission unit).
</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_DEVICE_STATE" id="type-NM_DEVICE_STATE">NM_DEVICE_STATE</a></h3><dl><dt><code>NM_DEVICE_STATE_UNKNOWN = 0</code></dt><dd>
The device is in an unknown state.
</dd><dt><code>NM_DEVICE_STATE_UNMANAGED = 10</code></dt><dd>
The device is recognized but not managed by NetworkManager.
</dd><dt><code>NM_DEVICE_STATE_UNAVAILABLE = 20</code></dt><dd>
The device cannot be used (carrier off, rfkill, etc).
</dd><dt><code>NM_DEVICE_STATE_DISCONNECTED = 30</code></dt><dd>
The device is not connected.
</dd><dt><code>NM_DEVICE_STATE_PREPARE = 40</code></dt><dd>
The device is preparing to connect.
</dd><dt><code>NM_DEVICE_STATE_CONFIG = 50</code></dt><dd>
The device is being configured.
</dd><dt><code>NM_DEVICE_STATE_NEED_AUTH = 60</code></dt><dd>
The device is awaiting secrets necessary to continue connection.
</dd><dt><code>NM_DEVICE_STATE_IP_CONFIG = 70</code></dt><dd>
The IP settings of the device are being requested and configured.
</dd><dt><code>NM_DEVICE_STATE_IP_CHECK = 80</code></dt><dd>
The device's IP connectivity ability is being determined.
</dd><dt><code>NM_DEVICE_STATE_SECONDARIES = 90</code></dt><dd>
The device is waiting for secondary connections to be activated.
</dd><dt><code>NM_DEVICE_STATE_ACTIVATED = 100</code></dt><dd>
The device is active.
</dd><dt><code>NM_DEVICE_STATE_DEACTIVATING = 110</code></dt><dd>
The device's network connection is being torn down.
</dd><dt><code>NM_DEVICE_STATE_FAILED = 120</code></dt><dd>
The device is in a failure state following an attempt to activate it.
</dd></dl><h3><a name="type-NM_DEVICE_TYPE" id="type-NM_DEVICE_TYPE">NM_DEVICE_TYPE</a></h3><dl><dt><code>NM_DEVICE_TYPE_UNKNOWN = 0</code></dt><dd>
The device type is unknown.
</dd><dt><code>NM_DEVICE_TYPE_ETHERNET = 1</code></dt><dd>
The device is wired Ethernet device.
</dd><dt><code>NM_DEVICE_TYPE_WIFI = 2</code></dt><dd>
The device is an 802.11 WiFi device.
</dd><dt><code>NM_DEVICE_TYPE_UNUSED1 = 3</code></dt><dd>Unused</dd><dt><code>NM_DEVICE_TYPE_UNUSED2 = 4</code></dt><dd>Unused</dd><dt><code>NM_DEVICE_TYPE_BT = 5</code></dt><dd>
The device is Bluetooth device that provides PAN or DUN capabilities.
</dd><dt><code>NM_DEVICE_TYPE_OLPC_MESH = 6</code></dt><dd>
The device is an OLPC mesh networking device.
</dd><dt><code>NM_DEVICE_TYPE_WIMAX = 7</code></dt><dd>
The device is an 802.16e Mobile WiMAX device.
</dd><dt><code>NM_DEVICE_TYPE_MODEM = 8</code></dt><dd>
The device is a modem supporting one or more of analog telephone,
CDMA/EVDO, GSM/UMTS/HSPA, or LTE standards to access a cellular or
wireline data network.
</dd><dt><code>NM_DEVICE_TYPE_INFINIBAND = 9</code></dt><dd>
The device is an IP-capable InfiniBand interface.
</dd><dt><code>NM_DEVICE_TYPE_BOND = 10</code></dt><dd>
The device is a bond master interface.
</dd><dt><code>NM_DEVICE_TYPE_VLAN = 11</code></dt><dd>
The device is a VLAN interface.
</dd><dt><code>NM_DEVICE_TYPE_ADSL = 12</code></dt><dd>
The device is an ADSL device supporting PPPoE and PPPoATM protocols.
</dd><dt><code>NM_DEVICE_TYPE_BRIDGE = 13</code></dt><dd>
The device is a bridge interface.
</dd><dt><code>NM_DEVICE_TYPE_GENERIC = 14</code></dt><dd>
The device is a generic interface type unrecognized by NetworkManager.
</dd><dt><code>NM_DEVICE_TYPE_TEAM = 15</code></dt><dd>
The device is a team master interface.
</dd></dl><h3><a name="type-NM_DEVICE_STATE_REASON" id="type-NM_DEVICE_STATE_REASON">NM_DEVICE_STATE_REASON</a></h3><dl><dt><code>NM_DEVICE_STATE_REASON_UNKNOWN = 0</code></dt><dd>
The reason for the device state change is unknown.
</dd><dt><code>NM_DEVICE_STATE_REASON_NONE = 1</code></dt><dd>
The state change is normal.
</dd><dt><code>NM_DEVICE_STATE_REASON_NOW_MANAGED = 2</code></dt><dd>
The device is now managed.
</dd><dt><code>NM_DEVICE_STATE_REASON_NOW_UNMANAGED = 3</code></dt><dd>
The device is no longer managed.
</dd><dt><code>NM_DEVICE_STATE_REASON_CONFIG_FAILED = 4</code></dt><dd>
The device could not be readied for configuration.
</dd><dt><code>NM_DEVICE_STATE_REASON_CONFIG_UNAVAILABLE = 5</code></dt><dd>
IP configuration could not be reserved (no available address, timeout, etc).
</dd><dt><code>NM_DEVICE_STATE_REASON_CONFIG_EXPIRED = 6</code></dt><dd>
The IP configuration is no longer valid.
</dd><dt><code>NM_DEVICE_STATE_REASON_NO_SECRETS = 7</code></dt><dd>
Secrets were required, but not provided.
</dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_DISCONNECT = 8</code></dt><dd>
The 802.1X supplicant disconnected from the access point or authentication server.
</dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_CONFIG_FAILED = 9</code></dt><dd>
Configuration of the 802.1X supplicant failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_FAILED = 10</code></dt><dd>
The 802.1X supplicant quit or failed unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_TIMEOUT = 11</code></dt><dd>
The 802.1X supplicant took too long to authenticate.
</dd><dt><code>NM_DEVICE_STATE_REASON_PPP_START_FAILED = 12</code></dt><dd>
The PPP service failed to start within the allowed time.
</dd><dt><code>NM_DEVICE_STATE_REASON_PPP_DISCONNECT = 13</code></dt><dd>
The PPP service disconnected unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_PPP_FAILED = 14</code></dt><dd>
The PPP service quit or failed unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_DHCP_START_FAILED = 15</code></dt><dd>
The DHCP service failed to start within the allowed time.
</dd><dt><code>NM_DEVICE_STATE_REASON_DHCP_ERROR = 16</code></dt><dd>
The DHCP service reported an unexpected error.
</dd><dt><code>NM_DEVICE_STATE_REASON_DHCP_FAILED = 17</code></dt><dd>
The DHCP service quit or failed unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_SHARED_START_FAILED = 18</code></dt><dd>
The shared connection service failed to start.
</dd><dt><code>NM_DEVICE_STATE_REASON_SHARED_FAILED = 19</code></dt><dd>
The shared connection service quit or failed unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_AUTOIP_START_FAILED = 20</code></dt><dd>
The AutoIP service failed to start.
</dd><dt><code>NM_DEVICE_STATE_REASON_AUTOIP_ERROR = 21</code></dt><dd>
The AutoIP service reported an unexpected error.
</dd><dt><code>NM_DEVICE_STATE_REASON_AUTOIP_FAILED = 22</code></dt><dd>
The AutoIP service quit or failed unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_BUSY = 23</code></dt><dd>
Dialing failed because the line was busy.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_NO_DIAL_TONE = 24</code></dt><dd>
Dialing failed because there was no dial tone.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_NO_CARRIER = 25</code></dt><dd>
Dialing failed because there was carrier.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_DIAL_TIMEOUT = 26</code></dt><dd>
Dialing timed out.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_DIAL_FAILED = 27</code></dt><dd>
Dialing failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_INIT_FAILED = 28</code></dt><dd>
Modem initialization failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_APN_FAILED = 29</code></dt><dd>
Failed to select the specified GSM APN.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_NOT_SEARCHING = 30</code></dt><dd>
Not searching for networks.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_DENIED = 31</code></dt><dd>
Network registration was denied.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_TIMEOUT = 32</code></dt><dd>
Network registration timed out.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_REGISTRATION_FAILED = 33</code></dt><dd>
Failed to register with the requested GSM network.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_PIN_CHECK_FAILED = 34</code></dt><dd>
PIN check failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_FIRMWARE_MISSING = 35</code></dt><dd>
Necessary firmware for the device may be missing.
</dd><dt><code>NM_DEVICE_STATE_REASON_REMOVED = 36</code></dt><dd>
The device was removed.
</dd><dt><code>NM_DEVICE_STATE_REASON_SLEEPING = 37</code></dt><dd>
NetworkManager went to sleep.
</dd><dt><code>NM_DEVICE_STATE_REASON_CONNECTION_REMOVED = 38</code></dt><dd>
The device's active connection was removed or disappeared.
</dd><dt><code>NM_DEVICE_STATE_REASON_USER_REQUESTED = 39</code></dt><dd>
A user or client requested the disconnection.
</dd><dt><code>NM_DEVICE_STATE_REASON_CARRIER = 40</code></dt><dd>
The device's carrier/link changed.
</dd><dt><code>NM_DEVICE_STATE_REASON_CONNECTION_ASSUMED = 41</code></dt><dd>
The device's existing connection was assumed.
</dd><dt><code>NM_DEVICE_STATE_REASON_SUPPLICANT_AVAILABLE = 42</code></dt><dd>
The 802.1x supplicant is now available.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_NOT_FOUND = 43</code></dt><dd>
The modem could not be found.
</dd><dt><code>NM_DEVICE_STATE_REASON_BT_FAILED = 44</code></dt><dd>
The Bluetooth connection timed out or failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_SIM_NOT_INSERTED = 45</code></dt><dd>
GSM Modem's SIM Card not inserted.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_SIM_PIN_REQUIRED = 46</code></dt><dd>
GSM Modem's SIM Pin required.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_SIM_PUK_REQUIRED = 47</code></dt><dd>
GSM Modem's SIM Puk required.
</dd><dt><code>NM_DEVICE_STATE_REASON_GSM_SIM_WRONG = 48</code></dt><dd>
GSM Modem's SIM wrong
</dd><dt><code>NM_DEVICE_STATE_REASON_INFINIBAND_MODE = 49</code></dt><dd>
InfiniBand device does not support connected mode.
</dd><dt><code>NM_DEVICE_STATE_REASON_DEPENDENCY_FAILED = 50</code></dt><dd>
A dependency of the connection failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_BR2684_FAILED = 51</code></dt><dd>
Problem with the RFC 2684 Ethernet over ADSL bridge.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_MANAGER_UNAVAILABLE = 52</code></dt><dd>
ModemManager was not running or quit unexpectedly.
</dd><dt><code>NM_DEVICE_STATE_REASON_SSID_NOT_FOUND = 53</code></dt><dd>
The 802.11 Wi-Fi network could not be found.
</dd><dt><code>NM_DEVICE_STATE_REASON_SECONDARY_CONNECTION_FAILED = 54</code></dt><dd>
A secondary connection of the base connection failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_DCB_FCOE_FAILED = 55</code></dt><dd>
DCB or FCoE setup failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_TEAMD_CONTROL_FAILED = 56</code></dt><dd>
teamd control failed.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_FAILED = 57</code></dt><dd>
Modem failed or no longer available.
</dd><dt><code>NM_DEVICE_STATE_REASON_MODEM_AVAILABLE = 58</code></dt><dd>
Modem now ready and available.
</dd><dt><code>NM_DEVICE_STATE_REASON_SIM_PIN_INCORRECT = 59</code></dt><dd>
The SIM PIN was incorrect.
</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_DEVICE_CAP" id="type-NM_DEVICE_CAP">NM_DEVICE_CAP</a></h3><dl><dt><code>NM_DEVICE_CAP_NONE = 0x0</code></dt><dd>Null capability.</dd><dt><code>NM_DEVICE_CAP_NM_SUPPORTED = 0x1</code></dt><dd>The device is supported by NetworkManager.</dd><dt><code>NM_DEVICE_CAP_CARRIER_DETECT = 0x2</code></dt><dd>The device supports carrier detection.</dd></dl><h2>Structure types:</h2><div class="struct"><h3><a name="type-NM_DEVICE_STATE_REASON_STRUCT" id="type-NM_DEVICE_STATE_REASON_STRUCT">NM_DEVICE_STATE_REASON_STRUCT</a> - (
u: state, u: reason
)
</h3><div class="docstring"></div><p>Arrays of NM_DEVICE_STATE_REASON_STRUCT don't generally
make sense.</p><div><h4>Members</h4><dl><dt><code>state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a>)
</dt><dd>
The device state.
</dd><dt><code>reason</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_DEVICE_STATE_REASON">NM_DEVICE_STATE_REASON</a>)
</dt><dd>
The reason for originally changing to the device state.
</dd></dl></div></div>
<h1><a name="org.freedesktop.NetworkManager.Device.Wired" id="org.freedesktop.NetworkManager.Device.Wired"></a>org.freedesktop.NetworkManager.Device.Wired</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wired.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Wired.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Active hardware address of the device.
</dd><dt><code>PermHwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Permanent hardware address of the device.
</dd><dt><code>Speed</code> -
<code>u</code> -
<code>(read)</code></dt><dd>
Design speed of the device, in megabits/second (Mb/s).
</dd><dt><code>Carrier</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Wireless" id="org.freedesktop.NetworkManager.Device.Wireless"></a>org.freedesktop.NetworkManager.Device.Wireless</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.GetAccessPoints" id="org.freedesktop.NetworkManager.Device.Wireless.GetAccessPoints">GetAccessPoints</a> (
) →
ao</h3><div class="docstring">
DEPRECATED. Get the list of access points visible to this device. Note
that this list does not include access points which hide their SSID. To
retrieve a list of all access points (including hidden ones) use the
GetAllAccessPoints() method.
</div><div><h4>Returns</h4><dl><dt><code>access_points</code> -
<code>ao</code></dt><dd>
List of access point object paths.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.GetAllAccessPoints" id="org.freedesktop.NetworkManager.Device.Wireless.GetAllAccessPoints">GetAllAccessPoints</a> (
) →
ao</h3><div class="docstring">
Get the list of all access points visible to this device, including
hidden ones for which the SSID is not yet known.
</div><div><h4>Returns</h4><dl><dt><code>access_points</code> -
<code>ao</code></dt><dd>
List of access point object paths.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.RequestScan" id="org.freedesktop.NetworkManager.Device.Wireless.RequestScan">RequestScan</a> (
a{sv}: options
) →
nothing</h3><div class="docstring">
Request the device to scan
</div><div><h4>Parameters</h4><dl><dt><code>options</code> -
<code>a{sv}</code></dt><dd>
Options of scan
</dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Wireless.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring">
Emitted when the wireless device's properties changed.
</div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary containing the FIXME: check changed parameters.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.AccessPointAdded" id="org.freedesktop.NetworkManager.Device.Wireless.AccessPointAdded">AccessPointAdded</a> (
o: access_point
)</h3><div class="docstring">
Emitted when a new access point is found by the device.
</div><div><h4>Parameters</h4><dl><dt><code>access_point</code> -
<code>o</code></dt><dd>
The object path of the newly found access point.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Wireless.AccessPointRemoved" id="org.freedesktop.NetworkManager.Device.Wireless.AccessPointRemoved">AccessPointRemoved</a> (
o: access_point
)</h3><div class="docstring">
Emitted when an access point disappears from view of the device.
</div><div><h4>Parameters</h4><dl><dt><code>access_point</code> -
<code>o</code></dt><dd>
The object path of the access point that has disappeared.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The active hardware address of the device.
</dd><dt><code>PermHwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The permanent hardware address of the device.
</dd><dt><code>Mode</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_MODE">NM_802_11_MODE</a>)
</dt><dd>
The operating mode of the wireless device.
</dd><dt><code>Bitrate</code> -
<code>u</code> -
<code>(read)</code></dt><dd>
The bit rate currently used by the wireless device, in kilobits/second (Kb/s).
</dd><dt><code>AccessPoints</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>
List of object paths of access point visible to this wireless device.
</dd><dt><code>ActiveAccessPoint</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the access point currently used by the wireless device.
</dd><dt><code>WirelessCapabilities</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_802_11_DEVICE_CAP">NM_802_11_DEVICE_CAP</a>)
</dt><dd>
The capabilities of the wireless device.
</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_802_11_DEVICE_CAP" id="type-NM_802_11_DEVICE_CAP">NM_802_11_DEVICE_CAP</a></h3>
Flags describing the capabilities of a wireless device.
<dl><dt><code>NM_802_11_DEVICE_CAP_NONE = 0x0</code></dt><dd>Null capability - syntactic sugar for no capabilities supported. Do not AND this with other capabilities!</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_WEP40 = 0x1</code></dt><dd>The device supports the 40-bit WEP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_WEP104 = 0x2</code></dt><dd>The device supports the 104-bit WEP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_TKIP = 0x4</code></dt><dd>The device supports the TKIP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_CIPHER_CCMP = 0x8</code></dt><dd>The device supports the CCMP cipher.</dd><dt><code>NM_802_11_DEVICE_CAP_WPA = 0x10</code></dt><dd>The device supports the WPA encryption/authentication protocol.</dd><dt><code>NM_802_11_DEVICE_CAP_RSN = 0x20</code></dt><dd>The device supports the RSN encryption/authentication protocol.</dd><dt><code>NM_802_11_DEVICE_CAP_AP = 0x40</code></dt><dd>The device supports Access Point mode.</dd><dt><code>NM_802_11_DEVICE_CAP_ADHOC = 0x80</code></dt><dd>The device supports Ad-Hoc mode.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Modem" id="org.freedesktop.NetworkManager.Device.Modem"></a>org.freedesktop.NetworkManager.Device.Modem</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Modem.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Modem.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>ModemCapabilities</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_DEVICE_MODEM_CAPABILITIES">NM_DEVICE_MODEM_CAPABILITIES</a>)
</dt><dd>
The generic family of access technologies the modem supports. Not all
capabilities are available at the same time however; some modems require
a firmware reload or other reinitialization to switch between eg CDMA/EVDO
and GSM/UMTS.
</dd><dt><code>CurrentCapabilities</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_DEVICE_MODEM_CAPABILITIES">NM_DEVICE_MODEM_CAPABILITIES</a>)
</dt><dd>
The generic family of access technologies the modem currently supports
without a firmware reload or reinitialization.
</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_DEVICE_MODEM_CAPABILITIES" id="type-NM_DEVICE_MODEM_CAPABILITIES">NM_DEVICE_MODEM_CAPABILITIES</a></h3>
Flags describing one or more of the general access technology families
that a modem device supports.
<dl><dt><code>NM_DEVICE_MODEM_CAPABILITY_NONE = 0x0</code></dt><dd>Modem has no capabilties.</dd><dt><code>NM_DEVICE_MODEM_CAPABILITY_POTS = 0x1</code></dt><dd>
Modem supports the analog wired telephone network (ie 56k dialup) and
does not have wireless/cellular capabilities.
</dd><dt><code>NM_DEVICE_MODEM_CAPABILITY_CDMA_EVDO = 0x2</code></dt><dd>
Modem supports at least one of CDMA 1xRTT, EVDO revision 0, EVDO
revision A, or EVDO revision B.
</dd><dt><code>NM_DEVICE_MODEM_CAPABILITY_GSM_UMTS = 0x4</code></dt><dd>
Modem supports at least one of GSM, GPRS, EDGE, UMTS, HSDPA, HSUPA, or
HSPA+ packet switched data capability.
</dd><dt><code>NM_DEVICE_MODEM_CAPABILITY_LTE = 0x8</code></dt><dd>
Modem has at LTE data capability.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Bluetooth" id="org.freedesktop.NetworkManager.Device.Bluetooth"></a>org.freedesktop.NetworkManager.Device.Bluetooth</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Bluetooth.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Bluetooth.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Bluetooth hardware address of the device.
</dd><dt><code>Name</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Bluetooth name of the device.
</dd><dt><code>BtCapabilities</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_BT_CAPABILITIES">NM_BT_CAPABILITIES</a>)
</dt><dd>
Bluetooth capabilities of the device (either DUN or NAP).
</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_BT_CAPABILITIES" id="type-NM_BT_CAPABILITIES">NM_BT_CAPABILITIES</a></h3>
Flags describing the capabilities of a Bluetooth device.
<dl><dt><code>NM_BT_CAPABILITY_NONE = 0x0</code></dt><dd>The device has no recognized capabilities.</dd><dt><code>NM_BT_CAPABILITY_DUN = 0x1</code></dt><dd>The device supports Bluetooth Dial-Up Networking.</dd><dt><code>NM_BT_CAPABILITY_PAN = 0x2</code></dt><dd>The device supports Bluetooth Personal Area Networking.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.OlpcMesh" id="org.freedesktop.NetworkManager.Device.OlpcMesh"></a>org.freedesktop.NetworkManager.Device.OlpcMesh</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.OlpcMesh.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.OlpcMesh.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring">
Emitted when the wireless device's properties changed.
</div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary containing the FIXME: check changed parameters.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The hardware address of the device.
</dd><dt><code>Companion</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
The object path of the companion device.
</dd><dt><code>ActiveChannel</code> -
<code>u</code> -
<code>(read)</code></dt><dd>
The currently active channel.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.WiMax" id="org.freedesktop.NetworkManager.Device.WiMax"></a>org.freedesktop.NetworkManager.Device.WiMax</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Device.WiMax.GetNspList" id="org.freedesktop.NetworkManager.Device.WiMax.GetNspList">GetNspList</a> (
) →
ao</h3><div class="docstring">
Get the list of NSPs visible to this device.
</div><div><h4>Returns</h4><dl><dt><code>nsps</code> -
<code>ao</code></dt><dd>
List of NSP object paths
</dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.WiMax.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.WiMax.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring">
Emitted when the WiMax device's properties changed.
</div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.WiMax.NspAdded" id="org.freedesktop.NetworkManager.Device.WiMax.NspAdded">NspAdded</a> (
o: nsp
)</h3><div class="docstring">
Emitted when a new NSP is found by the device.
</div><div><h4>Parameters</h4><dl><dt><code>nsp</code> -
<code>o</code></dt><dd>
The object path of the newly found NSP.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.WiMax.NspRemoved" id="org.freedesktop.NetworkManager.Device.WiMax.NspRemoved">NspRemoved</a> (
o: nsp
)</h3><div class="docstring">
Emitted when an NSP disappears from view of the device.
</div><div><h4>Parameters</h4><dl><dt><code>nsp</code> -
<code>o</code></dt><dd>
The object path of the NSP that has disappeared.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Nsps</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>
List of object paths of Network Service Providers (NSPs) visible to this
WiMAX device.
</dd><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Hardware address of the device.
</dd><dt><code>CenterFrequency</code> -
<code>u</code> -
<code>(read)</code></dt><dd>
Center frequency (in KHz) of the radio channel the device is using to
communicate with the network when connected. Has no meaning when the
device is not connected.
</dd><dt><code>Rssi</code> -
<code>i</code> -
<code>(read)</code></dt><dd>
RSSI of the current radio link in dBm. This value indicates how strong
the raw received RF signal from the base station is, but does not
indicate the overall quality of the radio link. Has no meaning when the
device is not connected.
</dd><dt><code>Cinr</code> -
<code>i</code> -
<code>(read)</code></dt><dd>
CINR (Carrier to Interference + Noise Ratio) of the current radio link
in dB. CINR is a more accurate measure of radio link quality. Has no
meaning when the device is not connected.
</dd><dt><code>TxPower</code> -
<code>i</code> -
<code>(read)</code></dt><dd>
Average power of the last burst transmitted by the device, in units of
0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of
-5.5 dBm. Has no meaning when the device is not connected.
</dd><dt><code>Bsid</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The ID of the serving base station as received from the network. Has
no meaning when the device is not connected.
</dd><dt><code>ActiveNsp</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the NSP currently used by the WiMax device.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Infiniband" id="org.freedesktop.NetworkManager.Device.Infiniband"></a>org.freedesktop.NetworkManager.Device.Infiniband</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Infiniband.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Infiniband.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Hardware address of the device.
</dd><dt><code>Carrier</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Bond" id="org.freedesktop.NetworkManager.Device.Bond"></a>org.freedesktop.NetworkManager.Device.Bond</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Bond.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Bond.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Hardware address of the device.
</dd><dt><code>Carrier</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
</dd><dt><code>Slaves</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>
Array of object paths representing devices which are currently
slaved to this device.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Bridge" id="org.freedesktop.NetworkManager.Device.Bridge"></a>org.freedesktop.NetworkManager.Device.Bridge</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Bridge.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Bridge.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Hardware address of the device.
</dd><dt><code>Carrier</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
</dd><dt><code>Slaves</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>
Array of object paths representing devices which are currently
slaved to this device.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Team" id="org.freedesktop.NetworkManager.Device.Team"></a>org.freedesktop.NetworkManager.Device.Team</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Team.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Team.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Hardware address of the device.
</dd><dt><code>Carrier</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
</dd><dt><code>Slaves</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>
Array of object paths representing devices which are currently
slaved to this device.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Generic" id="org.freedesktop.NetworkManager.Device.Generic"></a>org.freedesktop.NetworkManager.Device.Generic</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Generic.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Generic.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Hardware address of the device.
</dd><dt><code>TypeDescription</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
A (non-localized) description of the interface type, if known.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Vlan" id="org.freedesktop.NetworkManager.Device.Vlan"></a>org.freedesktop.NetworkManager.Device.Vlan</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Vlan.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Vlan.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>HwAddress</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
Hardware address of the device.
</dd><dt><code>Carrier</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
</dd><dt><code>VlanId</code> -
<code>u</code> -
<code>(read)</code></dt><dd>
The VLAN ID of this VLAN interface.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Device.Adsl" id="org.freedesktop.NetworkManager.Device.Adsl"></a>org.freedesktop.NetworkManager.Device.Adsl</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Device.Adsl.PropertiesChanged" id="org.freedesktop.NetworkManager.Device.Adsl.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Carrier</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Indicates whether the physical carrier is found.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.WiMax.Nsp" id="org.freedesktop.NetworkManager.WiMax.Nsp"></a>org.freedesktop.NetworkManager.WiMax.Nsp</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.WiMax.Nsp.PropertiesChanged" id="org.freedesktop.NetworkManager.WiMax.Nsp.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Name</code> -
<code>s</code> -
<code>(read)</code></dt><dd>The name of the NSP.</dd><dt><code>SignalQuality</code> -
<code>u</code> -
<code>(read)</code></dt><dd>The current signal quality of the NSP, in percent.</dd><dt><code>NetworkType</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_WIMAX_NSP_NETWORK_TYPE">NM_WIMAX_NSP_NETWORK_TYPE</a>)
</dt><dd>The network type of the NSP.</dd></dl><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_WIMAX_NSP_NETWORK_TYPE" id="type-NM_WIMAX_NSP_NETWORK_TYPE">NM_WIMAX_NSP_NETWORK_TYPE</a></h3>
Network type of the NSP.
<dl><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN = 0x0</code></dt><dd>Unknown network.</dd><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_HOME = 0x1</code></dt><dd>Home network.</dd><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_PARTNER = 0x2</code></dt><dd>Partner network.</dd><dt><code>NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER = 0x3</code></dt><dd>Roaming partner network.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.IP4Config" id="org.freedesktop.NetworkManager.IP4Config"></a>org.freedesktop.NetworkManager.IP4Config</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.IP4Config.PropertiesChanged" id="org.freedesktop.NetworkManager.IP4Config.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Gateway</code> -
<code>s</code> -
<code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Addresses</code> -
<code>aau</code> -
<code>(read)</code></dt><dd>Array of tuples of IPv4 address/prefix/gateway. All 3
elements of each tuple are in network byte order. Essentially:
[(addr, prefix, gateway), (addr, prefix, gateway), ...]
</dd><dt><code>Routes</code> -
<code>aau</code> -
<code>(read)</code></dt><dd>Tuples of IPv4 route/prefix/next-hop/metric. All 4 elements
of each tuple are in network byte order. 'route' and 'next hop' are IPv4
addresses, while prefix and metric are simple unsigned integers. Essentially:
[(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), ...]
</dd><dt><code>Nameservers</code> -
<code>au</code> -
<code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>Domains</code> -
<code>as</code> -
<code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Searches</code> -
<code>as</code> -
<code>(read)</code></dt><dd>A list of dns searches.</dd><dt><code>WinsServers</code> -
<code>au</code> -
<code>(read)</code></dt><dd>The Windows Internet Name Service servers associated with the connection. Each address is in network byte order.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.IP6Config" id="org.freedesktop.NetworkManager.IP6Config"></a>org.freedesktop.NetworkManager.IP6Config</h1><p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.IP6Config.PropertiesChanged" id="org.freedesktop.NetworkManager.IP6Config.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Gateway</code> -
<code>s</code> -
<code>(read)</code></dt><dd>The gateway in use.</dd><dt><code>Addresses</code> -
<code>a(ayuay)</code> -
<code>(read)</code></dt><dd>Tuples of IPv6 address/prefix/gateway.</dd><dt><code>Routes</code> -
<code>a(ayuayu)</code> -
<code>(read)</code></dt><dd>Tuples of IPv6 route/prefix/next-hop/metric.</dd><dt><code>Nameservers</code> -
<code>aay</code> -
<code>(read)</code></dt><dd>The nameservers in use.</dd><dt><code>Domains</code> -
<code>as</code> -
<code>(read)</code></dt><dd>A list of domains this address belongs to.</dd><dt><code>Searches</code> -
<code>as</code> -
<code>(read)</code></dt><dd>A list of dns searches.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.DHCP4Config" id="org.freedesktop.NetworkManager.DHCP4Config"></a>org.freedesktop.NetworkManager.DHCP4Config</h1>
Options and configuration returned by the IPv4 DHCP server.
<p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DHCP4Config.PropertiesChanged" id="org.freedesktop.NetworkManager.DHCP4Config.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Options</code> -
<code>a{sv}</code> -
<code>(read)</code></dt><dd>Configuration options returned by a DHCP server, if any.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.DHCP6Config" id="org.freedesktop.NetworkManager.DHCP6Config"></a>org.freedesktop.NetworkManager.DHCP6Config</h1>
Options and configuration returned by the IPv6 DHCP server.
<p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.DHCP6Config.PropertiesChanged" id="org.freedesktop.NetworkManager.DHCP6Config.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Options</code> -
<code>a{sv}</code> -
<code>(read)</code></dt><dd>Configuration options returned by a DHCP server, if any.</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Settings" id="org.freedesktop.NetworkManager.Settings"></a>org.freedesktop.NetworkManager.Settings</h1>
The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager.
<h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.ListConnections" id="org.freedesktop.NetworkManager.Settings.ListConnections">ListConnections</a> (
) →
ao</h3><div class="docstring">
List the saved network connections known to NetworkManager.
</div><div><h4>Returns</h4><dl><dt><code>connections</code> -
<code>ao</code></dt><dd>
List of connections.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.GetConnectionByUuid" id="org.freedesktop.NetworkManager.Settings.GetConnectionByUuid">GetConnectionByUuid</a> (
s: uuid
) →
o</h3><div class="docstring">
Retrieve the object path of a connection, given that connection's UUID.
</div><div><h4>Parameters</h4><dl><dt><code>uuid</code> -
<code>s</code></dt><dd>
The UUID to find the connection object path for.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>connection</code> -
<code>o</code></dt><dd>
The connection's object path.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.AddConnection" id="org.freedesktop.NetworkManager.Settings.AddConnection">AddConnection</a> (
a{sa{sv}}: connection
) →
o</h3><div class="docstring">
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.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>a{sa{sv}}</code></dt><dd>
Connection settings and properties.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>path</code> -
<code>o</code></dt><dd>
Object path of the new connection that was just added.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.AddConnectionUnsaved" id="org.freedesktop.NetworkManager.Settings.AddConnectionUnsaved">AddConnectionUnsaved</a> (
a{sa{sv}}: connection
) →
o</h3><div class="docstring">
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 on the connection to save these changes
to disk. Note that unsaved changes will be lost if the
connection is reloaded from disk (either automatically on file
change or due to an explicit ReloadConnections call).
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>a{sa{sv}}</code></dt><dd>
Connection settings and properties.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>path</code> -
<code>o</code></dt><dd>
Object path of the new connection that was just added.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.LoadConnections" id="org.freedesktop.NetworkManager.Settings.LoadConnections">LoadConnections</a> (
as: filenames
) →
b, as</h3><div class="docstring">
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.
</div><div><h4>Parameters</h4><dl><dt><code>filenames</code> -
<code>as</code></dt><dd>
Array of paths to on-disk connection profiles in directories
monitored by NetworkManager.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>status</code> -
<code>b</code></dt><dd>
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).
</dd><dt><code>failures</code> -
<code>as</code></dt><dd>
Paths of connection files that could not be loaded.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.ReloadConnections" id="org.freedesktop.NetworkManager.Settings.ReloadConnections">ReloadConnections</a> (
) →
b</h3><div class="docstring">
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.
</div><div><h4>Returns</h4><dl><dt><code>status</code> -
<code>b</code></dt><dd>
Success or failure.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.SaveHostname" id="org.freedesktop.NetworkManager.Settings.SaveHostname">SaveHostname</a> (
s: hostname
) →
nothing</h3><div class="docstring">
Save the hostname to persistent configuration.
</div><div><h4>Parameters</h4><dl><dt><code>hostname</code> -
<code>s</code></dt><dd>
The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.
</dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.PropertiesChanged" id="org.freedesktop.NetworkManager.Settings.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.NewConnection" id="org.freedesktop.NetworkManager.Settings.NewConnection">NewConnection</a> (
o: connection
)</h3><div class="docstring">
Emitted when a new connection has been added after NetworkManager has
started up and initialized. This signal is not emitted for connections
read while starting up, because NetworkManager's D-Bus service is only
available after all connections have been read, and to prevent spamming
listeners with too many signals at one time. To retrieve the initial
connection list, call the ListConnections() method once, and then listen
for individual Settings.NewConnection and Settings.Connection.Deleted
signals for further updates.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>o</code></dt><dd>
Object path of the new connection.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.ConnectionRemoved" id="org.freedesktop.NetworkManager.Settings.ConnectionRemoved">ConnectionRemoved</a> (
o: connection
)</h3><div class="docstring">
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.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>o</code></dt><dd>
Object path of the removed connection.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Connections</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>
List of object paths of available network connection profiles.
</dd><dt><code>Hostname</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The machine hostname stored in persistent configuration.
</dd><dt><code>CanModify</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
If true, adding and modifying connections is supported.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Settings.Connection" id="org.freedesktop.NetworkManager.Settings.Connection"></a>org.freedesktop.NetworkManager.Settings.Connection</h1>
Represents a single network connection configuration.
<h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Update" id="org.freedesktop.NetworkManager.Settings.Connection.Update">Update</a> (
a{sa{sv}}: properties
) →
nothing</h3><div class="docstring">
Update the connection with new settings and properties (replacing
all previous settings and properties) and save the connection to
disk. Secrets may be part of the update request, and will be either
stored in persistent storage or sent to a Secret Agent for storage,
depending on the flags associated with each secret.
</div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sa{sv}}</code></dt><dd>
New connection settings, properties, and (optionally) secrets.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.UpdateUnsaved" id="org.freedesktop.NetworkManager.Settings.Connection.UpdateUnsaved">UpdateUnsaved</a> (
a{sa{sv}}: properties
) →
nothing</h3><div class="docstring">
Update the connection with new settings and properties (replacing
all previous settings and properties) but do not immediately save
the connection to disk. Secrets may be part of the update request
and may sent to a Secret Agent for storage, depending on the
flags associated with each secret.
Use the 'Save' method to save these changes to disk. Note
that unsaved changes will be lost if the connection is
reloaded from disk (either automatically on file change or
due to an explicit ReloadConnections call).
</div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sa{sv}}</code></dt><dd>
New connection settings, properties, and (optionally) secrets.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Delete" id="org.freedesktop.NetworkManager.Settings.Connection.Delete">Delete</a> (
) →
nothing</h3><div class="docstring">
Delete the connection.
</div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.GetSettings" id="org.freedesktop.NetworkManager.Settings.Connection.GetSettings">GetSettings</a> (
) →
a{sa{sv}}</h3><div class="docstring">
Get the settings maps describing this network configuration.
This will never include any secrets required for connection
to the network, as those are often protected. Secrets must
be requested separately using the GetSecrets() call.
</div><div><h4>Returns</h4><dl><dt><code>settings</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
The nested settings maps describing this object.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.GetSecrets" id="org.freedesktop.NetworkManager.Settings.Connection.GetSecrets">GetSecrets</a> (
s: setting_name
) →
a{sa{sv}}</h3><div class="docstring">
Get the secrets belonging to this network configuration. Only
secrets from persistent storage or a Secret Agent running in
the requestor's session will be returned. The user will never
be prompted for secrets as a result of this request.
</div><div><h4>Parameters</h4><dl><dt><code>setting_name</code> -
<code>s</code></dt><dd>
Name of the setting to return secrets for. If empty, all
all secrets will be returned.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>secrets</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Nested settings maps containing secrets.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Save" id="org.freedesktop.NetworkManager.Settings.Connection.Save">Save</a> (
) →
nothing</h3><div class="docstring">
Saves a "dirty" connection (that had previously been
updated with UpdateUnsaved) to persistent storage.
</div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Updated" id="org.freedesktop.NetworkManager.Settings.Connection.Updated">Updated</a> (
)</h3><div class="docstring">
Emitted when any settings or permissions change. When handling
this signal, clients should re-read the connection using the
GetSettings method to get the changes and to ensure the client
still has permission to access the connection.
</div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.Removed" id="org.freedesktop.NetworkManager.Settings.Connection.Removed">Removed</a> (
)</h3><div class="docstring">
Emitted when this 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 object no longer exists. Also
see the Settings.ConnectionRemoved signal.
</div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Settings.Connection.PropertiesChanged" id="org.freedesktop.NetworkManager.Settings.Connection.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Unsaved</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
If set, indicates that the in-memory state of the
connection does not match the on-disk state. This flag
will be set when UpdateUnsaved() is called or when any
connection details change, and cleared when the connection
is saved to disk via Save() or from internal operations.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.Connection.Active" id="org.freedesktop.NetworkManager.Connection.Active"></a>org.freedesktop.NetworkManager.Connection.Active</h1>
Objects that implement the Connection.Active interface represent an attempt
to connect to a network using the details provided by a Connection object.
The Connection.Active object tracks the life-cycle of the connection
attempt and if successful indicates whether the connected network is the
"default" or preferred network for access.
<p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.Connection.Active.PropertiesChanged" id="org.freedesktop.NetworkManager.Connection.Active.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>Connection</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
The path of the connection.
</dd><dt><code>SpecificObject</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
A specific object associated with the active connection. This property
reflects the specific object used during connection activation, and will
not change over the lifetime of the ActiveConnection once set.
</dd><dt><code>Id</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The ID of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
</dd><dt><code>Uuid</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The UUID of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
</dd><dt><code>Type</code> -
<code>s</code> -
<code>(read)</code></dt><dd>
The type of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
</dd><dt><code>Devices</code> -
<code>ao</code> -
<code>(read)</code></dt><dd>
Array of object paths representing devices which are part of this active
connection.
</dd><dt><code>State</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a>)
</dt><dd>
The state of this active connection.
</dd><dt><code>Default</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Whether this active connection is the default IPv4 connection, i.e.
whether it currently owns the default IPv4 route.
</dd><dt><code>Ip4Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Ip4Config object describing the configuration of the
connection. Only valid when the connection is in the
NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
</dd><dt><code>Dhcp4Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Dhcp4Config object describing the DHCP options
returned by the DHCP server (assuming the connection used DHCP). Only
valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
state.
</dd><dt><code>Default6</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Whether this active connection is the default IPv6 connection, i.e.
whether it currently owns the default IPv6 route.
</dd><dt><code>Ip6Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Ip6Config object describing the configuration of the
connection. Only valid when the connection is in the
NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
</dd><dt><code>Dhcp6Config</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
Object path of the Dhcp6Config object describing the DHCP options
returned by the DHCP server (assuming the connection used DHCP). Only
valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
state.
</dd><dt><code>Vpn</code> -
<code>b</code> -
<code>(read)</code></dt><dd>
Whether this active connection is also a VPN connection.
</dd><dt><code>Master</code> -
<code>o</code> -
<code>(read)</code></dt><dd>
The path to the master device if the connection is a slave.
</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_ACTIVE_CONNECTION_STATE" id="type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a></h3><dl><dt><code>NM_ACTIVE_CONNECTION_STATE_UNKNOWN = 0</code></dt><dd>
The active connection is in an unknown state.
</dd><dt><code>NM_ACTIVE_CONNECTION_STATE_ACTIVATING = 1</code></dt><dd>
The connection is activating.
</dd><dt><code>NM_ACTIVE_CONNECTION_STATE_ACTIVATED = 2</code></dt><dd>
The connection is activated.
</dd><dt><code>NM_ACTIVE_CONNECTION_STATE_DEACTIVATING = 3</code></dt><dd>
The connection is being torn down and cleaned up.
</dd><dt><code>NM_ACTIVE_CONNECTION_STATE_DEACTIVATED = 4</code></dt><dd>
The connection is no longer active.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.AgentManager" id="org.freedesktop.NetworkManager.AgentManager"></a>org.freedesktop.NetworkManager.AgentManager</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.AgentManager.Register" id="org.freedesktop.NetworkManager.AgentManager.Register">Register</a> (
s: identifier
) →
nothing</h3><div class="docstring">
Called by secret Agents to register their ability to provide and save
network secrets.
</div><div><h4>Parameters</h4><dl><dt><code>identifier</code> -
<code>s</code></dt><dd>
Identifies this agent; only one agent in each user session may use the
same identifier. Identifier formatting follows the same rules as
D-Bus bus names with the exception that the ':' character is not
allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the
identifier is limited in length to 255 characters with a minimum
of 3 characters. An example valid identifier is 'org.gnome.nm-applet'
(without quotes).
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.AgentManager.RegisterWithCapabilities" id="org.freedesktop.NetworkManager.AgentManager.RegisterWithCapabilities">RegisterWithCapabilities</a> (
s: identifier, u: capabilities
) →
nothing</h3><div class="docstring">
Like Register() but indicates agent capabilities to NetworkManager.
</div><div><h4>Parameters</h4><dl><dt><code>identifier</code> -
<code>s</code></dt><dd>
See the Register() method's identifier argument.
</dd><dt><code>capabilities</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_SECRET_AGENT_CAPABILITIES">NM_SECRET_AGENT_CAPABILITIES</a>)
</dt><dd>
Indicates various agent capabilities to NetworkManager.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.AgentManager.Unregister" id="org.freedesktop.NetworkManager.AgentManager.Unregister">Unregister</a> (
) →
nothing</h3><div class="docstring">
Called by secret Agents to notify NetworkManager that they will no
longer handle requests for network secrets. Agents are automatically
unregistered when they disconnect from D-Bus.
</div></div><p>Interface has no signals.</p><p>Interface has no properties.</p>
<h1><a name="org.freedesktop.NetworkManager.SecretAgent" id="org.freedesktop.NetworkManager.SecretAgent"></a>org.freedesktop.NetworkManager.SecretAgent</h1>
Private D-Bus interface used by secret agents that store and provide
secrets to NetworkManager. If an agent provides secrets to
NetworkManager as part of connection creation, and the some of those
secrets are "agent owned" the agent should store those secrets
itself and should not expect its SaveSecrets() method to be called.
SaveSecrets() will be called eg if some program other than the
agent itself (like a connection editor) changes the secrets out of
band. The agent should implement this D-Bus interface on an object
with the path /org/freedesktop/NetworkManager/SecretAgent.
<h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.SecretAgent.GetSecrets" id="org.freedesktop.NetworkManager.SecretAgent.GetSecrets">GetSecrets</a> (
a{sa{sv}}: connection, o: connection_path, s: setting_name, as: hints, u: flags
) →
a{sa{sv}}</h3><div class="docstring">
Retrieve and return stored secrets, if any, or request new
secrets from the agent's user. If user interaction is allowed
and the user enters new secrets, the agent is expected to save
the new secrets to persistent storage (if the secret's flags
include AGENT_OWNED) as NetworkManager will not send these
secrets back to the same agent via a SaveSecrets() call. If
the user canceled any interaction, the agent should return the
UserCanceled error (see below).
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Nested settings maps containing the connection for which
secrets are being requested. This may contain system-owned
secrets if the agent has successfully authenticated to
modify system network settings and the GetSecrets request
flags allow user interaction.
</dd><dt><code>connection_path</code> -
<code>o</code></dt><dd>
Object path of the connection for which secrets are being
requested.
</dd><dt><code>setting_name</code> -
<code>s</code></dt><dd>
Setting name for which secrets are being requested.
</dd><dt><code>hints</code> -
<code>as</code></dt><dd>
Array of strings of key names in the requested setting for
which NetworkManager thinks a secrets may be required,
and/or well-known identifiers and data that may be useful
to the client in processing the secrets request. Note that
it's not always possible to determine which secret is
required, so in some cases no hints may be given. The Agent
should return any secrets it has, or that it thinks are
required, regardless of what hints NetworkManager sends
in this request. Some hints have special prefixes that
provide information to the agent; for example, VPN requests
may send server-specific messages prefixed with
"x-vpn-message:".
</dd><dt><code>flags</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_SECRET_AGENT_GET_SECRETS_FLAGS">NM_SECRET_AGENT_GET_SECRETS_FLAGS</a>)
</dt><dd>
Flags which modify the behavior of the secrets request.
If true, new secrets are assumed to be invalid or incorrect,
and the agent should ask the user for new secrets. If false,
existing secrets should be retrieved from storage and
returned without interrupting the user.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>secrets</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Nested settings maps containing secrets. Each setting MUST
contain at least the 'name' field, containing the name of
the setting, and one or more secrets.
</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.SecretAgent.NotAuthorized</code></dt><dd>
Should be returned when the process requesting secrets is
not authorized to do so (like if the caller is not root
or not NetworkManager).
</dd><dt><code>org.freedesktop.NetworkManager.SecretAgent.InvalidConnection</code></dt><dd>
Should be returned if the 'connection' argument is invalid.
</dd><dt><code>org.freedesktop.NetworkManager.SecretAgent.UserCanceled</code></dt><dd>
Should be returned when the user has canceled the request.
</dd><dt><code>org.freedesktop.NetworkManager.SecretAgent.AgentCanceled</code></dt><dd>
Should be returned when NetworkManager has requested that
the agent cancel the request.
</dd><dt><code>org.freedesktop.NetworkManager.SecretAgent.InternalError</code></dt><dd>
Should be returned if the agent has encountered some internal
error processing the request.
</dd><dt><code>org.freedesktop.NetworkManager.SecretAgent.NoSecrets</code></dt><dd>
Should be returned if there are no available secrets, for
example if user interaction is not allowed and there are
no secrets stored by the agent for this connection.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.SecretAgent.CancelGetSecrets" id="org.freedesktop.NetworkManager.SecretAgent.CancelGetSecrets">CancelGetSecrets</a> (
o: connection_path, s: setting_name
) →
nothing</h3><div class="docstring">
Cancel a pending GetSecrets request for secrets of the given
connection. Any GetSecrets request with the same
'connection_path' and 'setting_name' that are given in a
CancelGetSecrets request should be canceled.
</div><div><h4>Parameters</h4><dl><dt><code>connection_path</code> -
<code>o</code></dt><dd>
Object path of the connection for which, if secrets for
the given 'setting_name' are being requested, the request
should be canceled.
</dd><dt><code>setting_name</code> -
<code>s</code></dt><dd>
Setting name for which secrets for this connection were
originally being requested.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.SecretAgent.SaveSecrets" id="org.freedesktop.NetworkManager.SecretAgent.SaveSecrets">SaveSecrets</a> (
a{sa{sv}}: connection, o: connection_path
) →
nothing</h3><div class="docstring">
Save given secrets to backing storage.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Nested settings maps containing the entire connection
(including secrets), for which the agent should save the
secrets to backing storage. This method will not be called
when the agent itself is the process creating or updating
a connection; in that case the agent is assumed to have
already saved those secrets since it had them already.
</dd><dt><code>connection_path</code> -
<code>o</code></dt><dd>
Object path of the connection for which the agent should
save secrets to backing storage.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.SecretAgent.DeleteSecrets" id="org.freedesktop.NetworkManager.SecretAgent.DeleteSecrets">DeleteSecrets</a> (
a{sa{sv}}: connection, o: connection_path
) →
nothing</h3><div class="docstring">
Delete secrets from backing storage.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Nested settings maps containing the connection properties
(sans secrets), for which the agent should delete the
secrets from backing storage.
</dd><dt><code>connection_path</code> -
<code>o</code></dt><dd>
Object path of the connection for which the agent should
delete secrets from backing storage.
</dd></dl></div></div><p>Interface has no signals.</p><p>Interface has no properties.</p><h2>Sets of flags:</h2><h3 xmlns=""><a name="type-NM_SECRET_AGENT_GET_SECRETS_FLAGS" id="type-NM_SECRET_AGENT_GET_SECRETS_FLAGS">NM_SECRET_AGENT_GET_SECRETS_FLAGS</a></h3>
Flags modifying the behavior of GetSecrets request.
<dl><dt><code>NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE = 0x0</code></dt><dd>
No special behavior; by default no user interaction is allowed and
requests for secrets are fulfilled from persistent storage, or
if no secrets are available an error is returned.
</dd><dt><code>NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION = 0x1</code></dt><dd>
Allows the request to interact with the user, possibly prompting
via UI for secrets if any are required, or if none are found in
persistent storage.
</dd><dt><code>NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW = 0x2</code></dt><dd>
Explicitly prompt for new secrets from the user. This flag
signals that NetworkManager thinks any existing secrets are
invalid or wrong. This flag implies that interaction is allowed.
</dd><dt><code>NM_SECRET_AGENT_GET_SECRETS_FLAG_USER_REQUESTED = 0x4</code></dt><dd>
Set if the request was initiated by user-requested action via the
D-Bus interface, as opposed to automatically initiated by
NetworkManager in response to (for example) scan results or
carrier changes.
</dd></dl><h3 xmlns=""><a name="type-NM_SECRET_AGENT_CAPABILITIES" id="type-NM_SECRET_AGENT_CAPABILITIES">NM_SECRET_AGENT_CAPABILITIES</a></h3><dl><dt><code>NM_SECRET_AGENT_CAPABILITY_NONE = 0x0</code></dt><dd>No special capabilities.</dd><dt><code>NM_SECRET_AGENT_CAPABILITY_VPN_HINTS = 0x1</code></dt><dd>
The agent supports passing hints to VPN plugin authentication
dialogs.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.VPN.Connection" id="org.freedesktop.NetworkManager.VPN.Connection"></a>org.freedesktop.NetworkManager.VPN.Connection</h1>
Represents an active connection to a Virtual Private Network.
<p>Interface has no methods.</p><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Connection.PropertiesChanged" id="org.freedesktop.NetworkManager.VPN.Connection.PropertiesChanged">PropertiesChanged</a> (
a{sv}: properties
)</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>properties</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
A dictionary mapping property names to variant boxed values
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Connection.VpnStateChanged" id="org.freedesktop.NetworkManager.VPN.Connection.VpnStateChanged">VpnStateChanged</a> (
u: state, u: reason
)</h3><div class="docstring">
Emitted when the state of the VPN connection has changed.
</div><div><h4>Parameters</h4><dl><dt><code>state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>)
</dt><dd>
The new state of the VPN connection.
</dd><dt><code>reason</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE_REASON">NM_VPN_CONNECTION_STATE_REASON</a>)
</dt><dd>
Reason code describing the change to the new state.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>VpnState</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>)
</dt><dd>The VPN-specific state of the connection.</dd><dt><code>Banner</code> -
<code>s</code> -
<code>(read)</code></dt><dd>The banner string of the VPN connection.</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_VPN_CONNECTION_STATE" id="type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a></h3><dl><dt><code>NM_VPN_CONNECTION_STATE_UNKNOWN = 0</code></dt><dd>
The state of the VPN connection is unknown.
</dd><dt><code>NM_VPN_CONNECTION_STATE_PREPARE = 1</code></dt><dd>
The VPN connection is preparing to connect.
</dd><dt><code>NM_VPN_CONNECTION_STATE_NEED_AUTH = 2</code></dt><dd>
The VPN connection needs authorization credentials.
</dd><dt><code>NM_VPN_CONNECTION_STATE_CONNECT = 3</code></dt><dd>
The VPN connection is being established. FIXME: Should be CONNECTING or CONNECTED.
</dd><dt><code>NM_VPN_CONNECTION_STATE_IP_CONFIG_GET = 4</code></dt><dd>
The VPN connection is getting an IP address. FIXME: Should be an -ING
</dd><dt><code>NM_VPN_CONNECTION_STATE_ACTIVATED = 5</code></dt><dd>
The VPN connection is active.
</dd><dt><code>NM_VPN_CONNECTION_STATE_FAILED = 6</code></dt><dd>
The VPN connection failed.
</dd><dt><code>NM_VPN_CONNECTION_STATE_DISCONNECTED = 7</code></dt><dd>
The VPN connection is disconnected.
</dd></dl><h3><a name="type-NM_VPN_CONNECTION_STATE_REASON" id="type-NM_VPN_CONNECTION_STATE_REASON">NM_VPN_CONNECTION_STATE_REASON</a></h3><dl><dt><code>NM_VPN_CONNECTION_STATE_REASON_UNKNOWN = 0</code></dt><dd>
The reason for the VPN connection state change is unknown.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_NONE = 1</code></dt><dd>
No reason was given for the VPN connection state change.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_USER_DISCONNECTED = 2</code></dt><dd>
The VPN connection changed state because the user disconnected it.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_DEVICE_DISCONNECTED = 3</code></dt><dd>
The VPN connection changed state because the device it was using was disconnected.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_SERVICE_STOPPED = 4</code></dt><dd>
The service providing the VPN connection was stopped.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_IP_CONFIG_INVALID = 5</code></dt><dd>
The IP config of the VPN connection was invalid.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_CONNECT_TIMEOUT = 6</code></dt><dd>
The connection attempt to the VPN service timed out.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_TIMEOUT = 7</code></dt><dd>
A timeout occurred while starting the service providing the VPN connection.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_FAILED = 8</code></dt><dd>
Starting the service starting the service providing the VPN connection failed.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_NO_SECRETS = 9</code></dt><dd>
Necessary secrets for the VPN connection were not provided.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_LOGIN_FAILED = 10</code></dt><dd>
Authentication to the VPN server failed.
</dd><dt><code>NM_VPN_CONNECTION_STATE_REASON_CONNECTION_REMOVED = 11</code></dt><dd>
The connection was deleted from settings.
</dd></dl>
<h1><a name="org.freedesktop.NetworkManager.VPN.Plugin" id="org.freedesktop.NetworkManager.VPN.Plugin"></a>org.freedesktop.NetworkManager.VPN.Plugin</h1>
This interface is provided by plugins providing VPN services to the NetworkManager daemon.
<h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Connect" id="org.freedesktop.NetworkManager.VPN.Plugin.Connect">Connect</a> (
a{sa{sv}}: connection
) →
nothing</h3><div class="docstring">
Tells the plugin to connect. Interactive secrets requests (eg, emitting
the SecretsRequired signal) are not allowed.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Describes the connection to be established.
</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</code></dt><dd>
The plugin is already starting, and another connect request was received.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</code></dt><dd>
The plugin is already connected, and another connect request was received.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd>
The plugin is already stopping, and another stop request was received.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.BadArguments</code></dt><dd>
The request could not be processed because it contained malformed
arguments, or arguments of unexpected type. It usually means that one of
the VPN setting data items or secrets was not of the expected type (i.e.
int, string, bool, etc).
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</code></dt><dd>
A binary providing the service failed to launch.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.WrongState</code></dt><dd>
The request could not be processed because the VPN plugin is in the wrong
state for this type of request.
<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.ConnectInteractive" id="org.freedesktop.NetworkManager.VPN.Plugin.ConnectInteractive">ConnectInteractive</a> (
a{sa{sv}}: connection, a{sv}: details
) →
nothing</h3><div class="docstring">
Tells the plugin to connect, allowing interactive secrets requests (eg
the plugin is allowed to emit the SecretsRequired signal if the VPN
service indicates that it needs additional secrets during the connect
process).
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Describes the connection to be established.
</dd><dt><code>details</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
Additional details about the Connect process.
</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</code></dt><dd>
The plugin is already starting, and another connect request was received.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</code></dt><dd>
The plugin is already connected, and another connect request was received.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd>
The plugin is already stopping, and another stop request was received.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.BadArguments</code></dt><dd>
The request could not be processed because it contained malformed
arguments, or arguments of unexpected type. It usually means that one of
the VPN setting data items or secrets was not of the expected type (i.e.
int, string, bool, etc).
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</code></dt><dd>
A binary providing the service failed to launch.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.WrongState</code></dt><dd>
The request could not be processed because the VPN plugin is in the wrong
state for this type of request.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported</code></dt><dd>
The request could not be processed because the plugin does not support
interactive operations, such as ConnectInteractive() or NewSecrets().
<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets" id="org.freedesktop.NetworkManager.VPN.Plugin.NeedSecrets">NeedSecrets</a> (
a{sa{sv}}: settings
) →
s</h3><div class="docstring">
Asks the plugin whether the provided connection will require secrets to connect successfully.
</div><div><h4>Parameters</h4><dl><dt><code>settings</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Describes the connection that may need secrets.
</dd></dl></div><div><h4>Returns</h4><dl><dt><code>setting_name</code> -
<code>s</code></dt><dd>
The setting name within the provided connection that requires secrets, if any.
</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid</code></dt><dd>
The request could not be processed because the connection was invalid. It
usually means that the connection's VPN setting was missing some required
data item or secret.
<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Disconnect" id="org.freedesktop.NetworkManager.VPN.Plugin.Disconnect">Disconnect</a> (
) →
nothing</h3><div class="docstring">
Disconnect the plugin.
</div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</code></dt><dd>
The plugin is already stopping, and another stop request was received.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped</code></dt><dd>
The plugin is already stopped, and another disconnect request was received.
<em>(generic description)</em></dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SetConfig" id="org.freedesktop.NetworkManager.VPN.Plugin.SetConfig">SetConfig</a> (
a{sv}: config
) →
nothing</h3><div class="docstring">
Set generic connection details on the connection.
</div><div><h4>Parameters</h4><dl><dt><code>config</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
Generic configuration details for the connection.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SetIp4Config" id="org.freedesktop.NetworkManager.VPN.Plugin.SetIp4Config">SetIp4Config</a> (
a{sv}: config
) →
nothing</h3><div class="docstring">
Set IPv4 details on the connection.
</div><div><h4>Parameters</h4><dl><dt><code>config</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
Ip4Config details for the connection. You must call
SetConfig() before calling this.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SetIp6Config" id="org.freedesktop.NetworkManager.VPN.Plugin.SetIp6Config">SetIp6Config</a> (
a{sv}: config
) →
nothing</h3><div class="docstring">
Set IPv6 details on the connection.
</div><div><h4>Parameters</h4><dl><dt><code>config</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
Ip6Config details for the connection. You must call
SetConfig() before calling this.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SetFailure" id="org.freedesktop.NetworkManager.VPN.Plugin.SetFailure">SetFailure</a> (
s: reason
) →
nothing</h3><div class="docstring">
Indicate a failure to the plugin.
</div><div><h4>Parameters</h4><dl><dt><code>reason</code> -
<code>s</code></dt><dd>
The reason for the failure.
</dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.NewSecrets" id="org.freedesktop.NetworkManager.VPN.Plugin.NewSecrets">NewSecrets</a> (
a{sa{sv}}: connection
) →
nothing</h3><div class="docstring">
Called in response to a SecretsRequired signal to deliver updated secrets
or other information to the plugin.
</div><div><h4>Parameters</h4><dl><dt><code>connection</code> -
<code>a{sa{sv}}</code>
(<a xmlns="" href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a>)
</dt><dd>
Describes the connection including the new secrets.
</dd></dl></div><div><h4>Possible errors</h4><dl><dt><code>org.freedesktop.NetworkManager.VPN.Error.WrongState</code></dt><dd>
The request could not be processed because the VPN plugin is in the wrong
state for this type of request.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.BadArguments</code></dt><dd>
The request could not be processed because it contained malformed
arguments, or arguments of unexpected type. It usually means that one of
the VPN setting data items or secrets was not of the expected type (i.e.
int, string, bool, etc).
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</code></dt><dd>
A binary providing the service failed to launch.
<em>(generic description)</em></dd><dt><code>org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported</code></dt><dd>
The request could not be processed because the plugin does not support
interactive operations, such as ConnectInteractive() or NewSecrets().
<em>(generic description)</em></dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.StateChanged" id="org.freedesktop.NetworkManager.VPN.Plugin.StateChanged">StateChanged</a> (
u: state
)</h3><div class="docstring">
Emitted when the plugin state changes.
</div><div><h4>Parameters</h4><dl><dt><code>state</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>)
</dt><dd>
The new state of the plugin.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.SecretsRequired" id="org.freedesktop.NetworkManager.VPN.Plugin.SecretsRequired">SecretsRequired</a> (
s: message, as: secrets
)</h3><div class="docstring">
Emitted during an ongoing ConnectInteractive() request when the plugin
has determined that new secrets are required. NetworkManager will then
call the NewSecrets() method with a connection hash including the new
secrets.
</div><div><h4>Parameters</h4><dl><dt><code>message</code> -
<code>s</code></dt><dd>
Informational message, if any, about the request. For example, if
a second PIN is required, could indicate to the user to wait for
the token code to change until entering the next PIN.
</dd><dt><code>secrets</code> -
<code>as</code></dt><dd>
Array of strings of VPN secret names which the plugin thinks
secrets may be required for, or other VPN-specific data to be
processed by the VPN's front-end.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Config" id="org.freedesktop.NetworkManager.VPN.Plugin.Config">Config</a> (
a{sv}: config
)</h3><div class="docstring">
The plugin obtained generic configuration information.
</div><div><h4>Parameters</h4><dl><dt><code>config</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
The configuration information.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Ip4Config" id="org.freedesktop.NetworkManager.VPN.Plugin.Ip4Config">Ip4Config</a> (
a{sv}: ip4config
)</h3><div class="docstring">
The plugin obtained an IPv4 configuration.
</div><div><h4>Parameters</h4><dl><dt><code>ip4config</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
The IPv4 configuration.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Ip6Config" id="org.freedesktop.NetworkManager.VPN.Plugin.Ip6Config">Ip6Config</a> (
a{sv}: ip6config
)</h3><div class="docstring">
The plugin obtained an IPv6 configuration.
</div><div><h4>Parameters</h4><dl><dt><code>ip6config</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd>
The IPv6 configuration.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.LoginBanner" id="org.freedesktop.NetworkManager.VPN.Plugin.LoginBanner">LoginBanner</a> (
s: banner
)</h3><div class="docstring">
Emitted when the plugin receives a login banner from the VPN service.
</div><div><h4>Parameters</h4><dl><dt><code>banner</code> -
<code>s</code></dt><dd>
The login banner string.
</dd></dl></div></div><div class="signal"><h3><a name="org.freedesktop.NetworkManager.VPN.Plugin.Failure" id="org.freedesktop.NetworkManager.VPN.Plugin.Failure">Failure</a> (
u: reason
)</h3><div class="docstring">
Emitted when a failure in the VPN plugin occurs.
</div><div><h4>Parameters</h4><dl><dt><code>reason</code> -
<code>u</code>
(<a xmlns="" href="#type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a>)
</dt><dd>
Reason code for the failure.
</dd></dl></div></div><h2>Properties:</h2><dl><dt><code>State</code> -
<code>u</code> -
<code>(read)</code>
(<a xmlns="" href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a>)
</dt><dd>
The state of the plugin.
</dd></dl><h2>Enumerated types:</h2><h3><a name="type-NM_VPN_PLUGIN_FAILURE" id="type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></h3><dl><dt><code>NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED = 0</code></dt><dd>
Login failed.
</dd><dt><code>NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED = 1</code></dt><dd>
Connect failed.
</dd><dt><code>NM_VPN_PLUGIN_FAILURE_BAD_IP_CONFIG = 2</code></dt><dd>
Invalid IP configuration returned from the VPN plugin.
</dd></dl>
<h1>Generic types:</h1><h2>Enumerated types:</h2><h3><a name="type-NM_802_11_MODE" id="type-NM_802_11_MODE">NM_802_11_MODE</a></h3><dl><dt><code>NM_802_11_MODE_UNKNOWN = 0</code></dt><dd>Mode is unknown.</dd><dt><code>NM_802_11_MODE_ADHOC = 1</code></dt><dd>
For both devices and access point objects, indicates the object is
part of an Ad-Hoc 802.11 network without a central coordinating access
point.
</dd><dt><code>NM_802_11_MODE_INFRA = 2</code></dt><dd>
The wireless device or access point is in infrastructure mode. For
devices, this indicates the device is an 802.11 client/station. For
access point objects, this indicates the object is an access point that
provides connectivity to clients.
</dd><dt><code>NM_802_11_MODE_AP = 3</code></dt><dd>
The device is an access point/hotspot. Not valid for access point
objects themselves.
</dd></dl><h2>Mapping types:</h2><div class="struct"><h3><a name="type-String_Variant_Map" id="type-String_Variant_Map">String_Variant_Map</a> - a{
s: Key → v: Value
}
</h3><div class="docstring">A mapping from strings to variants representing extra
key-value pairs.</div><div><h4>Members</h4><dl><dt><code>Key</code> -
<code>s</code></dt><dd><em>(undocumented)</em></dd><dt><code>Value</code> -
<code>v</code></dt><dd><em>(undocumented)</em></dd></dl></div></div><div class="struct"><h3><a name="type-String_String_Map" id="type-String_String_Map">String_String_Map</a> - a{
s: Key → s: Value
}
</h3><div class="docstring">A mapping from strings to strings representing extra
key-value pairs.</div><div><h4>Members</h4><dl><dt><code>Key</code> -
<code>s</code></dt><dd><em>(undocumented)</em></dd><dt><code>Value</code> -
<code>s</code></dt><dd><em>(undocumented)</em></dd></dl></div></div><div class="struct"><h3><a name="type-String_String_Variant_Map_Map" id="type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a> - a{
s: Key → a{sv}: Value
}
</h3><div class="docstring">A mapping from strings to a map of string to variant.</div><div><h4>Members</h4><dl><dt><code>Key</code> -
<code>s</code></dt><dd><em>(undocumented)</em></dd><dt><code>Value</code> -
<code>a{sv}</code>
(<a xmlns="" href="#type-String_Variant_Map">String_Variant_Map</a>)
</dt><dd><em>(undocumented)</em></dd></dl></div></div><h1>Errors:</h1>
<h2><a name="org.freedesktop.NetworkManager.Error.UnknownConnection" id="org.freedesktop.NetworkManager.Error.UnknownConnection"></a>org.freedesktop.NetworkManager.Error.UnknownConnection</h2>
Connection was not provided by the settings service.
<h2><a name="org.freedesktop.NetworkManager.Error.UnknownDevice" id="org.freedesktop.NetworkManager.Error.UnknownDevice"></a>org.freedesktop.NetworkManager.Error.UnknownDevice</h2>
Unknown device.
<h2><a name="org.freedesktop.NetworkManager.Error.PermissionDenied" id="org.freedesktop.NetworkManager.Error.PermissionDenied"></a>org.freedesktop.NetworkManager.Error.PermissionDenied</h2>
User does not have the permission to activate this connection.
<h1>Errors:</h1>
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.General" id="org.freedesktop.NetworkManager.VPN.Error.General"></a>org.freedesktop.NetworkManager.VPN.Error.General</h2>General failure without further details.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress" id="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"></a>org.freedesktop.NetworkManager.VPN.Error.StartingInProgress</h2>
The plugin is already starting, and another connect request was received.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted" id="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"></a>org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted</h2>
The plugin is already connected, and another connect request was received.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress" id="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"></a>org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress</h2>
The plugin is already stopping, and another stop request was received.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped" id="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped"></a>org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped</h2>
The plugin is already stopped, and another disconnect request was received.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.WrongState" id="org.freedesktop.NetworkManager.VPN.Error.WrongState"></a>org.freedesktop.NetworkManager.VPN.Error.WrongState</h2>
The request could not be processed because the VPN plugin is in the wrong
state for this type of request.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.BadArguments" id="org.freedesktop.NetworkManager.VPN.Error.BadArguments"></a>org.freedesktop.NetworkManager.VPN.Error.BadArguments</h2>
The request could not be processed because it contained malformed
arguments, or arguments of unexpected type. It usually means that one of
the VPN setting data items or secrets was not of the expected type (i.e.
int, string, bool, etc).
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed" id="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"></a>org.freedesktop.NetworkManager.VPN.Error.LaunchFailed</h2>
A binary providing the service failed to launch.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid" id="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid"></a>org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid</h2>
The request could not be processed because the connection was invalid. It
usually means that the connection's VPN setting was missing some required
data item or secret.
<h2><a name="org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported" id="org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported"></a>org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported</h2>
The request could not be processed because the plugin does not support
interactive operations, such as ConnectInteractive() or NewSecrets().
<h1>Index</h1><h2>Index of interfaces</h2><ul><li><code><a href="#org.freedesktop.NetworkManager">org.freedesktop.NetworkManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AccessPoint">org.freedesktop.NetworkManager.AccessPoint</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device">org.freedesktop.NetworkManager.Device</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wired">org.freedesktop.NetworkManager.Device.Wired</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Wireless">org.freedesktop.NetworkManager.Device.Wireless</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Modem">org.freedesktop.NetworkManager.Device.Modem</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bluetooth">org.freedesktop.NetworkManager.Device.Bluetooth</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.OlpcMesh">org.freedesktop.NetworkManager.Device.OlpcMesh</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.WiMax">org.freedesktop.NetworkManager.Device.WiMax</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Infiniband">org.freedesktop.NetworkManager.Device.Infiniband</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bond">org.freedesktop.NetworkManager.Device.Bond</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Bridge">org.freedesktop.NetworkManager.Device.Bridge</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Team">org.freedesktop.NetworkManager.Device.Team</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Generic">org.freedesktop.NetworkManager.Device.Generic</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Vlan">org.freedesktop.NetworkManager.Device.Vlan</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Device.Adsl">org.freedesktop.NetworkManager.Device.Adsl</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.WiMax.Nsp">org.freedesktop.NetworkManager.WiMax.Nsp</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP4Config">org.freedesktop.NetworkManager.IP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.IP6Config">org.freedesktop.NetworkManager.IP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP4Config">org.freedesktop.NetworkManager.DHCP4Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.DHCP6Config">org.freedesktop.NetworkManager.DHCP6Config</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings">org.freedesktop.NetworkManager.Settings</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Settings.Connection">org.freedesktop.NetworkManager.Settings.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.Connection.Active">org.freedesktop.NetworkManager.Connection.Active</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.AgentManager">org.freedesktop.NetworkManager.AgentManager</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.SecretAgent">org.freedesktop.NetworkManager.SecretAgent</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Connection">org.freedesktop.NetworkManager.VPN.Connection</a></code></li><li><code><a href="#org.freedesktop.NetworkManager.VPN.Plugin">org.freedesktop.NetworkManager.VPN.Plugin</a></code></li></ul><h2>Index of types</h2><ul><li><code><a href="#type-NM_802_11_AP_FLAGS">NM_802_11_AP_FLAGS</a></code>
- u</li><li><code><a href="#type-NM_802_11_AP_SEC">NM_802_11_AP_SEC</a></code>
- u</li><li><code><a href="#type-NM_802_11_DEVICE_CAP">NM_802_11_DEVICE_CAP</a></code>
- u</li><li><code><a href="#type-NM_802_11_MODE">NM_802_11_MODE</a></code>
- u</li><li><code><a href="#type-NM_ACTIVE_CONNECTION_STATE">NM_ACTIVE_CONNECTION_STATE</a></code>
- u</li><li><code><a href="#type-NM_BT_CAPABILITIES">NM_BT_CAPABILITIES</a></code>
- u</li><li><code><a href="#type-NM_CONNECTIVITY">NM_CONNECTIVITY</a></code>
- u</li><li><code><a href="#type-NM_DEVICE_CAP">NM_DEVICE_CAP</a></code>
- u</li><li><code><a href="#type-NM_DEVICE_MODEM_CAPABILITIES">NM_DEVICE_MODEM_CAPABILITIES</a></code>
- u</li><li><code><a href="#type-NM_DEVICE_STATE">NM_DEVICE_STATE</a></code>
- u</li><li><code><a href="#type-NM_DEVICE_STATE_REASON">NM_DEVICE_STATE_REASON</a></code>
- u</li><li><code><a href="#type-NM_DEVICE_STATE_REASON_STRUCT">NM_DEVICE_STATE_REASON_STRUCT</a></code>
- ( u, u )
</li><li><code><a href="#type-NM_DEVICE_TYPE">NM_DEVICE_TYPE</a></code>
- u</li><li><code><a href="#type-NM_SECRET_AGENT_CAPABILITIES">NM_SECRET_AGENT_CAPABILITIES</a></code>
- u</li><li><code><a href="#type-NM_SECRET_AGENT_GET_SECRETS_FLAGS">NM_SECRET_AGENT_GET_SECRETS_FLAGS</a></code>
- u</li><li><code><a href="#type-NM_STATE">NM_STATE</a></code>
- u</li><li><code><a href="#type-NM_VPN_CONNECTION_STATE">NM_VPN_CONNECTION_STATE</a></code>
- u</li><li><code><a href="#type-NM_VPN_CONNECTION_STATE_REASON">NM_VPN_CONNECTION_STATE_REASON</a></code>
- u</li><li><code><a href="#type-NM_VPN_PLUGIN_FAILURE">NM_VPN_PLUGIN_FAILURE</a></code>
- u</li><li><code><a href="#type-NM_WIMAX_NSP_NETWORK_TYPE">NM_WIMAX_NSP_NETWORK_TYPE</a></code>
- u</li><li><code><a href="#type-String_String_Map">String_String_Map</a></code>
- a{ s → s }
</li><li><code><a href="#type-String_String_Variant_Map_Map">String_String_Variant_Map_Map</a></code>
- a{ s → a{sv} }
</li><li><code><a href="#type-String_Variant_Map">String_Variant_Map</a></code>
- a{ s → v }
</li></ul></body></html>
|