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 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[
<!ENTITY authors SYSTEM "./authors.xml">
<!ENTITY seealso SYSTEM "./seealso.xml">
<!ENTITY notes SYSTEM "./notes.xml">
<!ENTITY errorcodes SYSTEM "errorcodes.xml">
]>
<!--
SPDX-License-Identifier: GPL-2.0-or-later
This file is part of firewalld.
Copyright (C) 2010-2014 Red Hat, Inc.
Authors:
Thomas Woerner <twoerner@redhat.com>
-->
<refentry id="firewall-cmd">
<refentryinfo>
<title>firewall-cmd</title>
<productname>firewalld</productname>
&authors;
</refentryinfo>
<refmeta>
<refentrytitle>firewall-cmd</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>firewall-cmd</refname>
<refpurpose>firewalld command line client</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>firewall-cmd</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description">
<title>Description</title>
<para>
firewall-cmd is the command line client of the firewalld daemon. It provides an interface to manage the runtime and permanent configurations.
</para>
<para>
The runtime configuration in firewalld is separated from the permanent configuration. This means that things can get changed in the runtime or permanent configuration.
</para>
</refsect1>
<refsect1 id="options">
<title>Options</title>
<para>
Sequence options are the options that can be specified multiple times, the exit code is 0 if there is at least one item that succeeded. The <literal>ALREADY_ENABLED</literal> (11), <literal>NOT_ENABLED</literal> (12) and also <literal>ZONE_ALREADY_SET</literal> (16) errors are treated as succeeded.
If there are issues while parsing the items, then these are treated as warnings and will not change the result as long as there is a succeeded one.
Without any succeeded item, the exit code will depend on the error codes. If there is exactly one error code, then this is used. If there are more than one then <literal>UNKNOWN_ERROR</literal> (254) will be used.
</para>
<para>
The following options are supported:
</para>
<refsect2 id="general_options">
<title>General Options</title>
<variablelist>
<varlistentry>
<term><option>-h</option></term>
<term><option>--help</option></term>
<listitem>
<para>
Prints a short help text and exits.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</option></term>
<term><option>--version</option></term>
<listitem>
<para>
Print the version string of firewalld. This option is not combinable with other options.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option></term>
<term><option>--quiet</option></term>
<listitem>
<para>
Do not print status messages.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="status_options">
<title>Status Options</title>
<variablelist>
<varlistentry>
<term><option>--state</option></term>
<listitem>
<para>
Check whether the firewalld daemon is active (i.e. running). Returns an exit code 0 if it is active, <replaceable>RUNNING_BUT_FAILED</replaceable> if failure occurred on startup, <replaceable>NOT_RUNNING</replaceable> otherwise. See <xref linkend="exit_codes"/>. This will also print the state to <replaceable>STDOUT</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--reload</option></term>
<listitem>
<para>
Reload firewall rules and keep state information.
Current permanent configuration will become new runtime configuration,
i.e. all runtime only changes done until reload are lost with reload
if they have not been also in permanent configuration.
</para>
<para>
Note: If FlushAllOnReload=no, runtime changes applied via the direct interface are not
affected and will therefore stay in place until firewalld daemon
is restarted completely. For FlushAllOnReload, see <citerefentry><refentrytitle>firewalld.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--complete-reload</option></term>
<listitem>
<para>
Reload firewall completely, even netfilter kernel modules. This will most likely terminate active connections, because state information is lost. This option should only be used in case of severe firewall problems. For example if there are state information problems that no connection can be established with correct firewall rules.
</para>
<para>
Note: If FlushAllOnReload=no, runtime changes applied via the direct interface are not
affected and will therefore stay in place until firewalld daemon
is restarted completely. For FlushAllOnReload, see <citerefentry><refentrytitle>firewalld.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--runtime-to-permanent</option></term>
<listitem>
<para>
Save active runtime configuration and overwrite permanent configuration with it.
The way this is supposed to work is that when configuring firewalld you do runtime changes only and
once you're happy with the configuration and you tested that it works the way you want, you save
the configuration to disk.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--check-config</option></term>
<listitem>
<para>
Run checks on the permanent configuration. This includes XML validity
and semantics.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--reset-to-defaults</option></term>
<listitem>
<para>
Reset configuration to firewalld's default configuration.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="log_denied_options">
<title>Log Denied Options</title>
<variablelist>
<varlistentry>
<term><option>--get-log-denied</option></term>
<listitem>
<para>
Print the log denied setting.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--set-log-denied</option>=<replaceable>value</replaceable></term>
<listitem>
<para>
Add logging rules right before reject and drop rules in the INPUT, FORWARD and OUTPUT chains for the default rules and also final reject and drop rules in zones for the configured link-layer packet type. The possible values are: <replaceable>all</replaceable>, <replaceable>unicast</replaceable>, <replaceable>broadcast</replaceable>, <replaceable>multicast</replaceable> and <replaceable>off</replaceable>. The default setting is <replaceable>off</replaceable>, which disables the logging.
</para>
<para>
This is a runtime and permanent change and will also reload the firewall to be able to add the logging rules.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="permanent_options">
<title>Permanent Options</title>
<variablelist>
<varlistentry>
<term><option>--permanent</option></term>
<listitem>
<para>
The permanent option <option>--permanent</option> can be used to set options permanently. These changes are not effective immediately, only after service restart/reload or system reboot. Without the <option>--permanent</option> option, a change will only be part of the runtime configuration.
</para>
<para>If you want to make a change in runtime and permanent configuration, use the same call with and without the <option>--permanent</option> option.
</para>
<para>
The <option>--permanent</option> option can be optionally added to all options further down where it is supported.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="zone_options">
<title>Zone Options</title>
<variablelist>
<varlistentry>
<term><option>--get-default-zone</option></term>
<listitem>
<para>
Print default zone for connections and interfaces.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--set-default-zone</option>=<replaceable>zone</replaceable></term>
<listitem>
<para>
Set default zone for connections and interfaces where no zone has been selected. Setting the default zone changes the zone for the connections or interfaces, that are using the default zone.
</para>
<para>
This is a runtime and permanent change.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--get-active-zones</option></term>
<listitem>
<para>
Print currently active zones altogether with interfaces and sources used in these zones. Active zones are zones, that have a binding to an interface or source. The output format is:
<programlisting>
<replaceable>zone1</replaceable>
interfaces: <replaceable>interface1</replaceable> <replaceable>interface2</replaceable> ..
sources: <replaceable>source1</replaceable> ..
<replaceable>zone2</replaceable>
interfaces: <replaceable>interface3</replaceable> ..
<replaceable>zone3</replaceable>
sources: <replaceable>source2</replaceable> ..
</programlisting>
If there are no interfaces or sources bound to the zone, the corresponding line will be omitted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--get-zones</option></term>
<listitem>
<para>
Print predefined zones as a space separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--get-services</option></term>
<listitem>
<para>
Print predefined services as a space separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--get-icmptypes</option></term>
<listitem>
<para>
Print predefined icmptypes as a space separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--get-zone-of-interface</option>=<replaceable>interface</replaceable></term>
<listitem>
<para>
Print the name of the zone the <replaceable>interface</replaceable> is bound to or <emphasis>no zone</emphasis>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--get-zone-of-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional>|<replaceable>MAC</replaceable>|ipset:<replaceable>ipset</replaceable></term>
<listitem>
<para>
Print the name of the zone the source is bound to or <emphasis>no zone</emphasis>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--info-zone=<replaceable>zone</replaceable></option></term>
<listitem>
<para>
Print information about the zone <replaceable>zone</replaceable>. The output format is:
<programlisting>
<replaceable>zone</replaceable>
interfaces: <replaceable>interface1</replaceable> ..
sources: <replaceable>source1</replaceable> ..
services: <replaceable>service1</replaceable> ..
ports: <replaceable>port1</replaceable> ..
protocols: <replaceable>protocol1</replaceable> ..
forward-ports:
<replaceable>forward-port1</replaceable>
..
source-ports: <replaceable>source-port1</replaceable> ..
icmp-blocks: <replaceable>icmp-type1</replaceable> ..
rich rules:
<replaceable>rich-rule1</replaceable>
..
</programlisting>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--list-all-zones</option></term>
<listitem>
<para>
List everything added for or enabled in all zones. The output format is:
<programlisting>
<replaceable>zone1</replaceable>
interfaces: <replaceable>interface1</replaceable> ..
sources: <replaceable>source1</replaceable> ..
services: <replaceable>service1</replaceable> ..
ports: <replaceable>port1</replaceable> ..
protocols: <replaceable>protocol1</replaceable> ..
forward-ports:
<replaceable>forward-port1</replaceable>
..
icmp-blocks: <replaceable>icmp-type1</replaceable> ..
rich rules:
<replaceable>rich-rule1</replaceable>
..
..
</programlisting>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--new-zone</option>=<replaceable>zone</replaceable></term>
<listitem>
<para>
Add a new permanent and empty zone.
</para>
<para>
Zone names must be alphanumeric and may additionally include characters: '_' and '-'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--new-zone-from-file</option>=<replaceable>filename</replaceable> <optional><option>--name</option>=<replaceable>zone</replaceable></optional></term>
<listitem>
<para>
Add a new permanent zone from a prepared zone file with an optional name override.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--delete-zone</option>=<replaceable>zone</replaceable></term>
<listitem>
<para>
Delete an existing permanent zone.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--load-zone-defaults</option>=<replaceable>zone</replaceable></term>
<listitem>
<para>
Load zone default settings or report NO_DEFAULTS error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--path-zone=<replaceable>zone</replaceable></option></term>
<listitem>
<para>
Print path of the zone configuration file.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="policy_options">
<title>Policy Options</title>
<variablelist>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--get-policies</option></term>
<listitem>
<para>
Print predefined policies as a space separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--info-policy</option>=<replaceable>policy</replaceable></term>
<listitem>
<para>
Print information about the policy <replaceable>policy</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--list-all-policies</option></term>
<listitem>
<para>
List everything added for or enabled in all policies.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--new-policy</option>=<replaceable>policy</replaceable></term>
<listitem>
<para>
Add a new permanent policy.
</para>
<para>
Policy names must be alphanumeric and may additionally include characters: '_' and '-'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--new-policy-from-file</option>=<replaceable>filename</replaceable> <optional><option>--name</option>=<replaceable>policy</replaceable></optional></term>
<listitem>
<para>
Add a new permanent policy from a prepared policy file with an optional name override.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--path-policy</option>=<replaceable>policy</replaceable></term>
<listitem>
<para>
Print path of the policy configuration file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--delete-policy</option>=<replaceable>policy</replaceable></term>
<listitem>
<para>
Delete an existing permanent policy.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--load-policy-defaults</option>=<replaceable>policy</replaceable></term>
<listitem>
<para>
Load the shipped defaults for a policy. Only applies to policies
shipped with firewalld. Does not apply to user defined policies.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="options_to_adapt_and_query_zones_and_policies">
<title>Options to Adapt and Query Zones and Policies</title>
<para>
Options in this section affect only one particular zone or policy. If used with <option>--zone</option>=<replaceable>zone</replaceable> or <option>--policy</option>=<replaceable>policy</replaceable> option, they affect the specified zone or policy. If both options are omitted, they affect the default zone (see <option>--get-default-zone</option>).
</para>
<variablelist>
<!-- list-all -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--list-all</option></term>
<listitem>
<para>
List everything added or enabled.
</para>
</listitem>
</varlistentry>
<!-- target -->
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--get-target</option></term>
<listitem>
<para>
Get the target.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--set-target</option>=<replaceable>target</replaceable></term>
<listitem>
<para>
Set the target.
</para>
<para>
For zones <replaceable>target</replaceable> is one of: <literal>default</literal>, <literal>ACCEPT</literal>, <literal>DROP</literal>, <literal>REJECT</literal>
</para>
<para>
For policies <replaceable>target</replaceable> is one of: <literal>CONTINUE</literal>, <literal>ACCEPT</literal>, <literal>DROP</literal>, <literal>REJECT</literal>
</para>
<para>
<literal>default</literal> is similar to <literal>REJECT</literal>, but it implicitly allows ICMP packets.
</para>
<para>
<literal>ACCEPT</literal> allows traffic to be forwarded from the zone, either to the same zone or other zones.
</para>
</listitem>
</varlistentry>
<!-- description/short -->
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--set-description</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set description.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--get-description</option></term>
<listitem>
<para>
Print description.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--set-short</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set short description.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--get-short</option></term>
<listitem>
<para>
Print short description.
</para>
</listitem>
</varlistentry>
<!-- list/add/remove/query service -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--list-services</option></term>
<listitem>
<para>
List services added as a space separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--add-service</option>=<replaceable>service</replaceable> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
<listitem>
<para>
Add a service. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
<replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
</para>
<para>
The service is one of the firewalld provided services. To get a list of the supported services, use <command>firewall-cmd --get-services</command>.
</para>
<para>
The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
</para>
<para>
<emphasis role="bold">Note</emphasis>: Some services define connection tracking helpers.
Helpers that may operate in client mode (e.g. tftp) must be added to an
outbound policy instead of a zone to take effect for clients. Otherwise
the helper will not be applied to the outbound traffic. The related
traffic, as defined by the connection tracking helper, on the return
path (ingress) will be allowed by the stateful firewall rules.
</para>
<para>
An example of an outbound policy for connection tracking helpers:
<programlisting>
# firewall-cmd --permanent --new-policy clientConntrack
# firewall-cmd --permanent --policy clientConntrack --add-ingress-zone HOST
# firewall-cmd --permanent --policy clientConntrack --add-egress-zone ANY
# firewall-cmd --permanent --policy clientConntrack --add-service tftp
</programlisting>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--remove-service</option>=<replaceable>service</replaceable></term>
<listitem>
<para>
Remove a service. This option can be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--query-service</option>=<replaceable>service</replaceable></term>
<listitem>
<para>
Return whether <replaceable>service</replaceable> has been added. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
<!-- list/add/remove/query port -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--list-ports</option></term>
<listitem>
<para>
List ports added as a space separated list. A port is of the form <replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable>, it can be either a port and protocol pair or a port range with a protocol.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--add-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
<listitem>
<para>
Add the port. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
<replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
</para>
<para>
The port can either be a single port number or a port range <replaceable>portid</replaceable>-<replaceable>portid</replaceable>. The protocol can either be <literal>tcp</literal>, <literal>udp</literal>, <literal>sctp</literal> or <literal>dccp</literal>.
</para>
<para>
The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--remove-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Remove the port. This option can be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--query-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Return whether the port has been added. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
<!-- list/add/remove/query protocol -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--list-protocols</option></term>
<listitem>
<para>
List protocols added as a space separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--add-protocol</option>=<replaceable>protocol</replaceable> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
<listitem>
<para>
Add the protocol. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
<replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
</para>
<para>
The protocol can be any protocol supported by the system. Please have a look at <filename>/etc/protocols</filename> for supported protocols.
</para>
<para>
The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--remove-protocol</option>=<replaceable>protocol</replaceable></term>
<listitem>
<para>
Remove the protocol. This option can be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--query-protocol</option>=<replaceable>protocol</replaceable></term>
<listitem>
<para>
Return whether the protocol has been added. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
<!-- list/add/remove/query source port -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--list-source-ports</option></term>
<listitem>
<para>
List source ports added as a space separated list. A port is of the form <replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--add-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
<listitem>
<para>
Add the source port. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
<replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
</para>
<para>
The port can either be a single port number or a port range <replaceable>portid</replaceable>-<replaceable>portid</replaceable>. The protocol can either be <literal>tcp</literal>, <literal>udp</literal>, <literal>sctp</literal> or <literal>dccp</literal>.
</para>
<para>
The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--remove-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Remove the source port. This option can be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--query-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Return whether the source port has been added. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
<!-- list/add/remove/query icmp-block -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--list-icmp-blocks</option></term>
<listitem>
<para>
List Internet Control Message Protocol (ICMP) type blocks added as a space separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--add-icmp-block</option>=<replaceable>icmptype</replaceable> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
<listitem>
<para>
Add an ICMP block for <replaceable>icmptype</replaceable>. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
<replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
</para>
<para>
The <replaceable>icmptype</replaceable> is the one of the icmp types firewalld supports. To get a listing of supported icmp types: <command>firewall-cmd --get-icmptypes</command>
</para>
<para>
The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--remove-icmp-block</option>=<replaceable>icmptype</replaceable></term>
<listitem>
<para>
Remove the ICMP block for <replaceable>icmptype</replaceable>. This option can be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--query-icmp-block</option>=<replaceable>icmptype</replaceable></term>
<listitem>
<para>
Return whether an ICMP block for <replaceable>icmptype</replaceable> has been added. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
<!-- list/add/remove/query forward-port -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--list-forward-ports</option></term>
<listitem>
<para>
List <emphasis>IPv4</emphasis> forward ports added as a space separated list.
</para>
<para>
For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--add-forward-port</option>=port=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>:proto=<replaceable>protocol</replaceable><optional>:toport=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional></optional><optional>:toaddr=<replaceable>address</replaceable><optional>/<replaceable>mask</replaceable></optional></optional> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
<listitem>
<para>
Add the <emphasis>IPv4</emphasis> forward port. This option can be specified multiple times. If a timeout is supplied, the rule will be active for the specified amount of time and will be removed automatically afterwards.
<replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
</para>
<para>
The port can either be a single port number <replaceable>portid</replaceable> or a port range <replaceable>portid</replaceable>-<replaceable>portid</replaceable>. The protocol can either be <literal>tcp</literal>, <literal>udp</literal>, <literal>sctp</literal> or <literal>dccp</literal>. The destination address is a simple IP address.
</para>
<para>
The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
</para>
<para>
For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
</para>
<para>
<emphasis>Note:</emphasis> IP forwarding will be implicitly enabled if <option>toaddr</option> is specified.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--remove-forward-port</option>=port=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>:proto=<replaceable>protocol</replaceable><optional>:toport=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional></optional><optional>:toaddr=<replaceable>address</replaceable><optional>/<replaceable>mask</replaceable></optional></optional></term>
<listitem>
<para>
Remove the <emphasis>IPv4</emphasis> forward port. This option can be specified multiple times.
</para>
<para>
For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--query-forward-port</option>=port=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>:proto=<replaceable>protocol</replaceable><optional>:toport=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional></optional><optional>:toaddr=<replaceable>address</replaceable><optional>/<replaceable>mask</replaceable></optional></optional></term>
<listitem>
<para>
Return whether the <emphasis>IPv4</emphasis> forward port has been added. Returns 0 if true, 1 otherwise.
</para>
<para>
For <emphasis>IPv6</emphasis> forward ports, please use the rich language.
</para>
</listitem>
</varlistentry>
<!-- add/remove/query masquerade -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--add-masquerade</option> <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
<listitem>
<para>
Enable <emphasis>IPv4</emphasis> masquerade. If a timeout is supplied, masquerading will be active for the specified amount of time.
<replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
Masquerading is useful if the machine is a router and machines connected over an interface in another zone should be able to use the first connection.
</para>
<para>
The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
</para>
<para>
For <emphasis>IPv6</emphasis> masquerading, please use the rich language.
</para>
<para>
<emphasis>Note:</emphasis> IP forwarding will be implicitly enabled.
</para>
<para>
<emphasis>Note (Linux < 5.5):</emphasis>
For the iptables backend, a policy may not enable masquerade if
an ingress zone has assigned interfaces. This restriction does
not exist for the nftables backend, but does require Linux v5.5+
to function properly; otherwise it will silently fail.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--remove-masquerade</option></term>
<listitem>
<para>
Disable <emphasis>IPv4</emphasis> masquerade. If the masquerading was enabled with a timeout, it will be disabled also.
</para>
<para>
For <emphasis>IPv6</emphasis> masquerading, please use the rich language.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--query-masquerade</option></term>
<listitem>
<para>
Return whether <emphasis>IPv4</emphasis> masquerading has been enabled. Returns 0 if true, 1 otherwise.
</para>
<para>
For <emphasis>IPv6</emphasis> masquerading, please use the rich language.
</para>
</listitem>
</varlistentry>
<!-- list/add/remove/query rich rule -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--list-rich-rules</option></term>
<listitem>
<para>
List rich language rules added as a newline separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--add-rich-rule</option>='<replaceable>rule</replaceable>' <optional><option>--timeout</option>=<replaceable>timeval</replaceable></optional></term>
<listitem>
<para>
Add rich language rule '<replaceable>rule</replaceable>'. This option can be specified multiple times. If a timeout is supplied, the <replaceable>rule</replaceable> will be active for the specified amount of time and will be removed automatically afterwards.
<replaceable>timeval</replaceable> is either a number (of seconds) or number followed by one of characters <literal>s</literal> (seconds), <literal>m</literal> (minutes), <literal>h</literal> (hours), for example <literal>20m</literal> or <literal>1h</literal>.
</para>
<para>
For the rich language rule syntax, please have a look at <citerefentry><refentrytitle>firewalld.richlanguage</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
The <option>--timeout</option> option is not combinable with the <option>--permanent</option> option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--remove-rich-rule</option>='<replaceable>rule</replaceable>'</term>
<listitem>
<para>
Remove rich language rule '<replaceable>rule</replaceable>'. This option can be specified multiple times.
</para>
<para>
For the rich language rule syntax, please have a look at <citerefentry><refentrytitle>firewalld.richlanguage</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <optional><option>--permanent</option></optional> <optional><option>--policy</option>=<replaceable>policy</replaceable></optional> <option>--query-rich-rule</option>='<replaceable>rule</replaceable>'</term>
<listitem>
<para>
Return whether a rich language rule '<replaceable>rule</replaceable>' has been added. Returns 0 if true, 1 otherwise.
</para>
<para>
For the rich language rule syntax, please have a look at <citerefentry><refentrytitle>firewalld.richlanguage</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="options_to_adapt_and_query_zones">
<title>Options to Adapt and Query Zones</title>
<para>
Options in this section affect only one particular zone. If used with <option>--zone</option>=<replaceable>zone</replaceable> option, they affect the specified zone. If the option is omitted, they affect default zone (see <option>--get-default-zone</option>).
</para>
<variablelist>
<!-- add/remove/query icmp-block-inversion -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-icmp-block-inversion</option></term>
<listitem>
<para>
Enable ICMP block inversion.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-icmp-block-inversion</option></term>
<listitem>
<para>
Disable ICMP block inversion.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-icmp-block-inversion</option></term>
<listitem>
<para>
Return whether ICMP block inversion is enabled. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
<!-- add/remove/query forward -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-forward</option></term>
<listitem>
<para>
Enable intra zone forwarding.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--remove-forward</option></term>
<listitem>
<para>
Disable intra zone forwarding.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-forward</option></term>
<listitem>
<para>
Return whether intra zone forwarding is enabled. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
<!-- set/get priority -->
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--get-priority</option></term>
<listitem>
<para>
Get the priority of the zone.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--set-priority</option></term>
<listitem>
<para>
Set the zone's priority for packet classification. This will set
both the ingress and egress priority.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--get-ingress-priority</option></term>
<listitem>
<para>
Get the ingress priority of the zone.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--set-ingress-priority</option></term>
<listitem>
<para>
Set the zone's ingress priority for packet classification.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--get-egress-priority</option></term>
<listitem>
<para>
Get the egress priority of the zone.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--set-egress-priority</option></term>
<listitem>
<para>
Set the zone's egress priority for packet classification.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="options_to_adapt_and_query_policies">
<title>Options to Adapt and Query Policies</title>
<para>
Options in this section affect only one particular policy. It's required to specify <option>--policy</option>=<replaceable>policy</replaceable> with these options.
</para>
<variablelist>
<!-- priority -->
<varlistentry>
<term><option>--permanent</option> <option>--policy</option>=<replaceable>policy</replaceable> <option>--get-priority</option></term>
<listitem>
<para>
Get the priority.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--policy</option>=<replaceable>policy</replaceable> <option>--set-priority</option>=<replaceable>priority</replaceable></term>
<listitem>
<para>
Set the priority. The priority determines the relative ordering of
policies. This is an integer value between -32768 and 32767
where -1 is the default value for new policies and 0 is reserved for
internal use.
</para>
<para>
If a priority is < 0, then the policy's rules will execute before all rules in all zones.
</para>
<para>
If a priority is > 0, then the policy's rules will execute after all rules in all zones.
</para>
</listitem>
</varlistentry>
<!-- list/add/remove/query ingress zones -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--policy</option>=<replaceable>policy</replaceable> <option>--list-ingress-zones</option></term>
<listitem>
<para>
List ingress zones added as a space separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--policy</option>=<replaceable>policy</replaceable> <option>--add-ingress-zone</option>=<replaceable>zone</replaceable></term>
<listitem>
<para>
Add an ingress zone. This option can be specified multiple times.
</para>
<para>
The ingress zone is one of the firewalld provided zones or one of
the pseudo-zones: HOST, ANY.
</para>
<para>
HOST is used for traffic originating from the host machine, i.e. the
host running firewalld.
</para>
<para>
ANY is used for traffic originating from any zone. This can be
thought of as a wild card for zones. However it does not include
traffic originating from the host machine - use HOST for that.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--policy</option>=<replaceable>policy</replaceable> <option>--remove-ingress-zone</option>=<replaceable>zone</replaceable></term>
<listitem>
<para>
Remove an ingress zone. This option can be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--policy</option>=<replaceable>policy</replaceable> <option>--query-ingress-zone</option>=<replaceable>zone</replaceable></term>
<listitem>
<para>
Return whether <replaceable>zone</replaceable> has been added. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
<!-- list/add/remove/query egress zones -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--policy</option>=<replaceable>policy</replaceable> <option>--list-egress-zones</option></term>
<listitem>
<para>
List egress zones added as a space separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--policy</option>=<replaceable>policy</replaceable> <option>--add-egress-zone</option>=<replaceable>zone</replaceable></term>
<listitem>
<para>
Add an egress zone. This option can be specified multiple times.
</para>
<para>
The egress zone is one of the firewalld provided zones or one of
the pseudo-zones: HOST, ANY.
</para>
<para>
For clarification on HOST and ANY see option <option>--add-ingress-zone</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--policy</option>=<replaceable>policy</replaceable> <option>--remove-egress-zone</option>=<replaceable>zone</replaceable></term>
<listitem>
<para>
Remove an egress zone. This option can be specified multiple times.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--policy</option>=<replaceable>policy</replaceable> <option>--query-egress-zone</option>=<replaceable>zone</replaceable></term>
<listitem>
<para>
Return whether <replaceable>zone</replaceable> has been added. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
<!-- add/remove/query disable -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--policy</option>=<replaceable>policy</replaceable>|<option>--policy-set</option>=<replaceable>policy-set</replaceable> <option>--add-disable</option></term>
<listitem>
<para>
Administratively disable a policy. A disabled policy will not activate.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--policy</option>=<replaceable>policy</replaceable>|<option>--policy-set</option>=<replaceable>policy-set</replaceable> <option>--remove-disable</option></term>
<listitem>
<para>
Remove the administratively disable from a policy. Allows a policy
to activate.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--policy</option>=<replaceable>policy</replaceable> <option>--query-disable</option></term>
<listitem>
<para>
Return if the policy is administratively disabled.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="options_to_handle_bindings_of_interfaces">
<title>Options to Handle Bindings of Interfaces</title>
<para>
Binding an interface to a zone means that this zone settings are used to restrict traffic via the interface.
</para>
<para>
Options in this section affect only one particular zone. If used with <option>--zone</option>=<replaceable>zone</replaceable> option, they affect the zone <replaceable>zone</replaceable>. If the option is omitted, they affect default zone (see <option>--get-default-zone</option>).
</para>
<para>
For a list of predefined zones use <command>firewall-cmd --get-zones</command>.
</para>
<para>
An interface name is a string up to 16 characters long, that may not contain <option>' '</option>, <option>'/'</option>, <option>'!'</option> and <option>'*'</option>.
</para>
<variablelist>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-interfaces</option></term>
<listitem>
<para>
List interfaces that are bound to zone <replaceable>zone</replaceable> as a space separated list. If zone is omitted, default zone will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-interface</option>=<replaceable>interface</replaceable></term>
<listitem>
<para>
Bind interface <replaceable>interface</replaceable> to zone <replaceable>zone</replaceable>. If zone is omitted, default zone will be used.
</para>
<para>
If the interface is under control of NetworkManager, it is at first connected to change the zone for the connection that is using the interface. If this fails, the zone binding is created in firewalld and the limitations below apply.
For interfaces that are not under control of NetworkManager, firewalld tries to change the ZONE setting in the ifcfg file, if the file exists.
</para>
<para>
As a end user you don't need this in most cases, because NetworkManager (or legacy network service) adds interfaces into zones automatically (according to <option>ZONE=</option> option from ifcfg-<replaceable>interface</replaceable> file) if <replaceable>NM_CONTROLLED=no</replaceable> is not set.
You should do it only if there's no /etc/sysconfig/network-scripts/ifcfg-<replaceable>interface</replaceable> file.
If there is such file and you add interface to zone with this <option>--add-interface</option> option, make sure the zone is the same in both cases, otherwise the behavior would be undefined.
Please also have a look at the <citerefentry><refentrytitle>firewalld</refentrytitle><manvolnum>1</manvolnum></citerefentry> man page in the <replaceable>Concepts</replaceable> section.
For permanent association of interface with a zone, see also 'How to set or change a zone for a connection?' in <citerefentry><refentrytitle>firewalld.zones</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--change-interface</option>=<replaceable>interface</replaceable></term>
<listitem>
<para>
If the interface is under control of NetworkManager, it is at first connected to change the zone for the connection that is using the interface. If this fails, the zone binding is created in firewalld and the limitations below apply.
For interfaces that are not under control of NetworkManager, firewalld tries to change the ZONE setting in the ifcfg file, if the file exists.
</para>
<para>
Change zone the interface <replaceable>interface</replaceable> is bound to to zone <replaceable>zone</replaceable>.
It's basically <option>--remove-interface</option> followed by <option>--add-interface</option>.
If the interface has not been bound to a zone before, it behaves like <option>--add-interface</option>.
If zone is omitted, default zone will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-interface</option>=<replaceable>interface</replaceable></term>
<listitem>
<para>
Query whether interface <replaceable>interface</replaceable> is bound to zone <replaceable>zone</replaceable>. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--remove-interface</option>=<replaceable>interface</replaceable></term>
<listitem>
<para>
If the interface is under control of NetworkManager, it is at first connected to change the zone for the connection that is using the interface. If this fails, the zone binding is created in firewalld and the limitations below apply.
</para>
<para>
For the addition or change of interfaces that are not under control of NetworkManager: firewalld tries to change the ZONE setting in the ifcfg file, if an ifcfg file exists that is using the interface.
</para>
<para>
Only for the removal of interfaces that are not under control of NetworkManager: firewalld is not trying to change the ZONE setting in the ifcfg file. This is needed to make sure that an ifdown of the interface will not result in a reset of the zone setting to the default zone. Only the zone binding is then removed in firewalld then.
</para>
<para>
Remove binding of interface <replaceable>interface</replaceable> from zone it was previously added to.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="options_to_handle_bindings_of_sources">
<title>Options to Handle Bindings of Sources</title>
<para>
Binding a source to a zone means that this zone settings will be used to restrict traffic from this source.
</para>
<para>
A source address or address range is either an IP address or a network IP address with a mask for IPv4 or IPv6 or a MAC address or an ipset with the ipset: prefix. For IPv4, the mask can be a network mask or a plain number. For IPv6 the mask is a plain number. The use of host names is not supported.
</para>
<para>
Options in this section affect only one particular zone. If used with <option>--zone</option>=<replaceable>zone</replaceable> option, they affect the zone <replaceable>zone</replaceable>. If the option is omitted, they affect default zone (see <option>--get-default-zone</option>).
</para>
<para>
For a list of predefined zones use <command>firewall-cmd <optional><option>--permanent</option></optional> --get-zones</command>.
</para>
<variablelist>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--list-sources</option></term>
<listitem>
<para>
List sources that are bound to zone <replaceable>zone</replaceable> as a space separated list. If zone is omitted, default zone will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--add-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional>|<replaceable>MAC</replaceable>|ipset:<replaceable>ipset</replaceable></term>
<listitem>
<para>
Bind the source to zone <replaceable>zone</replaceable>. If zone is omitted, default zone will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--change-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional>|<replaceable>MAC</replaceable>|ipset:<replaceable>ipset</replaceable></term>
<listitem>
<para>
Change zone the source is bound to to zone <replaceable>zone</replaceable>.
It's basically <option>--remove-source</option> followed by <option>--add-source</option>.
If the source has not been bound to a zone before, it behaves like <option>--add-source</option>.
If zone is omitted, default zone will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <optional><option>--zone</option>=<replaceable>zone</replaceable></optional> <option>--query-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional>|<replaceable>MAC</replaceable>|ipset:<replaceable>ipset</replaceable></term>
<listitem>
<para>
Query whether the source is bound to the zone <replaceable>zone</replaceable>. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--remove-source</option>=<replaceable>source</replaceable><optional>/<replaceable>mask</replaceable></optional>|<replaceable>MAC</replaceable>|ipset:<replaceable>ipset</replaceable></term>
<listitem>
<para>
Remove binding of the source from zone it was previously added to.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="ipset_options">
<title>IPSet Options</title>
<variablelist>
<varlistentry>
<term><option>--get-ipset-types</option></term>
<listitem>
<para>
Print the supported ipset types.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--new-ipset</option>=<replaceable>ipset</replaceable> <option>--type</option>=<replaceable>type</replaceable> <optional><option>--family</option>=<literal>inet</literal>|<literal>inet6</literal></optional> <optional><option>--option</option>=<replaceable>key</replaceable><optional>=<replaceable>value</replaceable></optional></optional></term>
<listitem>
<para>
Add a new permanent and empty ipset with specifying the type and optional the family and options like <literal>timeout</literal>, <literal>hashsize</literal> and <literal>maxelem</literal>. For more information please have a look at <citerefentry><refentrytitle>ipset</refentrytitle><manvolnum>8</manvolnum></citerefentry> man page.
</para>
<para>
ipset names must be alphanumeric and may additionally include characters: '_' and '-'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--new-ipset-from-file</option>=<replaceable>filename</replaceable> <optional><option>--name</option>=<replaceable>ipset</replaceable></optional></term>
<listitem>
<para>
Add a new permanent ipset from a prepared ipset file with an optional name override.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--delete-ipset</option>=<replaceable>ipset</replaceable></term>
<listitem>
<para>
Delete an existing permanent ipset.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--load-ipset-defaults</option>=<replaceable>ipset</replaceable></term>
<listitem>
<para>
Load ipset default settings or report NO_DEFAULTS error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--info-ipset=<replaceable>ipset</replaceable></option></term>
<listitem>
<para>
Print information about the ipset <replaceable>ipset</replaceable>. The output format is:
<programlisting>
<replaceable>ipset</replaceable>
type: <replaceable>type</replaceable>
options: <replaceable>option1[=value1]</replaceable> ..
entries: <replaceable>entry1</replaceable> ..
</programlisting>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--get-ipsets</option></term>
<listitem>
<para>
Print predefined ipsets as a space separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--set-description</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set new description to ipset
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--get-description</option></term>
<listitem>
<para>
Print description for ipset
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--set-short</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set short description to ipset
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--get-short</option></term>
<listitem>
<para>
Print short description for ipset
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--add-entry</option>=<replaceable>entry</replaceable></term>
<listitem>
<para>
Add a new entry to the ipset.
</para>
<para>
Adding an entry to an ipset with option <literal>timeout</literal>
is permitted, but these entries are not tracked by firewalld.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--remove-entry</option>=<replaceable>entry</replaceable></term>
<listitem>
<para>
Remove an entry from the ipset.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--query-entry</option>=<replaceable>entry</replaceable></term>
<listitem>
<para>
Return whether the entry has been added to an ipset. Returns 0 if true, 1 otherwise.
</para>
<para>
Querying an ipset with a timeout will yield an error. Entries are
not tracked for ipsets with a timeout.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--get-entries</option></term>
<listitem>
<para>
List all entries of the ipset.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--add-entries-from-file</option>=<replaceable>filename</replaceable></term>
<listitem>
<para>
Add a new entries to the ipset from the file. For all entries that are listed in the file but already in the ipset, a warning will be printed.
</para>
<para>
The file should contain an entry per line. Lines starting with an hash or semicolon are ignored. Also empty lines.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--ipset</option>=<replaceable>ipset</replaceable> <option>--remove-entries-from-file</option>=<replaceable>filename</replaceable></term>
<listitem>
<para>
Remove existing entries from the ipset from the file. For all entries that are listed in the file but not in the ipset, a warning will be printed.
</para>
<para>
The file should contain an entry per line. Lines starting with an hash or semicolon are ignored. Also empty lines.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--path-ipset=<replaceable>ipset</replaceable></option></term>
<listitem>
<para>
Print path of the ipset configuration file.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="service_options">
<title>Service Options</title>
<para>
Options in this section affect only one particular service.
</para>
<variablelist>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--info-service=<replaceable>service</replaceable></option></term>
<listitem>
<para>
Print information about the service <replaceable>service</replaceable>. The output format is:
<programlisting>
<replaceable>service</replaceable>
ports: <replaceable>port1</replaceable> ..
protocols: <replaceable>protocol1</replaceable> ..
source-ports: <replaceable>source-port1</replaceable> ..
helpers: <replaceable>helper1</replaceable> ..
destination: <replaceable>ipv1</replaceable>:<replaceable>address1</replaceable> ..
</programlisting>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The following options are only usable in the permanent configuration.
</para>
<variablelist>
<varlistentry>
<term><option>--permanent</option> <option>--new-service</option>=<replaceable>service</replaceable></term>
<listitem>
<para>
Add a new permanent and empty service.
</para>
<para>
Service names must be alphanumeric and may additionally include characters: '_' and '-'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--new-service-from-file</option>=<replaceable>filename</replaceable> <optional><option>--name</option>=<replaceable>service</replaceable></optional></term>
<listitem>
<para>
Add a new permanent service from a prepared service file with an optional name override.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--delete-service</option>=<replaceable>service</replaceable></term>
<listitem>
<para>
Delete an existing permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--load-service-defaults</option>=<replaceable>service</replaceable></term>
<listitem>
<para>
Load service default settings or report NO_DEFAULTS error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--path-service=<replaceable>service</replaceable></option></term>
<listitem>
<para>
Print path of the service configuration file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--set-description</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set new description to service
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-description</option></term>
<listitem>
<para>
Print description for service
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--set-short</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set short description to service
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-short</option></term>
<listitem>
<para>
Print short description for service
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--add-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Add a new port to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Remove a port from the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Return whether the port has been added to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-ports</option></term>
<listitem>
<para>
List ports added to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--add-protocol</option>=<replaceable>protocol</replaceable></term>
<listitem>
<para>
Add a new protocol to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-protocol</option>=<replaceable>protocol</replaceable></term>
<listitem>
<para>
Remove a protocol from the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-protocol</option>=<replaceable>protocol</replaceable></term>
<listitem>
<para>
Return whether the protocol has been added to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-protocols</option></term>
<listitem>
<para>
List protocols added to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--add-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Add a new source port to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Remove a source port from the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-source-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Return whether the source port has been added to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-source-ports</option></term>
<listitem>
<para>
List source ports added to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--add-helper</option>=<replaceable>helper</replaceable></term>
<listitem>
<para>
Add a new helper to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-helper</option>=<replaceable>helper</replaceable></term>
<listitem>
<para>
Remove a helper from the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-helper</option>=<replaceable>helper</replaceable></term>
<listitem>
<para>
Return whether the helper has been added to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-service-helpers</option></term>
<listitem>
<para>
List helpers added to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--set-destination</option>=<replaceable>ipv</replaceable>:<replaceable>address</replaceable><optional>/<replaceable>mask</replaceable></optional></term>
<listitem>
<para>
Set destination for ipv to address[/mask] in the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-destination</option>=<replaceable>ipv</replaceable></term>
<listitem>
<para>
Remove the destination for ipv from the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-destination</option>=<replaceable>ipv</replaceable>:<replaceable>address</replaceable><optional>/<replaceable>mask</replaceable></optional></term>
<listitem>
<para>
Return whether the destination ipv to address[/mask] has been set in the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-destinations</option></term>
<listitem>
<para>
List destinations added to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--add-include</option>=<replaceable>service</replaceable></term>
<listitem>
<para>
Add a new include to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--remove-include</option>=<replaceable>service</replaceable></term>
<listitem>
<para>
Remove a include from the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--query-include</option>=<replaceable>service</replaceable></term>
<listitem>
<para>
Return whether the include has been added to the permanent service.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--service</option>=<replaceable>service</replaceable> <option>--get-includes</option></term>
<listitem>
<para>
List includes added to the permanent service.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="helper_options">
<title>Helper Options</title>
<para>
Options in this section affect only one particular helper.
</para>
<variablelist>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--info-helper=<replaceable>helper</replaceable></option></term>
<listitem>
<para>
Print information about the helper <replaceable>helper</replaceable>. The output format is:
<programlisting>
<replaceable>helper</replaceable>
family: <replaceable>family</replaceable>
module: <replaceable>module</replaceable>
ports: <replaceable>port1</replaceable> ..
</programlisting>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The following options are only usable in the permanent configuration.
</para>
<variablelist>
<varlistentry>
<term><option>--permanent</option> <option>--new-helper</option>=<replaceable>helper</replaceable> <option>--module</option>=<replaceable>nf_conntrack_module</replaceable> <optional><option>--family</option>=<literal>ipv4</literal>|<literal>ipv6</literal></optional></term>
<listitem>
<para>
Add a new permanent helper with module and optionally family defined.
</para>
<para>
Helper names must be alphanumeric and may additionally include characters: '-'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--new-helper-from-file</option>=<replaceable>filename</replaceable> <optional><option>--name</option>=<replaceable>helper</replaceable></optional></term>
<listitem>
<para>
Add a new permanent helper from a prepared helper file with an optional name override.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--delete-helper</option>=<replaceable>helper</replaceable></term>
<listitem>
<para>
Delete an existing permanent helper.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--load-helper-defaults</option>=<replaceable>helper</replaceable></term>
<listitem>
<para>
Load helper default settings or report NO_DEFAULTS error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--path-helper=<replaceable>helper</replaceable></option></term>
<listitem>
<para>
Print path of the helper configuration file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--get-helpers</option></term>
<listitem>
<para>
Print predefined helpers as a space separated list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--set-description</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set new description to helper
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--get-description</option></term>
<listitem>
<para>
Print description for helper
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--set-short</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set short description to helper
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--get-short</option></term>
<listitem>
<para>
Print short description for helper
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--add-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Add a new port to the permanent helper.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--remove-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Remove a port from the permanent helper.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--query-port</option>=<replaceable>portid</replaceable><optional>-<replaceable>portid</replaceable></optional>/<replaceable>protocol</replaceable></term>
<listitem>
<para>
Return whether the port has been added to the permanent helper.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--get-ports</option></term>
<listitem>
<para>
List ports added to the permanent helper.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--set-module</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set module description for helper
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--get-module</option></term>
<listitem>
<para>
Print module description for helper
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--set-family</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set family description for helper
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--helper</option>=<replaceable>helper</replaceable> <option>--get-family</option></term>
<listitem>
<para>
Print family description of helper
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="icmptype_options">
<title>Internet Control Message Protocol (ICMP) type Options</title>
<para>
Options in this section affect only one particular icmptype.
</para>
<variablelist>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--info-icmptype=<replaceable>icmptype</replaceable></option></term>
<listitem>
<para>
Print information about the icmptype <replaceable>icmptype</replaceable>. The output format is:
<programlisting>
<replaceable>icmptype</replaceable>
destination: <replaceable>ipv1</replaceable> ..
</programlisting>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The following options are only usable in the permanent configuration.
</para>
<variablelist>
<varlistentry>
<term><option>--permanent</option> <option>--new-icmptype</option>=<replaceable>icmptype</replaceable></term>
<listitem>
<para>
Add a new permanent and empty icmptype.
</para>
<para>
ICMP type names must be alphanumeric and may additionally include characters: '_' and '-'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--new-icmptype-from-file</option>=<replaceable>filename</replaceable> <optional><option>--name</option>=<replaceable>icmptype</replaceable></optional></term>
<listitem>
<para>
Add a new permanent icmptype from a prepared icmptype file with an optional name override.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--delete-icmptype</option>=<replaceable>icmptype</replaceable></term>
<listitem>
<para>
Delete an existing permanent icmptype.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--load-icmptype-defaults</option>=<replaceable>icmptype</replaceable></term>
<listitem>
<para>
Load icmptype default settings or report NO_DEFAULTS error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--set-description</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set new description to icmptype
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--get-description</option></term>
<listitem>
<para>
Print description for icmptype
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--set-short</option>=<replaceable>description</replaceable></term>
<listitem>
<para>
Set short description to icmptype
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--get-short</option></term>
<listitem>
<para>
Print short description for icmptype
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--add-destination</option>=<replaceable>ipv</replaceable></term>
<listitem>
<para>
Enable destination for ipv in permanent icmptype. ipv is one of <literal>ipv4</literal> or <literal>ipv6</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--remove-destination</option>=<replaceable>ipv</replaceable></term>
<listitem>
<para>
Disable destination for ipv in permanent icmptype. ipv is one of <literal>ipv4</literal> or <literal>ipv6</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--query-destination</option>=<replaceable>ipv</replaceable></term>
<listitem>
<para>
Return whether destination for ipv is enabled in permanent icmptype. ipv is one of <literal>ipv4</literal> or <literal>ipv6</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--icmptype</option>=<replaceable>icmptype</replaceable> <option>--get-destinations</option></term>
<listitem>
<para>
List destinations in permanent icmptype.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--permanent</option> <option>--path-icmptype=<replaceable>icmptype</replaceable></option></term>
<listitem>
<para>
Print path of the icmptype configuration file.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="direct_options">
<title>Direct Options</title>
<refsect3>
<title>DEPRECATED</title>
<para>
The direct interface has been deprecated. It will be removed in a future
release. It is superseded by policies, see
<citerefentry><refentrytitle>firewalld.policies</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
</refsect3>
<para>
The direct options give a more direct access to the firewall. These options require user to know basic iptables concepts, i.e. <literal>table</literal> (filter/mangle/nat/...), <literal>chain</literal> (INPUT/OUTPUT/FORWARD/...), <literal>commands</literal> (-A/-D/-I/...), <literal>parameters</literal> (-p/-s/-d/-j/...) and <literal>targets</literal> (ACCEPT/DROP/REJECT/...).
</para>
<para>
Direct options should be used only as a last resort when it's not possible to use for example <option>--add-service</option>=<replaceable>service</replaceable> or <option>--add-rich-rule</option>='<replaceable>rule</replaceable>'.
</para>
<para>
<emphasis role="bold">Warning</emphasis>: Direct rules behavior is different depending on the value of <literal>FirewallBackend</literal>. See <literal>CAVEATS</literal> in <citerefentry><refentrytitle>firewalld.direct</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>
The first argument of each option has to be <literal>ipv4</literal> or <literal>ipv6</literal> or <literal>eb</literal>. With <literal>ipv4</literal> it will be for IPv4 (<citerefentry><refentrytitle>iptables</refentrytitle><manvolnum>8</manvolnum></citerefentry>), with <literal>ipv6</literal> for IPv6 (<citerefentry><refentrytitle>ip6tables</refentrytitle><manvolnum>8</manvolnum></citerefentry>) and with <literal>eb</literal> for ethernet bridges (<citerefentry><refentrytitle>ebtables</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
</para>
<variablelist>
<!-- direct chain -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-all-chains</option></term>
<listitem>
<para>
Get all chains added to all tables.
This option concerns only chains previously added with <option>--direct --add-chain</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-chains</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable></term>
<listitem>
<para>
Get all chains added to table <replaceable>table</replaceable> as a space separated list.
This option concerns only chains previously added with <option>--direct --add-chain</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--add-chain</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
<listitem>
<para>
Add a new chain with name <replaceable>chain</replaceable> to table <replaceable>table</replaceable>. Make sure there's no other chain with this name already.
</para>
<para>
There already exist basic chains to use with direct options, for example <literal>INPUT_direct</literal> chain (see <literal>iptables-save | grep direct</literal> output for all of them).
These chains are jumped into before chains for zones, i.e. every rule put into <literal>INPUT_direct</literal> will be checked before rules in zones.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--remove-chain</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
<listitem>
<para>
Remove chain with name <replaceable>chain</replaceable> from table <replaceable>table</replaceable>.
Only chains previously added with <option>--direct --add-chain</option> can be removed this way.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--query-chain</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
<listitem>
<para>
Return whether a chain with name <replaceable>chain</replaceable> exists in table <replaceable>table</replaceable>. Returns 0 if true, 1 otherwise.
This option concerns only chains previously added with <option>--direct --add-chain</option>.
</para>
</listitem>
</varlistentry>
<!-- direct rule -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-all-rules</option></term>
<listitem>
<para>
Get all rules added to all chains in all tables as a newline separated list of the priority and arguments.
This option concerns only rules previously added with <option>--direct --add-rule</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-rules</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
<listitem>
<para>
Get all rules added to chain <replaceable>chain</replaceable> in table <replaceable>table</replaceable> as a newline separated list of the priority and arguments.
This option concerns only rules previously added with <option>--direct --add-rule</option>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--add-rule</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable> <replaceable>priority</replaceable> <replaceable>args</replaceable></term>
<listitem>
<para>
Add a rule with the arguments <replaceable>args</replaceable> to chain <replaceable>chain</replaceable> in table <replaceable>table</replaceable> with priority <replaceable>priority</replaceable>.
</para>
<para>
The <replaceable>priority</replaceable> is used to order rules. Priority 0 means add rule on top of the chain, with a higher priority the rule will be added further down. Rules with the same priority are on the same level and the order of these rules is not fixed and may change. If you want to make sure that a rule will be added after another one, use a low priority for the first and a higher for the following.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--remove-rule</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable> <replaceable>priority</replaceable> <replaceable>args</replaceable></term>
<listitem>
<para>
Remove a rule with <replaceable>priority</replaceable> and the arguments <replaceable>args</replaceable> from chain <replaceable>chain</replaceable> in table <replaceable>table</replaceable>.
Only rules previously added with <option>--direct --add-rule</option> can be removed this way.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--remove-rules</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable></term>
<listitem>
<para>
Remove all rules in the chain with name <replaceable>chain</replaceable> exists in table <replaceable>table</replaceable>.
This option concerns only rules previously added with <option>--direct --add-rule</option> in this chain.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--query-rule</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>table</replaceable> <replaceable>chain</replaceable> <replaceable>priority</replaceable> <replaceable>args</replaceable></term>
<listitem>
<para>
Return whether a rule with <replaceable>priority</replaceable> and the arguments <replaceable>args</replaceable> exists in chain <replaceable>chain</replaceable> in table <replaceable>table</replaceable>.
Returns 0 if true, 1 otherwise. This option concerns only rules previously added with <option>--direct --add-rule</option>.
</para>
</listitem>
</varlistentry>
<!-- direct untracked passthrough -->
<varlistentry>
<term><option>--direct</option> <option>--passthrough</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>args</replaceable></term>
<listitem>
<para>
Pass a command through to the firewall. <replaceable>args</replaceable> can be all <command>iptables</command>, <command>ip6tables</command> and <command>ebtables</command> command line arguments. This command is untracked, which means that firewalld is not able to provide information about this command later on, also not a listing of the untracked passthoughs.
</para>
</listitem>
</varlistentry>
<!-- direct tracked passthrough -->
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-all-passthroughs</option></term>
<listitem>
<para>
Get all passthrough rules as a newline separated list of the ipv value and arguments.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--get-passthroughs</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> }</term>
<listitem>
<para>
Get all passthrough rules for the ipv value as a newline separated list of the priority and arguments.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--add-passthrough</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>args</replaceable></term>
<listitem>
<para>
Add a passthrough rule with the arguments <replaceable>args</replaceable> for the ipv value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--remove-passthrough</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>args</replaceable></term>
<listitem>
<para>
Remove a passthrough rule with the arguments <replaceable>args</replaceable> for the ipv value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><optional><option>--permanent</option></optional> <option>--direct</option> <option>--query-passthrough</option> { <literal>ipv4</literal> | <literal>ipv6</literal> | <literal>eb</literal> } <replaceable>args</replaceable></term>
<listitem>
<para>
Return whether a passthrough rule with the arguments <replaceable>args</replaceable> exists for the ipv value. Returns 0 if true, 1 otherwise.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect2 id="panic_options">
<title>Panic Options</title>
<variablelist>
<varlistentry>
<term><option>--panic-on</option></term>
<listitem>
<para>
Enable panic mode. All incoming and outgoing packets are dropped, active connections will expire. Enable this only if there are serious problems with your network environment. For example if the machine is getting hacked in.
</para>
<para>
This is a runtime only change.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--panic-off</option></term>
<listitem>
<para>
Disable panic mode. After disabling panic mode established connections might work again, if panic mode was enabled for a short period of time.
</para>
<para>
This is a runtime only change.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--query-panic</option></term>
<listitem>
<para>
Returns 0 if panic mode is enabled, 1 otherwise.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect1>
<title>Examples</title>
<refsect2>
<title>Example 1</title>
<para>
Enable http service in default zone. This is runtime only change, i.e. effective until restart.
</para>
<para>
<programlisting>
firewall-cmd --add-service=http
</programlisting>
</para>
</refsect2>
<refsect2>
<title>Example 2</title>
<para>
Enable port 443/tcp immediately and permanently in default zone.
To make the change effective immediately and also after restart we need two commands.
The first command makes the change in runtime configuration, i.e. makes it effective immediately, until restart.
The second command makes the change in permanent configuration, i.e. makes it effective after restart.
</para>
<para>
<programlisting>
firewall-cmd --add-port=443/tcp
firewall-cmd --permanent --add-port=443/tcp
</programlisting>
</para>
</refsect2>
</refsect1>
<refsect1 id="exit_codes">
<title>Exit Codes</title>
<para>
On success 0 is returned.
On failure the output is red colored and exit code is either 2 in case of wrong command-line option usage or one of the following error codes in other cases:
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec align="left"/>
<colspec align="right"/>
<thead>
<row>
<entry>String</entry>
<entry>Code</entry>
</row>
</thead>
<tbody>
&errorcodes;
</tbody>
</tgroup>
</informaltable>
</para>
<para>
Note that return codes of <command>--query-*</command> options are special: Successful queries return 0, unsuccessful ones return 1 unless an error occurred in which case the table above applies.
</para>
</refsect1>
&seealso;
¬es;
</refentry>
|