/usr/share/gtk-doc/html/NetworkManager/nmcli.html is in network-manager-dev 1.10.6-2ubuntu1.1.
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 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>nmcli: NetworkManager Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="NetworkManager Reference Manual">
<link rel="up" href="manpages.html" title="Part I. Manual Pages">
<link rel="prev" href="NetworkManager.conf.html" title="NetworkManager.conf">
<link rel="next" href="nmcli-examples.html" title="nmcli-examples">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="manpages.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="NetworkManager.conf.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="nmcli-examples.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="nmcli"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">nmcli</span></h2>
<p>nmcli — command-line tool for controlling NetworkManager</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<div class="cmdsynopsis"><p><code class="command">nmcli</code> [<em class="replaceable"><code>OPTIONS</code></em>...] { <code class="option">help</code> | <code class="option">general</code> | <code class="option">networking</code> | <code class="option">radio</code> | <code class="option">connection</code> | <code class="option">device</code> | <code class="option">agent</code> | <code class="option">monitor</code> } [<em class="replaceable"><code>COMMAND</code></em>] [<em class="replaceable"><code>ARGUMENTS</code></em>...]</p></div>
</div>
<div class="refsect1">
<a name="description"></a><h2>Description</h2>
<p><span class="command"><strong>nmcli</strong></span> is a command-line tool for controlling
NetworkManager and reporting network status. It can be utilized as a
replacement for <span class="command"><strong>nm-applet</strong></span> or other graphical clients.
<span class="command"><strong>nmcli</strong></span> is used to create, display, edit, delete, activate,
and deactivate network connections, as well as control and display network
device status.</p>
<p>Typical uses include:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>Scripts: Utilize NetworkManager via <span class="command"><strong>nmcli</strong></span> instead of
managing network connections manually. <span class="command"><strong>nmcli</strong></span> supports a
terse output format which is better suited for script processing. Note that
NetworkManager can also execute scripts, called "dispatcher scripts", in
response to network events. See
<a class="link" href="NetworkManager.html" title="NetworkManager"><span class="citerefentry"><span class="refentrytitle">NetworkManager</span>(8)</span></a>
for details about these dispatcher scripts.</p></li>
<li class="listitem"><p>Servers, headless machines, and terminals: <span class="command"><strong>nmcli</strong></span> can
be used to control NetworkManager without a GUI, including creating, editing,
starting and stopping network connections and viewing network status.</p></li>
</ul></div>
</div>
<div class="refsect1">
<a name="options"></a><h2>Options</h2>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"> <code class="option">-t</code> | <code class="option">--terse</code> </span></p></td>
<td><p>Output is terse. This mode is designed and suitable for computer (script)
processing.</p></td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">-p</code> | <code class="option">--pretty</code> </span></p></td>
<td><p>Output is pretty. This causes <span class="command"><strong>nmcli</strong></span> to produce easily
readable outputs for humans, i.e. values are aligned, headers are printed,
etc.</p></td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">-m</code> | <code class="option">--mode</code> { tabular | multiline } </span></p></td>
<td>
<p>Switch between tabular and multiline output:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"> tabular </span></p></td>
<td><p>Output is a table where each line describes a single entry.
Columns define particular properties of the entry.</p></td>
</tr>
<tr>
<td><p><span class="term"> multiline </span></p></td>
<td><p>Each entry comprises multiple lines, each property on its
own line. The values are prefixed with the property name.</p></td>
</tr>
</tbody>
</table></div>
<p>If omitted, default is <code class="literal">tabular</code> for most commands.
For the commands producing more structured information, that cannot be
displayed on a single line, default is <code class="literal">multiline</code>.
Currently, they are:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p><code class="literal">nmcli connection show <em class="replaceable"><code>ID</code></em></code></p></li>
<li class="listitem"><p><code class="literal">nmcli device show</code></p></li>
</ul></div>
</td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">-c</code> | <code class="option">--colors</code> { yes | no | auto } </span></p></td>
<td><p>This option controls color output (using terminal escape sequences).
<code class="literal">yes</code> enables colors, <code class="literal">no</code> disables them,
<code class="literal">auto</code> only produces colors when standard output is directed
to a terminal. The default value is <code class="literal">auto</code>.</p></td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">-f</code> | <code class="option">--fields</code> { <em class="replaceable"><code>field1</code></em>,<em class="replaceable"><code>field2</code></em>... | all | common } </span></p></td>
<td>
<p>This option is used to specify what fields (column names) should be
printed. Valid field names differ for specific commands. List available fields
by providing an invalid value to the <code class="option">--fields</code> option.
<code class="literal">all</code> is used to print all valid field values of the
command. <code class="literal">common</code> is used to print common field values of
the command.</p>
<p>If omitted, default is <code class="literal">common</code>.</p>
</td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">-g</code> | <code class="option">--get-values</code> { <em class="replaceable"><code>field1</code></em>,<em class="replaceable"><code>field2</code></em>... | all | common } </span></p></td>
<td>
<p>This option is used to print values from specific fields. It is basically
a shortcut for <code class="literal">--mode tabular --terse --fields</code> and is a convenient
way to retrieve values for particular fields. The values are printed one per line
without headers.</p>
<p>If a section is specified instead of a field, the section name will be printed
followed by colon separated values of the fields belonging to that section, all on
the same line.</p>
</td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">-e</code> | <code class="option">--escape</code> { yes | no } </span></p></td>
<td>
<p>Whether to escape <code class="literal">:</code> and <code class="literal">\</code> characters in terse tabular mode. The
escape character is <code class="literal">\</code>.</p>
<p>If omitted, default is <code class="literal">yes</code>.</p>
</td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">-a</code> | <code class="option">--ask</code> </span></p></td>
<td><p>When using this option <span class="command"><strong>nmcli</strong></span> will stop and ask for any
missing required arguments, so do not use this option for non-interactive
purposes like scripts. This option controls, for example, whether you will be
prompted for a password if it is required for connecting to a network.</p></td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">-s</code> | <code class="option">--show-secrets</code> </span></p></td>
<td><p>When using this option <span class="command"><strong>nmcli</strong></span> will display passwords
and secrets that might be present in an output of an operation. This option
also influences echoing passwords typed by user as an input.</p></td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">-w</code> | <code class="option">--wait</code>
<em class="replaceable"><code>seconds</code></em>
</span></p></td>
<td>
<p>This option sets a timeout period for which <span class="command"><strong>nmcli</strong></span> will
wait for NetworkManager to finish operations. It is
especially useful for commands that may take a longer time to complete, e.g.
connection activation.</p>
<p>Specifying a value of <code class="literal">0</code> instructs
<span class="command"><strong>nmcli</strong></span> not to wait but to exit immediately with a status of
success. The default value depends on the executed command.</p>
</td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">--complete-args</code> </span></p></td>
<td>
<p>Instead of conducting the desired action, <span class="command"><strong>nmcli</strong></span>
will list possible completions for the last argument. This is useful to implement
argument completion in shell.</p>
<p>The <a class="link" href="nmcli.html#exit_status" title="Exit Status">exit status</a> will indicate success
or return a code 65 to indicate the last argument is a file name.</p>
<p>NetworkManager ships with command completion support for GNU Bash.</p>
</td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">-v</code> | <code class="option">--version</code> </span></p></td>
<td><p>Show <span class="command"><strong>nmcli</strong></span> version.</p></td>
</tr>
<tr>
<td><p><span class="term"> <code class="option">-h</code> | <code class="option">--help</code> </span></p></td>
<td><p>Print help information.</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="general"></a><h2>General Commands</h2>
<div class="cmdsynopsis"><p><code class="command">nmcli general</code> { <span class="command"><strong>status</strong></span> | <span class="command"><strong>hostname</strong></span> | <span class="command"><strong>permissions</strong></span> | <span class="command"><strong>logging</strong></span> } [<em class="replaceable"><code>ARGUMENTS</code></em>...]</p></div>
<p>Use this command to show NetworkManager status and permissions. You can also get
and change system hostname, as well as NetworkManager logging level and domains.</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><span class="command"><strong>status</strong></span></span></p></td>
<td><p>Show overall status of NetworkManager. This is the default action, when
no additional command is provided for <span class="command"><strong>nmcli general</strong></span>.</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>hostname</strong></span>
[<em class="replaceable"><code>hostname</code></em>]
</span></p></td>
<td>
<p>Get and change system hostname. With no arguments, this prints currently
configured hostname. When you pass a hostname, it will be handed over to
NetworkManager to be set as a new system hostname.</p>
<p>Note that the term "system" hostname may also be referred to as
"persistent" or "static" by other programs or tools. The hostname is stored
in <code class="filename">/etc/hostname</code> file in most distributions. For example,
systemd-hostnamed service uses the term "static" hostname and it only reads
the <code class="filename">/etc/hostname</code> file when it starts.</p>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="command"><strong>permissions</strong></span></span></p></td>
<td><p>Show the permissions a caller has for various authenticated operations
that NetworkManager provides, like enable and disable networking, changing
Wi-Fi and WWAN state, modifying connections, etc.</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>logging</strong></span>
[<code class="option">level</code> <em class="replaceable"><code>level</code></em>]
[<code class="option">domains</code> <em class="replaceable"><code>domains</code></em>...]
</span></p></td>
<td><p>Get and change NetworkManager logging level and
domains. Without any argument current logging level and domains are shown. In
order to change logging state, provide <code class="option">level</code> and, or,
<code class="option">domain</code> parameters. See
<a class="link" href="NetworkManager.conf.html" title="NetworkManager.conf"><span class="citerefentry"><span class="refentrytitle">NetworkManager.conf</span>(5)</span></a>
for available level and domain values.</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="networking"></a><h2>Networking Control Commands</h2>
<div class="cmdsynopsis"><p><code class="command">nmcli networking</code> { <span class="command"><strong>on</strong></span> | <span class="command"><strong>off</strong></span> | <span class="command"><strong>connectivity</strong></span> } [<em class="replaceable"><code>ARGUMENTS</code></em>...]</p></div>
<p>Query NetworkManager networking status, enable and disable networking.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><span class="command"><strong>on</strong></span>, </span><span class="term"><span class="command"><strong>off</strong></span></span></p></td>
<td><p>Enable or disable networking control by NetworkManager.
All interfaces managed by NetworkManager are deactivated when networking
is disabled.</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>connectivity</strong></span>
[check]
</span></p></td>
<td>
<p>Get network connectivity state. The optional <code class="option">check</code>
argument tells NetworkManager to re-check the connectivity, else the most
recent known connectivity state is displayed without re-checking.</p>
<p>Possible states are:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"> none </span></p></td>
<td><p>the host is not connected to any network.</p></td>
</tr>
<tr>
<td><p><span class="term"> portal </span></p></td>
<td><p>the host is behind a captive portal and cannot reach the full Internet.</p></td>
</tr>
<tr>
<td><p><span class="term"> limited </span></p></td>
<td><p>the host is connected to a network, but it has no access to the Internet.</p></td>
</tr>
<tr>
<td><p><span class="term"> full </span></p></td>
<td><p>the host is connected to a network and has full access to the Internet.</p></td>
</tr>
<tr>
<td><p><span class="term"> unknown </span></p></td>
<td><p>the connectivity status cannot be found out.</p></td>
</tr>
</tbody>
</table></div>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="radio"></a><h2>Radio Transmission Control Commands</h2>
<div class="cmdsynopsis"><p><code class="command">nmcli radio</code> { <span class="command"><strong>all</strong></span> | <span class="command"><strong>wifi</strong></span> | <span class="command"><strong>wwan</strong></span> } [<em class="replaceable"><code>ARGUMENTS</code></em>...]</p></div>
<p>Show radio switches status, or enable and disable the switches.</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">
<span class="command"><strong>wifi</strong></span>
[ on | off ]
</span></p></td>
<td><p>Show or set status of Wi-Fi in NetworkManager. If no arguments are
supplied, Wi-Fi status is printed; <code class="option">on</code> enables Wi-Fi;
<code class="option">off</code> disables Wi-Fi.</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>wwan</strong></span>
[ on | off ]
</span></p></td>
<td><p>Show or set status of WWAN (mobile broadband) in NetworkManager. If no
arguments are supplied, mobile broadband status is printed;
<code class="option">on</code> enables mobile broadband, <code class="option">off</code>
disables it.</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>all</strong></span>
[ on | off ]
</span></p></td>
<td><p>Show or set all previously mentioned radio switches at the same time.</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="monitor"></a><h2>Activity Monitor</h2>
<div class="cmdsynopsis"><p><code class="command">nmcli monitor</code> </p></div>
<p>Observe NetworkManager activity. Watches for changes
in connectivity state, devices or connection profiles.</p>
<p>See also <span class="command"><strong>nmcli connection monitor</strong></span>
and <span class="command"><strong>nmcli device monitor</strong></span> to watch
for changes in certain devices or connections.</p>
</div>
<div class="refsect1">
<a name="connection"></a><h2>Connection Management Commands</h2>
<div class="cmdsynopsis"><p><code class="command">nmcli connection</code> { <span class="command"><strong>show</strong></span> | <span class="command"><strong>up</strong></span> | <span class="command"><strong>down</strong></span> | <span class="command"><strong>modify</strong></span> | <span class="command"><strong>add</strong></span> | <span class="command"><strong>edit</strong></span> | <span class="command"><strong>clone</strong></span> | <span class="command"><strong>delete</strong></span> | <span class="command"><strong>monitor</strong></span> | <span class="command"><strong>reload</strong></span> | <span class="command"><strong>load</strong></span> | <span class="command"><strong>import</strong></span> | <span class="command"><strong>export</strong></span> } [<em class="replaceable"><code>ARGUMENTS</code></em>...]</p></div>
<p>NetworkManager stores all network configuration as "connections",
which are collections of data (Layer2 details, IP addressing, etc.) that
describe how to create or connect to a network. A connection is "active"
when a device uses that connection's configuration to create or connect to
a network. There may be multiple connections that apply to a device, but only
one of them can be active on that device at any given time. The additional
connections can be used to allow quick switching between different networks
and configurations.</p>
<p>Consider a machine which is usually connected to a DHCP-enabled network,
but sometimes connected to a testing network which uses static IP addressing.
Instead of manually reconfiguring eth0 each time the network is changed, the
settings can be saved as two connections which both apply to eth0, one for DHCP
(called <code class="literal">default</code>) and one with the static addressing details (called
<code class="literal">testing</code>). When connected to the DHCP-enabled network the user would run
<span class="command"><strong>nmcli con up default</strong></span> , and when connected to the static network the user
would run <span class="command"><strong>nmcli con up testing</strong></span>.</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">
<span class="command"><strong>show</strong></span>
[<code class="option">--active</code>]
[
<code class="option">--order</code>
[+-]<em class="replaceable"><code>category</code></em>:...
]
</span></p></td>
<td>
<p>List in-memory and on-disk connection profiles, some of which may also be
active if a device is using that connection profile. Without a parameter, all
profiles are listed. When <code class="option">--active</code> option is specified, only
the active profiles are shown.</p>
<p>The <code class="option">--order</code> option can be used to get custom
ordering of connections. The connections can be ordered by active status
(<code class="literal">active</code>), name (<code class="literal">name</code>), type
(<code class="literal">type</code>) or D-Bus path (<code class="literal">path</code>). If
connections are equal according to a sort order category, an additional
category can be specified. The default sorting order is equivalent to
<code class="literal">--order active:name:path</code>. <code class="literal">+</code> or no
prefix means sorting in ascending order (alphabetically or in numbers),
<code class="literal">-</code> means reverse (descending) order. The category names
can be abbreviated (e.g. <code class="literal">--order -a:na</code>).</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>show</strong></span>
[<code class="option">--active</code>]
[ <code class="option">id</code> | <code class="option">uuid</code> | <code class="option">path</code> | <code class="option">apath</code> ]
<em class="replaceable"><code>ID</code></em>...
</span></p></td>
<td>
<p>Show details for specified connections. By default, both static
configuration and active connection data are displayed. When
<code class="option">--active</code> option is specified, only the active profiles are
taken into account. Use global <code class="option">--show-secrets</code> option to
display secrets associated with the profile.</p>
<p><code class="option">id</code>, <code class="option">uuid</code>,
<code class="option">path</code> and <code class="option">apath</code> keywords can be used
if <em class="replaceable"><code>ID</code></em> is ambiguous. Optional
<em class="replaceable"><code>ID</code></em>-specifying keywords are:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="option">id</code></span></p></td>
<td><p>the <em class="replaceable"><code>ID</code></em> denotes a connection name.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">uuid</code></span></p></td>
<td><p>the <em class="replaceable"><code>ID</code></em> denotes a connection UUID.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">path</code></span></p></td>
<td><p>the <em class="replaceable"><code>ID</code></em> denotes a D-Bus
static connection path in the format of
/org/freedesktop/NetworkManager/Settings/<em class="replaceable"><code>num</code></em>
or just <em class="replaceable"><code>num</code></em>.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">apath</code></span></p></td>
<td><p>the <em class="replaceable"><code>ID</code></em> denotes a D-Bus active connection path in the format of
/org/freedesktop/NetworkManager/ActiveConnection/<em class="replaceable"><code>num</code></em> or just
<em class="replaceable"><code>num</code></em>.</p></td>
</tr>
</tbody>
</table></div>
<p>It is possible to filter the output using the global
<code class="option">--fields</code> option. Use the following values:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="option">profile</code></span></p></td>
<td><p>only shows static profile configuration.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">active</code></span></p></td>
<td><p>only shows active connection data (when the profile is active).</p></td>
</tr>
</tbody>
</table></div>
<p>You can also specify particular fields. For static configuration, use
setting and property names as described in
<span class="citerefentry"><span class="refentrytitle">nm-settings</span>(5)</span> manual page. For active data use GENERAL, IP4, DHCP4, IP6,
DHCP6, VPN.</p>
<p>When no command is given to the <span class="command"><strong>nmcli connection</strong></span>,
the default action is <span class="command"><strong>nmcli connection show</strong></span>.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>up</strong></span>
[ <code class="option">id</code> | <code class="option">uuid</code> | <code class="option">path</code> ]
<em class="replaceable"><code>ID</code></em>
[<code class="option">ifname</code> <em class="replaceable"><code>ifname</code></em>]
[<code class="option">ap</code> <em class="replaceable"><code>BSSID</code></em>]
[<code class="option">passwd-file</code> <em class="replaceable"><code>file</code></em>]
</span></p></td>
<td>
<p>Activate a connection. The connection is identified by its name, UUID or
D-Bus path. If <em class="replaceable"><code>ID</code></em> is ambiguous, a keyword <code class="option">id</code>,
<code class="option">uuid</code> or <code class="option">path</code> can be used. When
requiring a particular device to activate the connection on, the
<code class="option">ifname</code> option with interface name should be given. If the
<em class="replaceable"><code>ID</code></em> is not given an <code class="option">ifname</code> is required, and
NetworkManager will activate the best available connection for the given
<code class="option">ifname</code>. In case of a VPN connection, the
<code class="option">ifname</code> option specifies the device of the base connection.
The <code class="option">ap</code> option specify what particular AP should be used in
case of a Wi-Fi connection.</p>
<p>If <code class="option">--wait</code> option is not specified, the default timeout will be 90
seconds.</p>
<p>See <span class="command"><strong>connection show</strong></span> above for the description of the
<em class="replaceable"><code>ID</code></em>-specifying keywords.</p>
<p>Available options are:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="option">ifname</code></span></p></td>
<td><p>interface that will be used for activation.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">ap</code></span></p></td>
<td><p>BSSID of the AP which the command should connect to (for Wi-Fi connections).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">passwd-file</code></span></p></td>
<td>
<p>some networks may require credentials during activation. You can give
these credentials using this option. Each line of the file should contain one
password in the form:
</p>
<pre class="programlisting">setting_name.property_name:the password</pre>
<p>
For example, for WPA Wi-Fi with PSK, the line would be
</p>
<pre class="programlisting">802-11-wireless-security.psk:secret12345</pre>
<p>
For 802.1X password, the line would be
</p>
<pre class="programlisting">802-1x.password:my 1X password</pre>
<p>
<span class="command"><strong>nmcli</strong></span> also accepts <code class="literal">wifi-sec</code> and <code class="literal">wifi</code> strings instead of
<code class="literal">802-11-wireless-security</code>. When NetworkManager requires a password and it is
not given, <span class="command"><strong>nmcli</strong></span> will ask for it when run with <code class="option">--ask</code>.
If <code class="option">--ask</code> was not passed, NetworkManager can ask another secret
agent that may be running (typically a GUI secret agent, such as nm-applet or
gnome-shell).</p>
</td>
</tr>
</tbody>
</table></div>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>down</strong></span>
[ <code class="option">id</code> | <code class="option">uuid</code> | <code class="option">path</code> | <code class="option">apath</code> ]
<em class="replaceable"><code>ID</code></em>...
</span></p></td>
<td>
<p>Deactivate a connection from a device without preventing the device from
further auto-activation. Multiple connections can be passed to the
command.</p>
<p>Be aware that this command deactivates the specified active connection,
but the device on which the connection was active, is still ready to connect
and will perform auto-activation by looking for a suitable connection that has
the 'autoconnect' flag set. This includes the just deactivated connection. So
if the connection is set to auto-connect, it will be automatically started on
the disconnected device again.</p>
<p>In most cases you may want to use <span class="command"><strong>device disconnect</strong></span>
command instead.</p>
<p>The connection is identified by its name, UUID or D-Bus path. If
<em class="replaceable"><code>ID</code></em> is ambiguous, a keyword <code class="option">id</code>,
<code class="option">uuid</code>, <code class="option">path</code> or
<code class="option">apath</code> can be used.</p>
<p> See <span class="command"><strong>connection show</strong></span> above for the description of
the <em class="replaceable"><code>ID</code></em>-specifying keywords.</p>
<p>If <code class="option">--wait</code> option is not specified, the default timeout
will be 10 seconds.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>modify</strong></span>
[<code class="option">--temporary</code>]
[ <code class="option">id</code> | <code class="option">uuid</code> | <code class="option">path</code> ]
<em class="replaceable"><code>ID</code></em>
{ <em class="replaceable"><code>option</code></em> <em class="replaceable"><code>value</code></em> | [+|-]<em class="replaceable"><code>setting</code></em>.<em class="replaceable"><code>property</code></em> <em class="replaceable"><code>value</code></em> }
...
</span></p></td>
<td>
<p>Add, modify or remove properties in the connection profile.</p>
<p>To set the property just specify the property name followed by the
value. An empty value (<code class="literal">""</code>) removes the property value.</p>
<p>In addition to the properties, you can also use short names for some of
the properties. Consult the <a class="link" href="nmcli.html#property_aliases" title="Property Aliases">Property Aliases</a>
section for details.</p>
<p>If you want to append an item to the existing value, use
<code class="literal">+</code> prefix for the property name. If you want to remove just
one item from container-type property, use <code class="literal">-</code> prefix for
the property name and specify a value or an zero-based index of the item to
remove (or option name for properties with named options) as
<em class="replaceable"><code>value</code></em>. The <code class="literal">+</code> and <code class="literal">-</code>
modifies only have a real effect for multi-value (container)
properties like <code class="literal">ipv4.dns</code>, <code class="literal">ipv4.addresses</code>,
<code class="literal">bond.options</code>, etc.</p>
<p>See <span class="citerefentry"><span class="refentrytitle">nm-settings</span>(5)</span> for complete reference of setting and property names, their descriptions
and default values. The <em class="replaceable"><code>setting</code></em> and
<em class="replaceable"><code>property</code></em> can be abbreviated provided they are unique.</p>
<p>The connection is identified by its name, UUID or D-Bus path. If
<em class="replaceable"><code>ID</code></em> is ambiguous, a keyword <code class="option">id</code>,
<code class="option">uuid</code> or <code class="option">path</code> can be used.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>add</strong></span>
[<code class="option">save</code> { yes | no }]
{ <em class="replaceable"><code>option</code></em> <em class="replaceable"><code>value</code></em> | [+|-]<em class="replaceable"><code>setting</code></em>.<em class="replaceable"><code>property</code></em> <em class="replaceable"><code>value</code></em> }
...
</span></p></td>
<td>
<p>Create a new connection using specified properties.</p>
<p>You need to describe the newly created connections with the property and value pairs.
See <span class="citerefentry"><span class="refentrytitle">nm-settings</span>(5)</span> for the complete reference. You can also use the aliases described in
<a class="link" href="nmcli.html#property_aliases" title="Property Aliases">Property Aliases</a> section. The syntax is
the same as of the <span class="command"><strong>nmcli connection modify</strong></span> command.</p>
<p>To construct a meaningful connection you at the very least need to set the
<code class="option">connection.type</code> property (or use the <code class="option">type</code> alias)
to one of known NetworkManager connection types:</p>
<div class="itemizedlist"><ul class="itemizedlist compact" style="list-style-type: disc; ">
<li class="listitem"><p><code class="literal">ethernet</code></p></li>
<li class="listitem"><p><code class="literal">wifi</code></p></li>
<li class="listitem"><p><code class="literal">wimax</code></p></li>
<li class="listitem"><p><code class="literal">pppoe</code></p></li>
<li class="listitem"><p><code class="literal">gsm</code></p></li>
<li class="listitem"><p><code class="literal">cdma</code></p></li>
<li class="listitem"><p><code class="literal">infiniband</code></p></li>
<li class="listitem"><p><code class="literal">bluetooth</code></p></li>
<li class="listitem"><p><code class="literal">vlan</code></p></li>
<li class="listitem"><p><code class="literal">bond</code></p></li>
<li class="listitem"><p><code class="literal">bond-slave</code></p></li>
<li class="listitem"><p><code class="literal">team</code></p></li>
<li class="listitem"><p><code class="literal">team-slave</code></p></li>
<li class="listitem"><p><code class="literal">bridge</code></p></li>
<li class="listitem"><p><code class="literal">bridge-slave</code></p></li>
<li class="listitem"><p><code class="literal">vpn</code></p></li>
<li class="listitem"><p><code class="literal">olpc-mesh</code></p></li>
<li class="listitem"><p><code class="literal">adsl</code></p></li>
<li class="listitem"><p><code class="literal">tun</code></p></li>
<li class="listitem"><p><code class="literal">ip-tunnel</code></p></li>
<li class="listitem"><p><code class="literal">macvlan</code></p></li>
<li class="listitem"><p><code class="literal">vxlan</code></p></li>
<li class="listitem"><p><code class="literal">dummy</code></p></li>
</ul></div>
<p>The most typical uses are described in the <a class="link" href="nmcli.html#examples" title="Examples">Examples</a> section.</p>
<p>Aside from the properties and values two special options are accepted:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="option">save</code></span></p></td>
<td><p>Controls whether the connection should be persistent, i.e. NetworkManager should
store it on disk (default: <code class="literal">yes</code>).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">--</code></span></p></td>
<td><p>If a single <code class="option">--</code> argument is encountered it is ignored.
This is for compatibility with older versions on <span class="command"><strong>nmcli</strong></span>.</p></td>
</tr>
</tbody>
</table></div>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>edit</strong></span>
{
[ <code class="option">id</code> | <code class="option">uuid</code> | <code class="option">path</code> ]
<em class="replaceable"><code>ID</code></em>
|
[<code class="option">type</code> <em class="replaceable"><code>type</code></em>]
[<code class="option">con-name</code> <em class="replaceable"><code>name</code></em>]
}
</span></p></td>
<td>
<p>Edit an existing connection or add a new one, using an interactive editor.</p>
<p>The existing connection is identified by its name, UUID or D-Bus path. If
<em class="replaceable"><code>ID</code></em> is ambiguous, a keyword <code class="option">id</code>,
<code class="option">uuid</code>, or <code class="option">path</code> can be used. See
<span class="command"><strong>connection show</strong></span> above for the description of the
<em class="replaceable"><code>ID</code></em>-specifying keywords. Not providing an
<em class="replaceable"><code>ID</code></em> means that a new connection will be added.</p>
<p>The interactive editor will guide you through the connection editing and
allow you to change connection parameters according to your needs by means of
a simple menu-driven interface. The editor indicates what settings and
properties can be modified and provides in-line help.</p>
<p>Available options:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="option">type</code></span></p></td>
<td><p>type of the new connection; valid types are the same as for
<span class="command"><strong>connection add</strong></span> command.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">con-name</code></span></p></td>
<td><p>name for the new connection. It can be changed later in the editor.</p></td>
</tr>
</tbody>
</table></div>
<p>See also
<span class="citerefentry"><span class="refentrytitle">nm-settings</span>(5)</span> for all NetworkManager settings and property names, and their
descriptions; and
<a class="link" href="nmcli-examples.html" title="nmcli-examples"><span class="citerefentry"><span class="refentrytitle">nmcli-examples</span>(7)</span></a>
for sample editor sessions.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>clone</strong></span>
[<code class="option">--temporary</code>]
[ <code class="option">id</code> | <code class="option">uuid</code> | <code class="option">path</code> ]
<em class="replaceable"><code>ID</code></em>
<em class="replaceable"><code>new_name</code></em>
</span></p></td>
<td>
<p>Clone a connection. The connection to be cloned is identified by its
name, UUID or D-Bus path. If <em class="replaceable"><code>ID</code></em> is ambiguous, a keyword
<code class="option">id</code>, <code class="option">uuid</code> or <code class="option">path</code>
can be used. See <span class="command"><strong>connection show</strong></span> above for the description
of the <em class="replaceable"><code>ID</code></em>-specifying keywords. <em class="replaceable"><code>new_name</code></em> is
the name of the new cloned connection. The new connection will be the exact
copy except the connection.id (<em class="replaceable"><code>new_name</code></em>) and
connection.uuid (generated) properties.</p>
<p>The new connection profile will be saved as persistent unless
<code class="option">--temporary</code> option is specified, in which case the new profile
won't exist after NetworkManager restart.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>delete</strong></span>
[ <code class="option">id</code> | <code class="option">uuid</code> | <code class="option">path</code> ]
<em class="replaceable"><code>ID</code></em>...
</span></p></td>
<td>
<p>Delete a configured connection. The connection to be deleted is
identified by its name, UUID or D-Bus path. If <em class="replaceable"><code>ID</code></em> is ambiguous, a
keyword <code class="option">id</code>, <code class="option">uuid</code> or <code class="option">path</code> can be used.
See <span class="command"><strong>connection show</strong></span> above for the description of
the <em class="replaceable"><code>ID</code></em>-specifying keywords.</p>
<p>If <code class="option">--wait</code> option is not specified, the default timeout will be 10
seconds.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>monitor</strong></span>
[ <code class="option">id</code> | <code class="option">uuid</code> | <code class="option">path</code> ]
<em class="replaceable"><code>ID</code></em>...
</span></p></td>
<td>
<p>Monitor connection profile activity. This command prints a line whenever
the specified connection changes. The connection to be monitored is identified
by its name, UUID or D-Bus path. If <em class="replaceable"><code>ID</code></em> is ambiguous, a keyword
<code class="option">id</code>, <code class="option">uuid</code> or <code class="option">path</code>
can be used. See <span class="command"><strong>connection show</strong></span> above for the description of the
<em class="replaceable"><code>ID</code></em>-specifying keywords.</p>
<p>Monitors all connection profiles in case none is specified. The command
terminates when all monitored connections disappear. If you want to monitor
connection creation consider using the global monitor with <span class="command"><strong>nmcli
monitor</strong></span> command.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>reload</strong></span>
</span></p></td>
<td><p>Reload all connection files from disk.
NetworkManager does not monitor changes to connection
files by default. So you need to use this command in order to tell
NetworkManager to re-read the connection profiles from
disk when a change was made to them. However, the auto-loading feature can be
enabled and then NetworkManager will reload connection
files any time they change (monitor-connection-files=true in
<a class="link" href="NetworkManager.conf.html" title="NetworkManager.conf"><span class="citerefentry"><span class="refentrytitle">NetworkManager.conf</span>(5)</span></a>).
</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>load</strong></span>
<em class="replaceable"><code>filename</code></em>...
</span></p></td>
<td><p>Load/reload one or more connection files from disk. Use this after
manually editing a connection file to ensure that
NetworkManager is aware of its latest state.</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>import</strong></span>
[<code class="option">--temporary</code>]
<code class="option">type</code> <em class="replaceable"><code>type</code></em>
<code class="option">file</code> <em class="replaceable"><code>file</code></em>
</span></p></td>
<td>
<p>Import an external/foreign configuration as a NetworkManager connection
profile. The type of the input file is specified by <code class="option">type</code>
option.</p>
<p>Only VPN configurations are supported at the moment. The configuration is
imported by NetworkManager VPN plugins. <code class="option">type</code> values are
the same as for <code class="option">vpn-type</code> option in <span class="command"><strong>nmcli
connection add</strong></span>. VPN configurations are imported by VPN plugins.
Therefore the proper VPN plugin has to be installed so that <span class="command"><strong>nmcli</strong></span> could import
the data.</p>
<p>The imported connection profile will be saved as persistent unless
<code class="option">--temporary</code> option is specified, in which case the new profile
won't exist after NetworkManager restart.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>export</strong></span>
[ <code class="option">id</code> | <code class="option">uuid</code> | <code class="option">path</code> ]
<em class="replaceable"><code>ID</code></em>
[<em class="replaceable"><code>file</code></em>]
</span></p></td>
<td>
<p>Export a connection.</p>
<p>Only VPN connections are supported at the moment. A proper VPN plugin has
to be installed so that <span class="command"><strong>nmcli</strong></span> could export a connection. If no
<em class="replaceable"><code>file</code></em> is provided, the VPN configuration
data will be printed to standard output.</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="device"></a><h2>Device Management Commands</h2>
<div class="cmdsynopsis"><p><code class="command">nmcli device</code> { <span class="command"><strong>status</strong></span> | <span class="command"><strong>show</strong></span> | <span class="command"><strong>set</strong></span> | <span class="command"><strong>connect</strong></span> | <span class="command"><strong>reapply</strong></span> | <span class="command"><strong>modify</strong></span> | <span class="command"><strong>disconnect</strong></span> | <span class="command"><strong>delete</strong></span> | <span class="command"><strong>monitor</strong></span> | <span class="command"><strong>wifi</strong></span> | <span class="command"><strong>lldp</strong></span> } [<em class="replaceable"><code>ARGUMENTS</code></em>...]</p></div>
<p>Show and manage network interfaces.</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><span class="command"><strong>status</strong></span></span></p></td>
<td>
<p>Print status of devices.</p>
<p>This is the default action if no command is specified to
<span class="command"><strong>nmcli device</strong></span>.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>show</strong></span>
[<em class="replaceable"><code>ifname</code></em>]
</span></p></td>
<td><p>Show detailed information about devices. Without an argument, all
devices are examined. To get information for a specific device, the interface
name has to be provided.</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>set</strong></span>
[ifname]
<em class="replaceable"><code>ifname</code></em>
[
<code class="option">autoconnect</code>
{ yes | no }
]
[
<code class="option">managed</code>
{ yes | no }
]
</span></p></td>
<td><p>Set device properties.</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>connect</strong></span>
<em class="replaceable"><code>ifname</code></em>
</span></p></td>
<td>
<p>Connect the device. NetworkManager will try to find a suitable connection
that will be activated. It will also consider connections that are not set to
auto connect.</p>
<p>If <code class="option">--wait</code> option is not specified, the default timeout will be 90
seconds.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>reapply</strong></span>
<em class="replaceable"><code>ifname</code></em>
</span></p></td>
<td><p>Attempt to update device with changes to the currently active connection
made since it was last applied.</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>modify</strong></span>
<em class="replaceable"><code>ifname</code></em>
{ <em class="replaceable"><code>option</code></em> <em class="replaceable"><code>value</code></em> | [+|-]<em class="replaceable"><code>setting</code></em>.<em class="replaceable"><code>property</code></em> <em class="replaceable"><code>value</code></em> }
...
</span></p></td>
<td>
<p>Modify the settings currently active on the device.</p>
<p>This command lets you do temporary changes to a configuration active on
a particular device. The changes are not preserved in the connection profile.</p>
<p>See <span class="citerefentry"><span class="refentrytitle">nm-settings</span>(5)</span> for the list of available properties. Please note that some
properties can't be changed on an already connected device.</p>
<p>You can also use the aliases described in
<a class="link" href="nmcli.html#property_aliases" title="Property Aliases">Property Aliases</a> section. The syntax is
the same as of the <span class="command"><strong>nmcli connection modify</strong></span> command.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>disconnect</strong></span>
<em class="replaceable"><code>ifname</code></em>...
</span></p></td>
<td>
<p>Disconnect a device and prevent the device from automatically activating
further connections without user/manual intervention. Note that disconnecting
software devices may mean that the devices will disappear.</p>
<p>If <code class="option">--wait</code> option is not specified, the default timeout
will be 10 seconds.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>delete</strong></span>
<em class="replaceable"><code>ifname</code></em>...
</span></p></td>
<td>
<p>Delete a device. The command removes the interface from the system. Note
that this only works for software devices like bonds, bridges, teams, etc.
Hardware devices (like Ethernet) cannot be deleted by the command.</p>
<p>If <code class="option">--wait</code> option is not specified, the default timeout will be 10
seconds.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>monitor</strong></span>
[<em class="replaceable"><code>ifname</code></em>...]
</span></p></td>
<td>
<p>Monitor device activity. This command prints a line whenever the
specified devices change state.</p>
<p>Monitors all devices in case no interface is specified. The monitor
terminates when all specified devices disappear. If you want to monitor device
addition consider using the global monitor with <span class="command"><strong>nmcli
monitor</strong></span> command.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>wifi</strong></span>
[
<span class="command"><strong>list</strong></span>
[<code class="option">ifname</code> <em class="replaceable"><code>ifname</code></em>]
[<code class="option">bssid</code> <em class="replaceable"><code>BSSID</code></em>]
]
</span></p></td>
<td><p>List available Wi-Fi access points. The <code class="option">ifname</code> and
<code class="option">bssid</code> options can be used to list APs for a particular
interface or with a specific BSSID, respectively.</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>wifi</strong></span>
<span class="command"><strong>connect</strong></span>
<em class="replaceable"><code>(B)SSID</code></em>
[<code class="option">password</code> <em class="replaceable"><code>password</code></em>]
[
<code class="option">wep-key-type</code>
{ key | phrase }
]
[<code class="option">ifname</code> <em class="replaceable"><code>ifname</code></em>]
[<code class="option">bssid</code> <em class="replaceable"><code>BSSID</code></em>]
[<code class="option">name</code> <em class="replaceable"><code>name</code></em>]
[
<code class="option">private</code>
{ yes | no }
]
[
<code class="option">hidden</code>
{ yes | no }
]
</span></p></td>
<td>
<p>Connect to a Wi-Fi network specified by SSID or BSSID. The command
creates a new connection and then activates it on a device. This is a
command-line counterpart of clicking an SSID in a GUI client. The command
always creates a new connection and thus it is mainly useful for connecting to
new Wi-Fi networks. If a connection for the network already exists, it is
better to bring up (activate) the existing connection as follows:
<span class="command"><strong>nmcli con up id <em class="replaceable"><code>name</code></em></strong></span>. Note that
only open, WEP and WPA-PSK networks are supported at the moment. It is also
supposed that IP configuration is obtained via DHCP.</p>
<p>If <code class="option">--wait</code> option is not specified, the default timeout will be 90
seconds.</p>
<p>Available options are:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="option">password</code></span></p></td>
<td><p>password for secured networks (WEP or WPA).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">wep-key-type</code></span></p></td>
<td><p>type of WEP secret, either <code class="option">key</code> for ASCII/HEX key or
<code class="option">phrase</code> for passphrase.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">ifname</code></span></p></td>
<td><p>interface that will be used for activation.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">bssid</code></span></p></td>
<td><p>if specified, the created connection will be restricted just for the
BSSID.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">name</code></span></p></td>
<td><p>if specified, the connection will use the name (else NM creates a name
itself).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">private</code></span></p></td>
<td><p>if set to <code class="literal">yes</code>, the connection will only be visible
to the user who created it. Otherwise the connection is system-wide, which is
the default.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">hidden</code></span></p></td>
<td><p>set to <code class="literal">yes</code> when connecting for the first time to an
AP not broadcasting its SSID. Otherwise the SSID would not be found and the
connection attempt would fail.</p></td>
</tr>
</tbody>
</table></div>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>wifi</strong></span>
<span class="command"><strong>hotspot</strong></span>
[<code class="option">ifname</code> <em class="replaceable"><code>ifname</code></em>]
[<code class="option">con-name</code> <em class="replaceable"><code>name</code></em>]
[<code class="option">ssid</code> <em class="replaceable"><code>SSID</code></em>]
[
<code class="option">band</code>
{ a | bg }
]
[<code class="option">channel</code> <em class="replaceable"><code>channel</code></em>]
[<code class="option">password</code> <em class="replaceable"><code>password</code></em>]
</span></p></td>
<td>
<p>Create a Wi-Fi hotspot. The command creates a hotspot connection profile
according to Wi-Fi device capabilities and activates it on the device. The
hotspot is secured with WPA if device/driver supports that, otherwise WEP is
used. Use <span class="command"><strong>connection down</strong></span> or <span class="command"><strong>device
disconnect</strong></span> to stop the hotspot.</p>
<p>Parameters of the hotspot can be influenced by the optional
parameters:</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="option">ifname</code></span></p></td>
<td><p>what Wi-Fi device is used.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">con-name</code></span></p></td>
<td><p>name of the created hotspot connection profile.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">ssid</code></span></p></td>
<td><p>SSID of the hotspot.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">band</code></span></p></td>
<td><p>Wi-Fi band to use.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">channel</code></span></p></td>
<td><p>Wi-Fi channel to use.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="option">password</code></span></p></td>
<td>
<p>password to use for the created hotspot. If not provided, <span class="command"><strong>nmcli</strong></span> will
generate a password. The password is either WPA pre-shared key or WEP
key.</p>
<p>Note that <code class="option">--show-secrets</code> global option can be used to
print the hotspot password. It is useful especially when the password was
generated.</p>
</td>
</tr>
</tbody>
</table></div>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>wifi</strong></span>
<span class="command"><strong>rescan</strong></span>
[<code class="option">ifname</code> <em class="replaceable"><code>ifname</code></em>]
[<code class="option">ssid</code> <em class="replaceable"><code>SSID</code></em>...]
</span></p></td>
<td>
<p>Request that NetworkManager immediately re-scan for
available access points. NetworkManager scans Wi-Fi networks periodically, but
in some cases it can be useful to start scanning manually (e.g. after resuming
the computer). By using <code class="option">ssid</code>, it is possible to scan for a
specific SSID, which is useful for APs with hidden SSIDs. You can provide
multiple <code class="option">ssid</code> parameters in order to scan more
SSIDs.</p>
<p>This command does not show the APs, use <span class="command"><strong>nmcli device wifi list</strong></span>
for that.</p>
</td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>lldp</strong></span>
[
<span class="command"><strong>list</strong></span>
[<code class="option">ifname</code> <em class="replaceable"><code>ifname</code></em>]
]
</span></p></td>
<td><p>Display information about neighboring devices learned through the Link
Layer Discovery Protocol (LLDP). The <code class="option">ifname</code> option can be
used to list neighbors only for a given interface. The protocol must be enabled
in the connection settings.</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="agent"></a><h2>Secret Agent</h2>
<div class="cmdsynopsis"><p><code class="command">nmcli agent</code> { <span class="command"><strong>secret</strong></span> | <span class="command"><strong>polkit</strong></span> | <span class="command"><strong>all</strong></span> }</p></div>
<p>Run <span class="command"><strong>nmcli</strong></span> as a NetworkManager secret agent, or polkit agent.</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><span class="command"><strong>secret</strong></span></span></p></td>
<td><p>Register <span class="command"><strong>nmcli</strong></span> as a NetworkManager secret agent and listen for secret
requests. You do usually not need this command, because <span class="command"><strong>nmcli</strong></span> can handle
secrets when connecting to networks. However, you may find the command useful
when you use another tool for activating connections and you do not have a
secret agent available (like nm-applet).</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>polkit</strong></span>
</span></p></td>
<td><p>Register <span class="command"><strong>nmcli</strong></span> as a polkit agent for the user session and listen for
authorization requests. You do not usually need this command, because <span class="command"><strong>nmcli</strong></span> can
handle polkit actions related to NetworkManager operations (when run with
<code class="option">--ask</code>). However, you may find the command useful when you want
to run a simple text based polkit agent and you do not have an agent of a desktop
environment. Note that running this command makes <span class="command"><strong>nmcli</strong></span> handle all polkit requests,
not only NetworkManager related ones, because only one polkit agent can run for the
session.</p></td>
</tr>
<tr>
<td><p><span class="term">
<span class="command"><strong>all</strong></span>
</span></p></td>
<td><p>Runs <span class="command"><strong>nmcli</strong></span> as both NetworkManager secret and a polkit agent.</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="property_aliases"></a><h2>Property Aliases</h2>
<p>Apart from the property-value pairs, <span class="command"><strong>connection add</strong></span>,
<span class="command"><strong>connection modify</strong></span> and <span class="command"><strong>device modify</strong></span> also
accept short forms of some properties. They exist for convenience. Some aliases can
affect multiple connection properties at once.</p>
<p>The overview of the aliases is below. An actual connection type is used to
disambiguate these options from the options of the same name that are valid for
multiple connection types (such as <code class="option">mtu</code>).</p>
<div class="table">
<a name="id-1.2.4.14.4"></a><p class="title"><b>Table 1. Options for all connections</b></p>
<div class="table-contents"><table class="table" summary="Options for all connections" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
<th>Note</th>
</tr></thead>
<tbody>
<tr>
<td align="left">type</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.connection.type">connection.type</a></td>
<td align="left" valign="top">This alias also accepts values of <code class="option">bond-slave</code>,
<code class="option">team-slave</code> and <code class="option">bridge-slave</code>. They create
<code class="option">ethernet</code> connection profiles. Their use is discouraged in
favor of using a specific type with <code class="option">master</code> option.</td>
</tr>
<tr>
<td align="left">con-name</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.connection.id">connection.id</a></td>
<td align="left" valign="top">When not provided a default name is generated: <type>[-<ifname>][-<num>]).</td>
</tr>
<tr>
<td align="left">autoconnect</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.connection.autoconnect">connection.autoconnect</a></td>
<td align="left"> </td>
</tr>
<tr>
<td align="left">ifname</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.connection.interface-name">connection.interface-name</a></td>
<td align="left" valign="top">A value of <code class="literal">*</code> will be interpreted as
no value, making the connection profile interface-independent.
Note: use quotes around <code class="literal">*</code> to suppress shell expansion.
For bond, team and bridge connections a default name will be generated if not set.</td>
</tr>
<tr>
<td align="left">master</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.connection.master">connection.master</a></td>
<td align="left" valign="top">Value specified here will be canonicalized.
It can be prefixed with <code class="literal">ifname/</code>, <code class="literal">uuid/</code>
or <code class="literal">id/</code> to disambiguate it.</td>
</tr>
<tr>
<td align="left">slave-type</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.connection.slave-type">connection.slave-type</a></td>
<td align="left"> </td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.5"></a><p class="title"><b>Table 2. PPPoE options</b></p>
<div class="table-contents"><table class="table" summary="PPPoE options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">username</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.pppoe.username">pppoe.username</a></td>
</tr>
<tr>
<td align="left">password</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.pppoe.password">pppoe.password</a></td>
</tr>
<tr>
<td align="left">service</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.pppoe.service">pppoe.service</a></td>
</tr>
<tr>
<td align="left">parent</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.pppoe.parent">pppoe.parent</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.6"></a><p class="title"><b>Table 3. Wired Ethernet options</b></p>
<div class="table-contents"><table class="table" summary="Wired Ethernet options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">mtu</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.802-3-ethernet.mtu">wired.mtu</a></td>
</tr>
<tr>
<td align="left">mac</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.802-3-ethernet.mac-address">wired.mac-address</a></td>
</tr>
<tr>
<td align="left">cloned-mac</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.802-3-ethernet.cloned-mac-address">wired.cloned-mac-address</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.7"></a><p class="title"><b>Table 4. Infiniband options</b></p>
<div class="table-contents"><table class="table" summary="Infiniband options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">mtu</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.infiniband.mtu">infiniband.mtu</a></td>
</tr>
<tr>
<td align="left">mac</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.infiniband.mac-address">infiniband.mac-address</a></td>
</tr>
<tr>
<td align="left">transport-mode</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.infiniband.transport-mode">infiniband.transport-mode</a></td>
</tr>
<tr>
<td align="left">parent</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.infiniband.parent">infiniband.parent</a></td>
</tr>
<tr>
<td align="left">p-key</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.infiniband.p-key">infiniband.p-key</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.8"></a><p class="title"><b>Table 5. Wi-Fi options</b></p>
<div class="table-contents"><table class="table" summary="Wi-Fi options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">ssid</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.802-11-wireless.ssid">wireless.ssid</a></td>
</tr>
<tr>
<td align="left">mode</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.802-11-wireless.mode">wireless.mode</a></td>
</tr>
<tr>
<td align="left">mtu</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.802-11-wireless.mtu">wireless.mtu</a></td>
</tr>
<tr>
<td align="left">mac</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.802-11-wireless.mac-address">wireless.mac-address</a></td>
</tr>
<tr>
<td align="left">cloned-mac</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.802-11-wireless.cloned-mac-address">wireless.cloned-mac-address</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.9"></a><p class="title"><b>Table 6. WiMax options</b></p>
<div class="table-contents"><table class="table" summary="WiMax options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">nsp</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.wimax.network-name">wimax.network-name</a></td>
</tr>
<tr>
<td align="left">mac</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.wimax.mac-address">wimax.mac-address</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.10"></a><p class="title"><b>Table 7. GSM options</b></p>
<div class="table-contents"><table class="table" summary="GSM options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">apn</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.gsm.apn">gsm.apn</a></td>
</tr>
<tr>
<td align="left">user</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.gsm.username">gsm.username</a></td>
</tr>
<tr>
<td align="left">password</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.gsm.password">gsm.password</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.11"></a><p class="title"><b>Table 8. CDMA options</b></p>
<div class="table-contents"><table class="table" summary="CDMA options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">user</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.cdma.username">cdma.username</a></td>
</tr>
<tr>
<td align="left">password</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.cdma.password">cdma.password</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.12"></a><p class="title"><b>Table 9. Bluetooth options</b></p>
<div class="table-contents"><table class="table" summary="Bluetooth options" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
<th>Note</th>
</tr></thead>
<tbody>
<tr>
<td align="left">addr</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bluetooth.bdaddr">bluetooth.bdaddr</a></td>
<td align="left"> </td>
</tr>
<tr>
<td align="left">bt-type</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bluetooth.type">bluetooth.type</a></td>
<td align="left" valign="top">Apart from the usual <code class="literal">panu</code>,
<code class="literal">nap</code> and <code class="literal">dun</code> options, the values of
<code class="literal">dun-gsm</code> and <code class="literal">dun-cdma</code> can be used for compatibility
with older versions. They are equivalent to using <code class="literal">dun</code> and setting
appropriate <code class="literal">gsm.*</code> or <code class="literal">cdma.*</code> properties.</td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.13"></a><p class="title"><b>Table 10. VLAN options</b></p>
<div class="table-contents"><table class="table" summary="VLAN options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">dev</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vlan.parent">vlan.parent</a></td>
</tr>
<tr>
<td align="left">id</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vlan.id">vlan.id</a></td>
</tr>
<tr>
<td align="left">flags</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vlan.flags">vlan.flags</a></td>
</tr>
<tr>
<td align="left">ingress</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vlan.ingress-priority-map">vlan.ingress-priority-map</a></td>
</tr>
<tr>
<td align="left">egress</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vlan.egress-priority-map">vlan.egress-priority-map</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.14"></a><p class="title"><b>Table 11. Bonding options</b></p>
<div class="table-contents"><table class="table" summary="Bonding options" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
<th>Note</th>
</tr></thead>
<tbody>
<tr>
<td align="left">mode</td>
<td rowspan="8" align="left">bond.options</td>
<td rowspan="8" align="left" valign="top">Setting each of these adds the option to <code class="literal">bond.options</code> property.
It's equivalent to the <code class="literal">+bond.options 'option=value'</code> syntax.</td>
</tr>
<tr><td align="left">primary</td></tr>
<tr><td align="left">miimon</td></tr>
<tr><td align="left">downdelay</td></tr>
<tr><td align="left">updelay</td></tr>
<tr><td align="left">arp-interval</td></tr>
<tr><td align="left">arp-ip-target</td></tr>
<tr><td align="left">lacp-rate</td></tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.15"></a><p class="title"><b>Table 12. Team options</b></p>
<div class="table-contents"><table class="table" summary="Team options" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
<th>Note</th>
</tr></thead>
<tbody><tr>
<td align="left">config</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.team.config">team.config</a></td>
<td align="left">Either a filename or a team configuration in JSON format. To enforce one or the other, the value can be prefixed with "file://" or "json://".</td>
</tr></tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.16"></a><p class="title"><b>Table 13. Team port options</b></p>
<div class="table-contents"><table class="table" summary="Team port options" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
<th>Note</th>
</tr></thead>
<tbody><tr>
<td align="left">config</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.team-port.config">team-port.config</a></td>
<td align="left">Either a filename or a team configuration in JSON format. To enforce one or the other, the value can be prefixed with "file://" or "json://".</td>
</tr></tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.17"></a><p class="title"><b>Table 14. Bridge options</b></p>
<div class="table-contents"><table class="table" summary="Bridge options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">stp</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge.stp">bridge.stp</a></td>
</tr>
<tr>
<td align="left">priority</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge.priority">bridge.priority</a></td>
</tr>
<tr>
<td align="left">forward-delay</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge.forward-delay">bridge.forward-delay</a></td>
</tr>
<tr>
<td align="left">hello-time</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge.hello-time">bridge.hello-time</a></td>
</tr>
<tr>
<td align="left">max-age</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge.max-age">bridge.max-age</a></td>
</tr>
<tr>
<td align="left">ageing-time</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge.ageing-time">bridge.ageing-time</a></td>
</tr>
<tr>
<td align="left">group-forward-mask</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge.group-forward-mask">bridge.group-forward-mask</a></td>
</tr>
<tr>
<td align="left">multicast-snooping</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge.multicast-snooping">bridge.multicast-snooping</a></td>
</tr>
<tr>
<td align="left">mac</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge.mac-address">bridge.mac-address</a></td>
</tr>
<tr>
<td align="left">priority</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge-port.priority">bridge-port.priority</a></td>
</tr>
<tr>
<td align="left">path-cost</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge-port.path-cost">bridge-port.path-cost</a></td>
</tr>
<tr>
<td align="left">hairpin</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.bridge-port.hairpin-mode">bridge-port.hairpin-mode</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.18"></a><p class="title"><b>Table 15. VPN options</b></p>
<div class="table-contents"><table class="table" summary="VPN options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">vpn-type</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vpn.service-type">vpn.service-type</a></td>
</tr>
<tr>
<td align="left">user</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vpn.user-name">vpn.user-name</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.19"></a><p class="title"><b>Table 16. OLPC Mesh options</b></p>
<div class="table-contents"><table class="table" summary="OLPC Mesh options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">ssid</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.802-11-olpc-mesh.ssid">olpc-mesh.ssid</a></td>
</tr>
<tr>
<td align="left">channel</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.802-11-olpc-mesh.channel">olpc-mesh.channel</a></td>
</tr>
<tr>
<td align="left">dhcp-anycast</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.802-11-olpc-mesh.dhcp-anycast-address">olpc-mesh.dhcp-anycast-address</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.20"></a><p class="title"><b>Table 17. ADSL options</b></p>
<div class="table-contents"><table class="table" summary="ADSL options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">username</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.adsl.username">adsl.username</a></td>
</tr>
<tr>
<td align="left">protocol</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.adsl.protocol">adsl.protocol</a></td>
</tr>
<tr>
<td align="left">password</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.adsl.password">adsl.password</a></td>
</tr>
<tr>
<td align="left">encapsulation</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.adsl.encapsulation">adsl.encapsulation</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.21"></a><p class="title"><b>Table 18. MACVLAN options</b></p>
<div class="table-contents"><table class="table" summary="MACVLAN options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">dev</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.macvlan.parent">macvlan.parent</a></td>
</tr>
<tr>
<td align="left">mode</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.macvlan.mode">macvlan.mode</a></td>
</tr>
<tr>
<td align="left">tap</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.macvlan.tap">macvlan.tap</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.22"></a><p class="title"><b>Table 19. MACsec options</b></p>
<div class="table-contents"><table class="table" summary="MACsec options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">dev</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.macsec.parent">macsec.parent</a></td>
</tr>
<tr>
<td align="left">mode</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.macsec.mode">macsec.mode</a></td>
</tr>
<tr>
<td align="left">encrypt</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.macsec.encrypt">macsec.encrypt</a></td>
</tr>
<tr>
<td align="left">cak</td>
<td align="left">macsec.cak</td>
</tr>
<tr>
<td align="left">ckn</td>
<td align="left">macsec.ckn</td>
</tr>
<tr>
<td align="left">port</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.macsec.port">macsec.port</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.23"></a><p class="title"><b>Table 20. VxLAN options</b></p>
<div class="table-contents"><table class="table" summary="VxLAN options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">id</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vxlan.id">vxlan.id</a></td>
</tr>
<tr>
<td align="left">remote</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vxlan.remote">vxlan.remote</a></td>
</tr>
<tr>
<td align="left">dev</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vxlan.parent">vxlan.parent</a></td>
</tr>
<tr>
<td align="left">local</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vxlan.local">vxlan.local</a></td>
</tr>
<tr>
<td align="left">source-port-min</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vxlan.source-port-min">vxlan.source-port-min</a></td>
</tr>
<tr>
<td align="left">source-port-max</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vxlan.source-port-max">vxlan.source-port-max</a></td>
</tr>
<tr>
<td align="left">destination-port</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.vxlan.destination-port">vxlan.destination-port</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.24"></a><p class="title"><b>Table 21. Tun options</b></p>
<div class="table-contents"><table class="table" summary="Tun options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">mode</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.tun.mode">tun.mode</a></td>
</tr>
<tr>
<td align="left">owner</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.tun.owner">tun.owner</a></td>
</tr>
<tr>
<td align="left">group</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.tun.group">tun.group</a></td>
</tr>
<tr>
<td align="left">pi</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.tun.pi">tun.pi</a></td>
</tr>
<tr>
<td align="left">vnet-hdr</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.tun.vnet-hdr">tun.vnet-hdr</a></td>
</tr>
<tr>
<td align="left">multi-queue</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.tun.multi-queue">tun.multi-queue</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.25"></a><p class="title"><b>Table 22. IP tunneling options</b></p>
<div class="table-contents"><table class="table" summary="IP tunneling options" border="1">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
</tr></thead>
<tbody>
<tr>
<td align="left">mode</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.ip-tunnel.mode">ip-tunnel.mode</a></td>
</tr>
<tr>
<td align="left">local</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.ip-tunnel.local">ip-tunnel.local</a></td>
</tr>
<tr>
<td align="left">remote</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.ip-tunnel.remote">ip-tunnel.remote</a></td>
</tr>
<tr>
<td align="left">dev</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.ip-tunnel.parent">ip-tunnel.parent</a></td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.26"></a><p class="title"><b>Table 23. IPv4 options</b></p>
<div class="table-contents"><table class="table" summary="IPv4 options" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
<th>Note</th>
</tr></thead>
<tbody>
<tr>
<td align="left">ip4</td>
<td align="left">
<a class="link" href="nm-settings.html#nm-settings.property.ipv4.addresses">ipv4.addresses</a> <a class="link" href="nm-settings.html#nm-settings.property.ipv4.method">ipv4.method</a>
</td>
<td align="left" valign="top">The alias is equivalent to the <code class="literal">+ipv4.addresses</code> syntax and also sets <code class="literal">ipv4.method</code> to <code class="literal">manual</code>. It can be specified multiple times.</td>
</tr>
<tr>
<td align="left">gw4</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.ipv4.gateway">ipv4.gateway</a></td>
<td align="left"> </td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.27"></a><p class="title"><b>Table 24. IPv6 options</b></p>
<div class="table-contents"><table class="table" summary="IPv6 options" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
<th>Note</th>
</tr></thead>
<tbody>
<tr>
<td align="left">ip6</td>
<td align="left">
<a class="link" href="nm-settings.html#nm-settings.property.ipv6.addresses">ipv6.addresses</a> <a class="link" href="nm-settings.html#nm-settings.property.ipv6.method">ipv6.method</a>
</td>
<td align="left" valign="top">The alias is equivalent to the <code class="literal">+ipv6.addresses</code> syntax and also sets <code class="literal">ipv6.method</code> to <code class="literal">manual</code>. It can be specified multiple times.</td>
</tr>
<tr>
<td align="left">gw6</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.ipv6.gateway">ipv6.gateway</a></td>
<td align="left"> </td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break"><div class="table">
<a name="id-1.2.4.14.28"></a><p class="title"><b>Table 25. Proxy options</b></p>
<div class="table-contents"><table class="table" summary="Proxy options" border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Alias</th>
<th>Property</th>
<th>Note</th>
</tr></thead>
<tbody>
<tr>
<td align="left">method</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.proxy.method">proxy.method</a></td>
<td align="left"> </td>
</tr>
<tr>
<td align="left">browser-only</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.proxy.browser-only">proxy.browser-only</a></td>
<td align="left"> </td>
</tr>
<tr>
<td align="left">pac-url</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.proxy.pac-url">proxy.pac-url</a></td>
<td align="left"> </td>
</tr>
<tr>
<td align="left">pac-script</td>
<td align="left"><a class="link" href="nm-settings.html#nm-settings.property.proxy.pac-script">proxy.pac-script</a></td>
<td align="left" valign="top">Read the JavaScript PAC (proxy auto-config) script from file or pass it directly on the command line. Prefix the value with "file://" or "js://" to force one or the other.</td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break">
</div>
<div class="refsect1">
<a name="environment_variables"></a><h2>Environment Variables</h2>
<p><span class="command"><strong>nmcli</strong></span>'s behavior is affected by the following
environment variables.</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="envar">LC_ALL</code></span></p></td>
<td><p>If set to a non-empty string value, it overrides the values of all the
other internationalization variables.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="envar">LC_MESSAGES</code></span></p></td>
<td><p>Determines the locale to be used for internationalized messages.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="envar">LANG</code></span></p></td>
<td><p>Provides a default value for the internationalization variables that are
unset or null.</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="internationalization_notes"></a><h2>Internationalization notes</h2>
<p>Be aware that <span class="command"><strong>nmcli</strong></span> is localized and that is why the
output depends on your environment. This is important to realize especially
when you parse the output.</p>
<p>Call <span class="command"><strong>nmcli</strong></span> as <span class="command"><strong>LC_ALL=C nmcli</strong></span> to
be sure the locale is set to <code class="literal">C</code> while executing in a script.</p>
<p><code class="envar">LC_ALL</code>, <code class="envar">LC_MESSAGES</code>, <code class="envar">LANG</code>
variables specify the <code class="envar">LC_MESSAGES</code> locale category (in that
order), which determines the language that <span class="command"><strong>nmcli</strong></span> uses for
messages. The <code class="literal">C</code> locale is used if none of these variables are set, and this
locale uses English messages.</p>
</div>
<div class="refsect1">
<a name="exit_status"></a><h2>Exit Status</h2>
<p><span class="command"><strong>nmcli</strong></span> exits with status 0 if it succeeds, a value
greater than 0 is returned if an error occurs.</p>
<div class="variablelist"><table border="0" class="variablelist compact">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><span class="errorcode">0</span></span></p></td>
<td><p>Success – indicates the operation succeeded.</p></td>
</tr>
<tr>
<td><p><span class="term"><span class="errorcode">1</span></span></p></td>
<td><p>Unknown or unspecified error.</p></td>
</tr>
<tr>
<td><p><span class="term"><span class="errorcode">2</span></span></p></td>
<td><p>Invalid user input, wrong <span class="command"><strong>nmcli</strong></span>
invocation.</p></td>
</tr>
<tr>
<td><p><span class="term"><span class="errorcode">3</span></span></p></td>
<td><p>Timeout expired (see <code class="option">--wait</code> option).</p></td>
</tr>
<tr>
<td><p><span class="term"><span class="errorcode">4</span></span></p></td>
<td><p>Connection activation failed.</p></td>
</tr>
<tr>
<td><p><span class="term"><span class="errorcode">5</span></span></p></td>
<td><p>Connection deactivation failed.</p></td>
</tr>
<tr>
<td><p><span class="term"><span class="errorcode">6</span></span></p></td>
<td><p>Disconnecting device failed.</p></td>
</tr>
<tr>
<td><p><span class="term"><span class="errorcode">7</span></span></p></td>
<td><p>Connection deletion failed.</p></td>
</tr>
<tr>
<td><p><span class="term"><span class="errorcode">8</span></span></p></td>
<td><p>NetworkManager is not running.</p></td>
</tr>
<tr>
<td><p><span class="term"><span class="errorcode">10</span></span></p></td>
<td><p>Connection, device, or access point does not exist.</p></td>
</tr>
<tr>
<td><p><span class="term"><span class="errorcode">65</span></span></p></td>
<td><p>When used with <code class="option">--complete-args</code> option, a file name is expected to follow.</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="examples"></a><h2>Examples</h2>
<p>This section presents various examples of <span class="command"><strong>nmcli</strong></span> usage. If you want even
more, please refer to
<a class="link" href="nmcli-examples.html" title="nmcli-examples"><span class="citerefentry"><span class="refentrytitle">nmcli-examples</span>(7)</span></a>
manual page.</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli -t -f RUNNING general</code></strong></span></p></td>
<td><p>tells you whether NetworkManager is running or not.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli -t -f STATE general</code></strong></span></p></td>
<td><p>shows the overall status of NetworkManager.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli radio wifi off</code></strong></span></p></td>
<td><p>switches Wi-Fi off.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli connection show</code></strong></span></p></td>
<td><p>lists all connections NetworkManager has.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli -p -m multiline -f all con show</code></strong></span></p></td>
<td><p>shows all configured connections in multi-line mode.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli connection show --active</code></strong></span></p></td>
<td><p>lists all currently active connections.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli -f name,autoconnect c s</code></strong></span></p></td>
<td><p>shows all connection profile names and their auto-connect property.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli -p connection show "My default em1"</code></strong></span></p></td>
<td><p>shows details for "My default em1" connection profile.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli --show-secrets connection show "My Home WiFi"</code></strong></span></p></td>
<td><p>shows details for "My Home WiFi" connection profile with all passwords.
Without <code class="option">--show-secrets</code> option, secrets would not be
displayed.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli -f active connection show "My default em1"</code></strong></span></p></td>
<td><p>shows details for "My default em1" active connection, like IP, DHCP
information, etc.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli -f profile con s "My wired connection"</code></strong></span></p></td>
<td><p>shows static configuration details of the connection profile with "My
wired connection" name.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli -p con up "My wired connection" ifname eth0</code></strong></span></p></td>
<td><p>activates the connection profile with name "My wired connection" on
interface eth0. The -p option makes <span class="command"><strong>nmcli</strong></span> show progress of the
activation.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli con up 6b028a27-6dc9-4411-9886-e9ad1dd43761 ap 00:3A:98:7C:42:D3</code></strong></span></p></td>
<td><p>connects the Wi-Fi connection with UUID
6b028a27-6dc9-4411-9886-e9ad1dd43761 to the AP with BSSID
00:3A:98:7C:42:D3.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli device status</code></strong></span></p></td>
<td><p>shows the status for all devices.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli dev disconnect em2</code></strong></span></p></td>
<td><p>disconnects a connection on interface em2 and marks the device as
unavailable for auto-connecting. As a result, no connection will automatically
be activated on the device until the device's 'autoconnect' is set to TRUE or
the user manually activates a connection.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli -f GENERAL,WIFI-PROPERTIES dev show wlan0</code></strong></span></p></td>
<td><p>shows details for wlan0 interface; only GENERAL and WIFI-PROPERTIES
sections will be shown.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli -f CONNECTIONS device show wlp3s0</code></strong></span></p></td>
<td><p>shows all available connection profiles for your Wi-Fi interface
wlp3s0.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli dev wifi</code></strong></span></p></td>
<td><p>lists available Wi-Fi access points known to NetworkManager.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli dev wifi con "Cafe Hotspot 1" password caffeine name "My cafe"</code></strong></span></p></td>
<td><p>creates a new connection named "My cafe" and then connects it to "Cafe
Hotspot 1" SSID using password "caffeine". This is mainly useful when
connecting to "Cafe Hotspot 1" for the first time. Next time, it is better to
use <span class="command"><strong>nmcli con up id "My cafe"</strong></span> so that the
existing connection profile can be used and no additional is created.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli -s dev wifi hotspot con-name QuickHotspot</code></strong></span></p></td>
<td><p>creates a hotspot profile and connects it. Prints the hotspot password
the user should use to connect to the hotspot from other devices.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli dev modify em1 ipv4.method shared</code></strong></span></p></td>
<td><p>starts IPv4 connection sharing using em1 device. The sharing will be active
until the device is disconnected.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli dev modify em1 ipv6.address 2001:db8::a:bad:c0de</code></strong></span></p></td>
<td><p>temporarily adds an IP address to a device. The address will be removed
when the same connection is activated again.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli connection add type ethernet autoconnect no ifname eth0</code></strong></span></p></td>
<td><p>non-interactively adds an Ethernet connection tied to eth0 interface with
automatic IP configuration (DHCP), and disables the connection's <code class="literal">autoconnect</code>
flag.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli c a ifname Maxipes-fik type vlan dev eth0 id 55</code></strong></span></p></td>
<td><p>non-interactively adds a VLAN connection with ID 55. The connection will
use eth0 and the VLAN interface will be named Maxipes-fik.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli c a ifname eth0 type ethernet ipv4.method disabled ipv6.method link-local</code></strong></span></p></td>
<td><p>non-interactively adds a connection that will use eth0 Ethernet interface
and only have an IPv6 link-local address configured.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli connection edit ethernet-em1-2</code></strong></span></p></td>
<td><p>edits existing "ethernet-em1-2" connection in the interactive
editor.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli connection edit type ethernet con-name "yet another Ethernet connection"</code></strong></span></p></td>
<td><p>adds a new Ethernet connection in the interactive editor.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli con mod ethernet-2 connection.autoconnect no</code></strong></span></p></td>
<td><p>modifies 'autoconnect' property in the 'connection' setting of
'ethernet-2' connection.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli con mod "Home Wi-Fi" wifi.mtu 1350</code></strong></span></p></td>
<td><p>modifies 'mtu' property in the 'wifi' setting of 'Home Wi-Fi'
connection.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli con mod em1-1 ipv4.method manual ipv4.addr "192.168.1.23/24 192.168.1.1, 10.10.1.5/8, 10.0.0.11"</code></strong></span></p></td>
<td><p>sets manual addressing and the addresses in em1-1 profile.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli con modify ABC +ipv4.dns 8.8.8.8</code></strong></span></p></td>
<td><p>appends a Google public DNS server to DNS servers in ABC profile.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli con modify ABC -ipv4.addresses "192.168.100.25/24 192.168.1.1"</code></strong></span></p></td>
<td><p>removes the specified IP address from (static) profile ABC.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli con import type openvpn file ~/Downloads/frootvpn.ovpn</code></strong></span></p></td>
<td><p>imports an OpenVPN configuration to NetworkManager.</p></td>
</tr>
<tr>
<td><p><span class="term"><strong class="userinput"><code>nmcli con export corp-vpnc /home/joe/corpvpn.conf</code></strong></span></p></td>
<td><p>exports NetworkManager VPN profile corp-vpnc as standard Cisco (vpnc)
configuration.</p></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="notes"></a><h2>Notes</h2>
<p><span class="command"><strong>nmcli</strong></span> accepts abbreviations, as long as they are a unique prefix in the set
of possible options. As new options get added, these abbreviations are not guaranteed
to stay unique. For scripting and long term compatibility it is therefore strongly
advised to spell out the full option names.</p>
</div>
<div class="refsect1">
<a name="bugs"></a><h2>Bugs</h2>
<p>There are probably some bugs. If you find a bug, please report it to
https://bugzilla.gnome.org/ — product <code class="literal">NetworkManager</code>.</p>
</div>
<div class="refsect1">
<a name="see_also"></a><h2>See Also</h2>
<p><a class="link" href="nmcli-examples.html" title="nmcli-examples"><span class="citerefentry"><span class="refentrytitle">nmcli-examples</span>(7)</span></a>,
<a class="link" href="nm-online.html" title="nm-online"><span class="citerefentry"><span class="refentrytitle">nm-online</span>(1)</span></a>,
<a class="link" href="NetworkManager.html" title="NetworkManager"><span class="citerefentry"><span class="refentrytitle">NetworkManager</span>(8)</span></a>,
<a class="link" href="NetworkManager.conf.html" title="NetworkManager.conf"><span class="citerefentry"><span class="refentrytitle">NetworkManager.conf</span>(5)</span></a>,
<a class="link" href="nm-settings.html" title="nm-settings"><span class="citerefentry"><span class="refentrytitle">nm-settings</span>(5)</span></a>,
<span class="citerefentry"><span class="refentrytitle">nm-applet</span>(1)</span>,
<span class="citerefentry"><span class="refentrytitle">nm-connection-editor</span>(1)</span>.</p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|