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
|
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Copyright (C) 2018 NetDEF, Inc.
* Renato Westphal
*/
#include <zebra.h>
#include <sys/stat.h>
#include "libfrr.h"
#include "lib/version.h"
#include "defaults.h"
#include "log.h"
#include "lib_errors.h"
#include "command.h"
#include "termtable.h"
#include "db.h"
#include "debug.h"
#include "yang_translator.h"
#include "northbound.h"
#include "northbound_cli.h"
#include "northbound_db.h"
#include "lib/northbound_cli_clippy.c"
struct debug nb_dbg_cbs_config = { 0, "debug northbound callbacks configuration",
"Northbound callbacks: configuration" };
struct debug nb_dbg_cbs_state = { 0, "debug northbound callbacks state",
"Northbound callbacks: state" };
struct debug nb_dbg_cbs_rpc = { 0, "debug northbound callbacks rpc",
"Northbound callbacks: RPCs" };
struct debug nb_dbg_cbs_notify = { 0, "debug northbound callbacks notify",
"Northbound callbacks: notifications" };
struct debug nb_dbg_notif = { 0, "debug northbound notifications",
"Northbound notifications" };
struct debug nb_dbg_events = { 0, "debug northbound events",
"Northbound events" };
struct debug nb_dbg_libyang = { 0, "debug northbound libyang", "libyang" };
struct nb_config *vty_shared_candidate_config;
static struct event_loop *master;
static void vty_show_nb_errors(struct vty *vty, int error, const char *errmsg)
{
vty_out(vty, "Error type: %s\n", nb_err_name(error));
if (strlen(errmsg) > 0)
vty_out(vty, "Error description: %s\n", errmsg);
}
static int nb_cli_classic_commit(struct vty *vty)
{
struct nb_context context = {};
char errmsg[BUFSIZ] = {0};
int ret;
context.client = NB_CLIENT_CLI;
context.user = vty;
ret = nb_candidate_commit(context, vty->candidate_config, true, NULL,
NULL, errmsg, sizeof(errmsg));
switch (ret) {
case NB_OK:
/* Successful commit. Print warnings (if any). */
if (strlen(errmsg) > 0)
vty_out(vty, "%s\n", errmsg);
break;
case NB_ERR_NO_CHANGES:
break;
default:
vty_out(vty, "%% Configuration failed.\n\n");
vty_show_nb_errors(vty, ret, errmsg);
if (vty->pending_commit)
vty_out(vty,
"The following commands were dynamically grouped into the same transaction and rejected:\n%s",
vty->pending_cmds_buf);
/* Regenerate candidate for consistency. */
nb_config_replace(vty->candidate_config, running_config, true);
return CMD_WARNING_CONFIG_FAILED;
}
return CMD_SUCCESS;
}
static void nb_cli_pending_commit_clear(struct vty *vty)
{
vty->pending_commit = 0;
vty->buffer_cmd_count = 0;
XFREE(MTYPE_TMP, vty->pending_cmds_buf);
vty->pending_cmds_buflen = 0;
vty->pending_cmds_bufpos = 0;
}
int nb_cli_pending_commit_check(struct vty *vty)
{
int ret = CMD_SUCCESS;
if (vty->pending_commit) {
ret = nb_cli_classic_commit(vty);
nb_cli_pending_commit_clear(vty);
}
return ret;
}
static int nb_cli_schedule_command(struct vty *vty)
{
/* Append command to dynamically sized buffer of scheduled commands.
* vty->buf -Incoming config
* vty->pending_cmds_buf - Pending buffer where incoming configs are
* accumulated for later processing
* vty->pending_cmds_bufpos - length of the pending buffer
*
*/
if (!vty->pending_cmds_buf) {
vty->pending_cmds_buflen = 4096;
vty->pending_cmds_buf =
XCALLOC(MTYPE_TMP, vty->pending_cmds_buflen);
}
if ((strlen(vty->buf) + 3)
> (vty->pending_cmds_buflen - vty->pending_cmds_bufpos)) {
vty->pending_cmds_buflen *= 2;
vty->pending_cmds_buf =
XREALLOC(MTYPE_TMP, vty->pending_cmds_buf,
vty->pending_cmds_buflen);
}
strlcat(vty->pending_cmds_buf, "- ", vty->pending_cmds_buflen);
vty->pending_cmds_bufpos = strlcat(vty->pending_cmds_buf, vty->buf,
vty->pending_cmds_buflen);
/* Schedule the commit operation. */
vty->pending_commit = 1;
vty->buffer_cmd_count++;
if (vty->buffer_cmd_count == NB_CMD_BATCH_SIZE)
nb_cli_pending_commit_check(vty);
return CMD_SUCCESS;
}
void nb_cli_enqueue_change(struct vty *vty, const char *xpath,
enum nb_operation operation, const char *value)
{
struct nb_cfg_change *change;
if (vty->num_cfg_changes == VTY_MAXCFGCHANGES) {
/* Not expected to happen. */
vty_out(vty,
"%% Exceeded the maximum number of changes (%u) for a single command\n\n",
VTY_MAXCFGCHANGES);
return;
}
change = &vty->cfg_changes[vty->num_cfg_changes++];
strlcpy(change->xpath, xpath, sizeof(change->xpath));
change->operation = operation;
change->value = value;
}
static int nb_cli_apply_changes_internal(struct vty *vty,
const char *xpath_base,
bool clear_pending)
{
bool error = false;
char buf[BUFSIZ];
VTY_CHECK_XPATH;
nb_candidate_edit_config_changes(vty->candidate_config, vty->cfg_changes,
vty->num_cfg_changes, xpath_base,
false, buf, sizeof(buf), &error);
if (error) {
/*
* Failure to edit the candidate configuration should never
* happen in practice, unless there's a bug in the code. When
* that happens, log the error but otherwise ignore it.
*/
vty_out(vty, "%s", buf);
}
/*
* Maybe do an implicit commit when using the classic CLI mode.
*
* NOTE: the implicit commit might be scheduled to run later when
* too many commands are being sent at the same time. This is a
* protection mechanism where multiple commands are grouped into the
* same configuration transaction, allowing them to be processed much
* faster.
*/
if (frr_get_cli_mode() == FRR_CLI_CLASSIC) {
if (clear_pending) {
if (vty->pending_commit)
return nb_cli_pending_commit_check(vty);
} else if (vty->pending_allowed)
return nb_cli_schedule_command(vty);
assert(!vty->pending_commit);
return nb_cli_classic_commit(vty);
}
return CMD_SUCCESS;
}
static void create_xpath_base_abs(struct vty *vty, char *xpath_base_abs,
size_t xpath_base_abs_size,
const char *xpath_base)
{
memset(xpath_base_abs, 0, xpath_base_abs_size);
if (xpath_base[0] == 0)
xpath_base = ".";
/* If base xpath is relative, prepend current vty xpath. */
if (vty->xpath_index > 0 && xpath_base[0] == '.') {
strlcpy(xpath_base_abs, VTY_CURR_XPATH, xpath_base_abs_size);
xpath_base++; /* skip '.' */
}
strlcat(xpath_base_abs, xpath_base, xpath_base_abs_size);
}
static int _nb_cli_apply_changes(struct vty *vty, const char *xpath_base, bool clear_pending)
{
char xpath_base_abs[XPATH_MAXLEN] = {};
bool implicit_commit;
create_xpath_base_abs(vty, xpath_base_abs, sizeof(xpath_base_abs),
xpath_base);
if (vty_mgmt_should_process_cli_apply_changes(vty)) {
VTY_CHECK_XPATH;
assert(vty->type != VTY_FILE);
/*
* The legacy user wanted to clear pending (i.e., perform a
* commit immediately) due to some non-yang compatible
* functionality. This new mgmtd code however, continues to send
* changes putting off the commit until XFRR_end is received
* (i.e., end-of-config-file). This should be fine b/c all
* conversions to mgmtd require full proper implementations.
*/
if (!vty->num_cfg_changes)
return CMD_SUCCESS;
implicit_commit = vty_needs_implicit_commit(vty);
if (vty_mgmt_send_config_data(vty, xpath_base_abs, implicit_commit) < 0) {
vty_out(vty, "%% Failed to apply configuration data.\n");
return CMD_WARNING_CONFIG_FAILED;
}
if (!implicit_commit)
++vty->mgmt_num_pending_setcfg;
return CMD_SUCCESS;
}
return nb_cli_apply_changes_internal(vty, xpath_base_abs, clear_pending);
}
int nb_cli_apply_changes(struct vty *vty, const char *xpath_base_fmt, ...)
{
char xpath_base[XPATH_MAXLEN] = {};
/* Parse the base XPath format string. */
if (xpath_base_fmt) {
va_list ap;
va_start(ap, xpath_base_fmt);
vsnprintf(xpath_base, sizeof(xpath_base), xpath_base_fmt, ap);
va_end(ap);
}
return _nb_cli_apply_changes(vty, xpath_base, false);
}
int nb_cli_apply_changes_clear_pending(struct vty *vty, const char *xpath_base_fmt, ...)
{
char xpath_base[XPATH_MAXLEN] = {};
/* Parse the base XPath format string. */
if (xpath_base_fmt) {
va_list ap;
va_start(ap, xpath_base_fmt);
vsnprintf(xpath_base, sizeof(xpath_base), xpath_base_fmt, ap);
va_end(ap);
}
return _nb_cli_apply_changes(vty, xpath_base, true);
}
int nb_cli_rpc_enqueue(struct vty *vty, const char *xpath, const char *value)
{
struct nb_cfg_change *param;
if (vty->num_rpc_params == VTY_MAXCFGCHANGES) {
/* Not expected to happen. */
vty_out(vty,
"%% Exceeded the maximum number of params (%u) for a single command\n\n",
VTY_MAXCFGCHANGES);
return CMD_WARNING;
}
param = &vty->rpc_params[vty->num_rpc_params++];
strlcpy(param->xpath, xpath, sizeof(param->xpath));
param->value = value;
return CMD_SUCCESS;
}
int nb_cli_rpc(struct vty *vty, const char *xpath, struct lyd_node **output_p)
{
struct nb_node *nb_node;
struct lyd_node *input = NULL;
struct lyd_node *output = NULL;
LY_ERR err;
int ret;
char errmsg[BUFSIZ] = {0};
nb_node = nb_node_find(xpath);
if (!nb_node) {
flog_warn(EC_LIB_YANG_UNKNOWN_DATA_PATH,
"%s: unknown data path: %s", __func__, xpath);
return CMD_WARNING;
}
/* create input tree */
err = lyd_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0, 0, NULL,
&input);
assert(err == LY_SUCCESS);
for (size_t i = 0; i < vty->num_rpc_params; i++) {
err = lyd_new_path(input, ly_native_ctx,
vty->rpc_params[i].xpath,
vty->rpc_params[i].value, 0, NULL);
assert(err == LY_SUCCESS);
}
if (vty_mgmt_fe_enabled()) {
char *data = NULL;
err = lyd_print_mem(&data, input, LYD_JSON, LYD_PRINT_SHRINK);
assert(err == LY_SUCCESS);
ret = vty_mgmt_send_rpc_req(vty, LYD_JSON, xpath, data);
free(data);
lyd_free_all(input);
if (ret < 0)
return CMD_WARNING;
return CMD_SUCCESS;
}
/* validate input tree to create implicit defaults */
err = lyd_validate_op(input, NULL, LYD_TYPE_RPC_YANG, NULL);
assert(err == LY_SUCCESS);
/* create output tree root for population in the callback */
err = lyd_new_path2(NULL, ly_native_ctx, xpath, NULL, 0, 0, 0, NULL,
&output);
assert(err == LY_SUCCESS);
ret = nb_callback_rpc(nb_node, xpath, input, output, errmsg,
sizeof(errmsg));
/* validate output tree to create implicit defaults */
err = lyd_validate_op(output, NULL, LYD_TYPE_REPLY_YANG, NULL);
assert(err == LY_SUCCESS);
lyd_free_all(input);
vty->num_rpc_params = 0;
switch (ret) {
case NB_OK:
if (output_p)
*output_p = output;
else
lyd_free_all(output);
return CMD_SUCCESS;
default:
lyd_free_all(output);
if (strlen(errmsg))
vty_show_nb_errors(vty, ret, errmsg);
return CMD_WARNING;
}
}
void nb_cli_confirmed_commit_clean(struct vty *vty)
{
event_cancel(&vty->t_confirmed_commit_timeout);
nb_config_free(vty->confirmed_commit_rollback);
vty->confirmed_commit_rollback = NULL;
}
int nb_cli_confirmed_commit_rollback(struct vty *vty)
{
struct nb_context context = {};
uint32_t transaction_id;
char errmsg[BUFSIZ] = {0};
int ret;
/* Perform the rollback. */
context.client = NB_CLIENT_CLI;
context.user = vty;
ret = nb_candidate_commit(
context, vty->confirmed_commit_rollback, true,
"Rollback to previous configuration - confirmed commit has timed out",
&transaction_id, errmsg, sizeof(errmsg));
if (ret == NB_OK) {
vty_out(vty,
"Rollback performed successfully (Transaction ID #%u).\n",
transaction_id);
/* Print warnings (if any). */
if (strlen(errmsg) > 0)
vty_out(vty, "%s\n", errmsg);
} else {
vty_out(vty,
"Failed to rollback to previous configuration.\n\n");
vty_show_nb_errors(vty, ret, errmsg);
}
return ret;
}
static void nb_cli_confirmed_commit_timeout(struct event *thread)
{
struct vty *vty = EVENT_ARG(thread);
/* XXX: broadcast this message to all logged-in users? */
vty_out(vty,
"\nConfirmed commit has timed out, rolling back to previous configuration.\n\n");
nb_cli_confirmed_commit_rollback(vty);
nb_cli_confirmed_commit_clean(vty);
}
static int nb_cli_commit(struct vty *vty, bool force,
unsigned int confirmed_timeout, char *comment)
{
struct nb_context context = {};
uint32_t transaction_id = 0;
char errmsg[BUFSIZ] = {0};
int ret;
/* Check if there's a pending confirmed commit. */
if (vty->t_confirmed_commit_timeout) {
if (confirmed_timeout) {
/* Reset timeout if "commit confirmed" is used again. */
vty_out(vty,
"%% Resetting confirmed-commit timeout to %u minute(s)\n\n",
confirmed_timeout);
event_cancel(&vty->t_confirmed_commit_timeout);
event_add_timer(master, nb_cli_confirmed_commit_timeout,
vty, confirmed_timeout * 60,
&vty->t_confirmed_commit_timeout);
} else {
/* Accept commit confirmation. */
vty_out(vty, "%% Commit complete.\n\n");
nb_cli_confirmed_commit_clean(vty);
}
return CMD_SUCCESS;
}
/* "force" parameter. */
if (!force && nb_candidate_needs_update(vty->candidate_config)) {
vty_out(vty,
"%% Candidate configuration needs to be updated before commit.\n\n");
vty_out(vty,
"Use the \"update\" command or \"commit force\".\n");
return CMD_WARNING;
}
/* "confirm" parameter. */
if (confirmed_timeout) {
vty->confirmed_commit_rollback = nb_config_dup(running_config);
vty->t_confirmed_commit_timeout = NULL;
event_add_timer(master, nb_cli_confirmed_commit_timeout, vty,
confirmed_timeout * 60,
&vty->t_confirmed_commit_timeout);
}
context.client = NB_CLIENT_CLI;
context.user = vty;
ret = nb_candidate_commit(context, vty->candidate_config, true, comment,
&transaction_id, errmsg, sizeof(errmsg));
/* Map northbound return code to CLI return code. */
switch (ret) {
case NB_OK:
nb_config_replace(vty->candidate_config_base, running_config,
true);
vty_out(vty,
"%% Configuration committed successfully (Transaction ID #%u).\n\n",
transaction_id);
/* Print warnings (if any). */
if (strlen(errmsg) > 0)
vty_out(vty, "%s\n", errmsg);
return CMD_SUCCESS;
case NB_ERR_NO_CHANGES:
vty_out(vty, "%% No configuration changes to commit.\n\n");
return CMD_SUCCESS;
default:
vty_out(vty,
"%% Failed to commit candidate configuration.\n\n");
vty_show_nb_errors(vty, ret, errmsg);
return CMD_WARNING;
}
}
static int nb_cli_candidate_load_file(struct vty *vty,
enum nb_cfg_format format,
struct yang_translator *translator,
const char *path, bool replace)
{
struct nb_config *loaded_config = NULL;
struct lyd_node *dnode;
struct ly_ctx *ly_ctx;
int ly_format;
char buf[BUFSIZ];
LY_ERR err;
switch (format) {
case NB_CFG_FMT_CMDS:
loaded_config = nb_config_new(NULL);
if (!vty_read_config(loaded_config, path, config_default)) {
vty_out(vty, "%% Failed to load configuration.\n\n");
vty_out(vty,
"Please check the logs for more details.\n");
nb_config_free(loaded_config);
return CMD_WARNING;
}
break;
case NB_CFG_FMT_JSON:
case NB_CFG_FMT_XML:
ly_format = (format == NB_CFG_FMT_JSON) ? LYD_JSON : LYD_XML;
ly_ctx = translator ? translator->ly_ctx : ly_native_ctx;
err = lyd_parse_data_path(ly_ctx, path, ly_format,
LYD_PARSE_ONLY | LYD_PARSE_NO_STATE,
0, &dnode);
if (err || !dnode) {
flog_warn(EC_LIB_LIBYANG, "%s: lyd_parse_path() failed",
__func__);
vty_out(vty, "%% Failed to load configuration:\n\n");
vty_out(vty, "%s",
yang_print_errors(ly_native_ctx, buf,
sizeof(buf)));
return CMD_WARNING;
}
if (translator
&& yang_translate_dnode(translator,
YANG_TRANSLATE_TO_NATIVE, &dnode)
!= YANG_TRANSLATE_SUCCESS) {
vty_out(vty, "%% Failed to translate configuration\n");
yang_dnode_free(dnode);
return CMD_WARNING;
}
loaded_config = nb_config_new(dnode);
break;
}
if (replace)
nb_config_replace(vty->candidate_config, loaded_config, false);
else if (nb_config_merge(vty->candidate_config, loaded_config, false)
!= NB_OK) {
vty_out(vty,
"%% Failed to merge the loaded configuration:\n\n");
vty_out(vty, "%s",
yang_print_errors(ly_native_ctx, buf, sizeof(buf)));
return CMD_WARNING;
}
return CMD_SUCCESS;
}
static int nb_cli_candidate_load_transaction(struct vty *vty,
uint32_t transaction_id,
bool replace)
{
struct nb_config *loaded_config;
char buf[BUFSIZ];
loaded_config = nb_db_transaction_load(transaction_id);
if (!loaded_config) {
vty_out(vty, "%% Transaction %u does not exist.\n\n",
transaction_id);
return CMD_WARNING;
}
if (replace)
nb_config_replace(vty->candidate_config, loaded_config, false);
else if (nb_config_merge(vty->candidate_config, loaded_config, false)
!= NB_OK) {
vty_out(vty,
"%% Failed to merge the loaded configuration:\n\n");
vty_out(vty, "%s",
yang_print_errors(ly_native_ctx, buf, sizeof(buf)));
return CMD_WARNING;
}
return CMD_SUCCESS;
}
/* Prepare the configuration for display. */
void nb_cli_show_config_prepare(struct nb_config *config, bool with_defaults)
{
/* Nothing to do for daemons that don't implement any YANG module. */
if (config->dnode == NULL)
return;
/*
* Call lyd_validate() only to create default child nodes, ignoring
* any possible validation error. This doesn't need to be done when
* displaying the running configuration since it's always fully
* validated.
*/
if (config != running_config)
(void)lyd_validate_all(&config->dnode, ly_native_ctx,
LYD_VALIDATE_NO_STATE, NULL);
}
static int lyd_node_cmp(const struct lyd_node **dnode1,
const struct lyd_node **dnode2)
{
struct nb_node *nb_node = (*dnode1)->schema->priv;
return nb_node->cbs.cli_cmp(*dnode1, *dnode2);
}
static void show_dnode_children_cmds(struct vty *vty,
const struct lyd_node *root,
bool with_defaults)
{
struct nb_node *nb_node, *sort_node = NULL;
struct listnode *listnode;
struct lyd_node *child;
struct list *sort_list;
void *data;
LY_LIST_FOR (lyd_child(root), child) {
nb_node = child->schema->priv;
/*
* We finished processing current list,
* it's time to print the config.
*/
if (sort_node && nb_node != sort_node) {
list_sort(sort_list,
(int (*)(const void **,
const void **))lyd_node_cmp);
for (ALL_LIST_ELEMENTS_RO(sort_list, listnode, data))
nb_cli_show_dnode_cmds(vty, data,
with_defaults);
list_delete(&sort_list);
sort_node = NULL;
}
/*
* If the config needs to be sorted,
* then add the dnode to the sorting
* list for later processing.
*/
if (nb_node && nb_node->cbs.cli_cmp) {
if (!sort_node) {
sort_node = nb_node;
sort_list = list_new();
}
listnode_add(sort_list, child);
continue;
}
nb_cli_show_dnode_cmds(vty, child, with_defaults);
}
if (sort_node) {
list_sort(sort_list,
(int (*)(const void **, const void **))lyd_node_cmp);
for (ALL_LIST_ELEMENTS_RO(sort_list, listnode, data))
nb_cli_show_dnode_cmds(vty, data, with_defaults);
list_delete(&sort_list);
sort_node = NULL;
}
}
void nb_cli_show_dnode_cmds(struct vty *vty, const struct lyd_node *root,
bool with_defaults)
{
struct nb_node *nb_node;
if (!with_defaults && yang_dnode_is_default_recursive(root))
return;
nb_node = root->schema->priv;
if (nb_node && nb_node->cbs.cli_show)
(*nb_node->cbs.cli_show)(vty, root, with_defaults);
if (!(root->schema->nodetype & (LYS_LEAF | LYS_LEAFLIST | LYS_ANYDATA)))
show_dnode_children_cmds(vty, root, with_defaults);
if (nb_node && nb_node->cbs.cli_show_end)
(*nb_node->cbs.cli_show_end)(vty, root);
}
static void nb_cli_show_config_cmds(struct vty *vty, struct nb_config *config,
bool with_defaults)
{
struct lyd_node *root;
vty_out(vty, "Configuration:\n");
vty_out(vty, "!\n");
vty_out(vty, "frr version %s\n", FRR_VER_SHORT);
vty_out(vty, "frr defaults %s\n", frr_defaults_profile());
LY_LIST_FOR (config->dnode, root) {
nb_cli_show_dnode_cmds(vty, root, with_defaults);
}
vty_out(vty, "!\n");
vty_out(vty, "end\n");
}
static int nb_cli_show_config_libyang(struct vty *vty, LYD_FORMAT format,
struct nb_config *config,
struct yang_translator *translator,
bool with_defaults)
{
struct lyd_node *dnode;
char *strp;
int options = 0;
dnode = yang_dnode_dup(config->dnode);
if (translator
&& yang_translate_dnode(translator, YANG_TRANSLATE_FROM_NATIVE,
&dnode)
!= YANG_TRANSLATE_SUCCESS) {
vty_out(vty, "%% Failed to translate configuration\n");
yang_dnode_free(dnode);
return CMD_WARNING;
}
SET_FLAG(options, LYD_PRINT_WITHSIBLINGS);
if (with_defaults)
SET_FLAG(options, LYD_PRINT_WD_ALL);
else
SET_FLAG(options, LYD_PRINT_WD_TRIM);
if (lyd_print_mem(&strp, dnode, format, options) == 0 && strp) {
vty_out(vty, "%s", strp);
free(strp);
}
yang_dnode_free(dnode);
return CMD_SUCCESS;
}
static int nb_cli_show_config(struct vty *vty, struct nb_config *config,
enum nb_cfg_format format,
struct yang_translator *translator,
bool with_defaults)
{
nb_cli_show_config_prepare(config, with_defaults);
switch (format) {
case NB_CFG_FMT_CMDS:
nb_cli_show_config_cmds(vty, config, with_defaults);
break;
case NB_CFG_FMT_JSON:
return nb_cli_show_config_libyang(vty, LYD_JSON, config,
translator, with_defaults);
case NB_CFG_FMT_XML:
return nb_cli_show_config_libyang(vty, LYD_XML, config,
translator, with_defaults);
}
return CMD_SUCCESS;
}
static int nb_write_config(struct nb_config *config, enum nb_cfg_format format,
struct yang_translator *translator, char *path,
size_t pathlen)
{
int fd;
struct vty *file_vty;
int ret = 0;
snprintf(path, pathlen, "/tmp/frr.tmp.XXXXXXXX");
fd = mkstemp(path);
if (fd < 0) {
flog_warn(EC_LIB_SYSTEM_CALL, "%s: mkstemp() failed: %s",
__func__, safe_strerror(errno));
return -1;
}
if (fchmod(fd, CONFIGFILE_MASK) != 0) {
flog_warn(EC_LIB_SYSTEM_CALL,
"%s: fchmod() failed: %s(%d):", __func__,
safe_strerror(errno), errno);
return -1;
}
/* Make vty for configuration file. */
file_vty = vty_new();
file_vty->wfd = fd;
file_vty->type = VTY_FILE;
if (config)
ret = nb_cli_show_config(file_vty, config, format, translator,
false);
vty_close(file_vty);
return ret;
}
static int nb_cli_show_config_compare(struct vty *vty,
struct nb_config *config1,
struct nb_config *config2,
enum nb_cfg_format format,
struct yang_translator *translator)
{
char config1_path[256];
char config2_path[256];
char command[BUFSIZ];
FILE *fp;
char line[1024];
int lineno = 0;
if (nb_write_config(config1, format, translator, config1_path,
sizeof(config1_path))
!= 0) {
vty_out(vty, "%% Failed to process configurations.\n\n");
return CMD_WARNING;
}
if (nb_write_config(config2, format, translator, config2_path,
sizeof(config2_path))
!= 0) {
vty_out(vty, "%% Failed to process configurations.\n\n");
unlink(config1_path);
return CMD_WARNING;
}
snprintf(command, sizeof(command), "diff -u %s %s", config1_path,
config2_path);
fp = popen(command, "r");
if (!fp) {
vty_out(vty, "%% Failed to generate configuration diff.\n\n");
unlink(config1_path);
unlink(config2_path);
return CMD_WARNING;
}
/* Print diff line by line. */
while (fgets(line, sizeof(line), fp) != NULL) {
if (lineno++ < 2)
continue;
vty_out(vty, "%s", line);
}
pclose(fp);
unlink(config1_path);
unlink(config2_path);
return CMD_SUCCESS;
}
/* Configure exclusively from this terminal. */
DEFUN (config_exclusive,
config_exclusive_cmd,
"configure exclusive",
"Configuration from vty interface\n"
"Configure exclusively from this terminal\n")
{
return vty_config_enter(vty, true, true, false);
}
/* Configure using a private candidate configuration. */
DEFUN (config_private,
config_private_cmd,
"configure private",
"Configuration from vty interface\n"
"Configure using a private candidate configuration\n")
{
return vty_config_enter(vty, true, false, false);
}
DEFPY (config_commit,
config_commit_cmd,
"commit [{force$force|confirmed (1-60)}]",
"Commit changes into the running configuration\n"
"Force commit even if the candidate is outdated\n"
"Rollback this commit unless there is a confirming commit\n"
"Timeout in minutes for the commit to be confirmed\n")
{
return nb_cli_commit(vty, !!force, confirmed, NULL);
}
DEFPY (config_commit_comment,
config_commit_comment_cmd,
"commit [{force$force|confirmed (1-60)}] comment LINE...",
"Commit changes into the running configuration\n"
"Force commit even if the candidate is outdated\n"
"Rollback this commit unless there is a confirming commit\n"
"Timeout in minutes for the commit to be confirmed\n"
"Assign a comment to this commit\n"
"Comment for this commit (Max 80 characters)\n")
{
char *comment;
int idx = 0;
int ret;
argv_find(argv, argc, "LINE", &idx);
comment = argv_concat(argv, argc, idx);
ret = nb_cli_commit(vty, !!force, confirmed, comment);
XFREE(MTYPE_TMP, comment);
return ret;
}
DEFPY (config_commit_check,
config_commit_check_cmd,
"commit check",
"Commit changes into the running configuration\n"
"Check if the configuration changes are valid\n")
{
struct nb_context context = {};
char errmsg[BUFSIZ] = {0};
int ret;
context.client = NB_CLIENT_CLI;
context.user = vty;
ret = nb_candidate_validate(&context, vty->candidate_config, errmsg,
sizeof(errmsg));
if (ret != NB_OK) {
vty_out(vty,
"%% Failed to validate candidate configuration.\n\n");
vty_show_nb_errors(vty, ret, errmsg);
return CMD_WARNING;
}
vty_out(vty, "%% Candidate configuration validated successfully.\n\n");
return CMD_SUCCESS;
}
DEFPY (config_update,
config_update_cmd,
"update",
"Update candidate configuration\n")
{
if (!nb_candidate_needs_update(vty->candidate_config)) {
vty_out(vty, "%% Update is not necessary.\n\n");
return CMD_SUCCESS;
}
if (nb_candidate_update(vty->candidate_config) != NB_OK) {
vty_out(vty,
"%% Failed to update the candidate configuration.\n\n");
vty_out(vty, "Please check the logs for more details.\n");
return CMD_WARNING;
}
nb_config_replace(vty->candidate_config_base, running_config, true);
vty_out(vty, "%% Candidate configuration updated successfully.\n\n");
return CMD_SUCCESS;
}
DEFPY (config_discard,
config_discard_cmd,
"discard",
"Discard changes in the candidate configuration\n")
{
nb_config_replace(vty->candidate_config, vty->candidate_config_base,
true);
return CMD_SUCCESS;
}
DEFPY (config_load,
config_load_cmd,
"configuration load\
<\
file [<json$json|xml$xml> [translate WORD$translator_family]] FILENAME$filename\
|transaction (1-4294967295)$tid\
>\
[replace$replace]",
"Configuration related settings\n"
"Load configuration into candidate\n"
"Load configuration file into candidate\n"
"Load configuration file in JSON format\n"
"Load configuration file in XML format\n"
"Translate configuration file\n"
"YANG module translator\n"
"Configuration file name (full path)\n"
"Load configuration from transaction into candidate\n"
"Transaction ID\n"
"Replace instead of merge\n")
{
if (filename) {
enum nb_cfg_format format;
struct yang_translator *translator = NULL;
if (json)
format = NB_CFG_FMT_JSON;
else if (xml)
format = NB_CFG_FMT_XML;
else
format = NB_CFG_FMT_CMDS;
if (translator_family) {
translator = yang_translator_find(translator_family);
if (!translator) {
vty_out(vty,
"%% Module translator \"%s\" not found\n",
translator_family);
return CMD_WARNING;
}
}
return nb_cli_candidate_load_file(vty, format, translator,
filename, !!replace);
}
return nb_cli_candidate_load_transaction(vty, tid, !!replace);
}
DEFPY (show_config_running,
show_config_running_cmd,
"show configuration running\
[<json$json|xml$xml> [translate WORD$translator_family]]\
[with-defaults$with_defaults]",
SHOW_STR
"Configuration information\n"
"Running configuration\n"
"Change output format to JSON\n"
"Change output format to XML\n"
"Translate output\n"
"YANG module translator\n"
"Show default values\n")
{
enum nb_cfg_format format;
struct yang_translator *translator = NULL;
if (json)
format = NB_CFG_FMT_JSON;
else if (xml)
format = NB_CFG_FMT_XML;
else
format = NB_CFG_FMT_CMDS;
if (translator_family) {
translator = yang_translator_find(translator_family);
if (!translator) {
vty_out(vty, "%% Module translator \"%s\" not found\n",
translator_family);
return CMD_WARNING;
}
}
nb_cli_show_config(vty, running_config, format, translator,
!!with_defaults);
return CMD_SUCCESS;
}
DEFPY (show_config_candidate,
show_config_candidate_cmd,
"show configuration candidate\
[<json$json|xml$xml> [translate WORD$translator_family]]\
[<\
with-defaults$with_defaults\
|changes$changes\
>]",
SHOW_STR
"Configuration information\n"
"Candidate configuration\n"
"Change output format to JSON\n"
"Change output format to XML\n"
"Translate output\n"
"YANG module translator\n"
"Show default values\n"
"Show changes applied in the candidate configuration\n")
{
enum nb_cfg_format format;
struct yang_translator *translator = NULL;
if (json)
format = NB_CFG_FMT_JSON;
else if (xml)
format = NB_CFG_FMT_XML;
else
format = NB_CFG_FMT_CMDS;
if (translator_family) {
translator = yang_translator_find(translator_family);
if (!translator) {
vty_out(vty, "%% Module translator \"%s\" not found\n",
translator_family);
return CMD_WARNING;
}
}
if (changes)
return nb_cli_show_config_compare(
vty, vty->candidate_config_base, vty->candidate_config,
format, translator);
nb_cli_show_config(vty, vty->candidate_config, format, translator,
!!with_defaults);
return CMD_SUCCESS;
}
DEFPY (show_config_candidate_section,
show_config_candidate_section_cmd,
"show",
SHOW_STR)
{
struct lyd_node *dnode;
/* Top-level configuration node, display everything. */
if (vty->xpath_index == 0)
return nb_cli_show_config(vty, vty->candidate_config,
NB_CFG_FMT_CMDS, NULL, false);
/* Display only the current section of the candidate configuration. */
dnode = yang_dnode_get(vty->candidate_config->dnode, VTY_CURR_XPATH);
if (!dnode)
/* Shouldn't happen. */
return CMD_WARNING;
nb_cli_show_dnode_cmds(vty, dnode, 0);
vty_out(vty, "!\n");
return CMD_SUCCESS;
}
DEFPY (show_config_compare,
show_config_compare_cmd,
"show configuration compare\
<\
candidate$c1_candidate\
|running$c1_running\
|transaction (1-4294967295)$c1_tid\
>\
<\
candidate$c2_candidate\
|running$c2_running\
|transaction (1-4294967295)$c2_tid\
>\
[<json$json|xml$xml> [translate WORD$translator_family]]",
SHOW_STR
"Configuration information\n"
"Compare two different configurations\n"
"Candidate configuration\n"
"Running configuration\n"
"Configuration transaction\n"
"Transaction ID\n"
"Candidate configuration\n"
"Running configuration\n"
"Configuration transaction\n"
"Transaction ID\n"
"Change output format to JSON\n"
"Change output format to XML\n"
"Translate output\n"
"YANG module translator\n")
{
enum nb_cfg_format format;
struct yang_translator *translator = NULL;
struct nb_config *config1, *config_transaction1 = NULL;
struct nb_config *config2, *config_transaction2 = NULL;
int ret = CMD_WARNING;
if (c1_candidate)
config1 = vty->candidate_config;
else if (c1_running)
config1 = running_config;
else {
config_transaction1 = nb_db_transaction_load(c1_tid);
if (!config_transaction1) {
vty_out(vty, "%% Transaction %u does not exist\n\n",
(unsigned int)c1_tid);
goto exit;
}
config1 = config_transaction1;
}
if (c2_candidate)
config2 = vty->candidate_config;
else if (c2_running)
config2 = running_config;
else {
config_transaction2 = nb_db_transaction_load(c2_tid);
if (!config_transaction2) {
vty_out(vty, "%% Transaction %u does not exist\n\n",
(unsigned int)c2_tid);
goto exit;
}
config2 = config_transaction2;
}
if (json)
format = NB_CFG_FMT_JSON;
else if (xml)
format = NB_CFG_FMT_XML;
else
format = NB_CFG_FMT_CMDS;
if (translator_family) {
translator = yang_translator_find(translator_family);
if (!translator) {
vty_out(vty, "%% Module translator \"%s\" not found\n",
translator_family);
goto exit;
}
}
ret = nb_cli_show_config_compare(vty, config1, config2, format,
translator);
exit:
if (config_transaction1)
nb_config_free(config_transaction1);
if (config_transaction2)
nb_config_free(config_transaction2);
return ret;
}
/*
* Stripped down version of the "show configuration compare" command.
* The "candidate" option is not present so the command can be installed in
* the enable node.
*/
ALIAS (show_config_compare,
show_config_compare_without_candidate_cmd,
"show configuration compare\
<\
running$c1_running\
|transaction (1-4294967295)$c1_tid\
>\
<\
running$c2_running\
|transaction (1-4294967295)$c2_tid\
>\
[<json$json|xml$xml> [translate WORD$translator_family]]",
SHOW_STR
"Configuration information\n"
"Compare two different configurations\n"
"Running configuration\n"
"Configuration transaction\n"
"Transaction ID\n"
"Running configuration\n"
"Configuration transaction\n"
"Transaction ID\n"
"Change output format to JSON\n"
"Change output format to XML\n"
"Translate output\n"
"YANG module translator\n")
DEFPY (clear_config_transactions,
clear_config_transactions_cmd,
"clear configuration transactions oldest (1-100)$n",
CLEAR_STR
"Configuration activity\n"
"Delete transactions from the transactions log\n"
"Delete oldest <n> transactions\n"
"Number of transactions to delete\n")
{
#ifdef HAVE_CONFIG_ROLLBACKS
if (nb_db_clear_transactions(n) != NB_OK) {
vty_out(vty, "%% Failed to delete transactions.\n\n");
return CMD_WARNING;
}
#else
vty_out(vty,
"%% FRR was compiled without --enable-config-rollbacks.\n\n");
#endif /* HAVE_CONFIG_ROLLBACKS */
return CMD_SUCCESS;
}
DEFPY (config_database_max_transactions,
config_database_max_transactions_cmd,
"configuration database max-transactions (1-100)$max",
"Configuration related settings\n"
"Configuration database\n"
"Set the maximum number of transactions to store\n"
"Number of transactions\n")
{
#ifdef HAVE_CONFIG_ROLLBACKS
if (nb_db_set_max_transactions(max) != NB_OK) {
vty_out(vty,
"%% Failed to update the maximum number of transactions.\n\n");
return CMD_WARNING;
}
vty_out(vty,
"%% Maximum number of transactions updated successfully.\n\n");
#else
vty_out(vty,
"%% FRR was compiled without --enable-config-rollbacks.\n\n");
#endif /* HAVE_CONFIG_ROLLBACKS */
return CMD_SUCCESS;
}
DEFPY (yang_module_translator_load,
yang_module_translator_load_cmd,
"yang module-translator load FILENAME$filename",
"YANG related settings\n"
"YANG module translator\n"
"Load YANG module translator\n"
"File name (full path)\n")
{
struct yang_translator *translator;
translator = yang_translator_load(filename);
if (!translator) {
vty_out(vty, "%% Failed to load \"%s\"\n\n", filename);
vty_out(vty, "Please check the logs for more details.\n");
return CMD_WARNING;
}
vty_out(vty, "%% Module translator \"%s\" loaded successfully.\n\n",
translator->family);
return CMD_SUCCESS;
}
DEFPY (yang_module_translator_unload_family,
yang_module_translator_unload_cmd,
"yang module-translator unload WORD$translator_family",
"YANG related settings\n"
"YANG module translator\n"
"Unload YANG module translator\n"
"Name of the module translator\n")
{
struct yang_translator *translator;
translator = yang_translator_find(translator_family);
if (!translator) {
vty_out(vty, "%% Module translator \"%s\" not found\n",
translator_family);
return CMD_WARNING;
}
yang_translator_unload(translator);
return CMD_SUCCESS;
}
#ifdef HAVE_CONFIG_ROLLBACKS
static void nb_cli_show_transactions_cb(void *arg, int transaction_id,
const char *client_name,
const char *date, const char *comment)
{
struct ttable *tt = arg;
ttable_add_row(tt, "%d|%s|%s|%s", transaction_id, client_name, date,
comment);
}
static int nb_cli_show_transactions(struct vty *vty)
{
struct ttable *tt;
/* Prepare table. */
tt = ttable_new(&ttable_styles[TTSTYLE_BLANK]);
ttable_add_row(tt, "Transaction ID|Client|Date|Comment");
tt->style.cell.rpad = 2;
tt->style.corner = '+';
ttable_restyle(tt);
ttable_rowseps(tt, 0, BOTTOM, true, '-');
/* Fetch transactions from the northbound database. */
if (nb_db_transactions_iterate(nb_cli_show_transactions_cb, tt)
!= NB_OK) {
vty_out(vty,
"%% Failed to fetch configuration transactions.\n");
return CMD_WARNING;
}
/* Dump the generated table. */
if (tt->nrows > 1) {
char *table;
table = ttable_dump(tt, "\n");
vty_out(vty, "%s\n", table);
XFREE(MTYPE_TMP_TTABLE, table);
} else
vty_out(vty, "No configuration transactions to display.\n\n");
ttable_del(tt);
return CMD_SUCCESS;
}
#endif /* HAVE_CONFIG_ROLLBACKS */
DEFPY (show_config_transaction,
show_config_transaction_cmd,
"show configuration transaction\
[\
(1-4294967295)$transaction_id\
[<json$json|xml$xml> [translate WORD$translator_family]]\
[<\
with-defaults$with_defaults\
|changes$changes\
>]\
]",
SHOW_STR
"Configuration information\n"
"Configuration transaction\n"
"Transaction ID\n"
"Change output format to JSON\n"
"Change output format to XML\n"
"Translate output\n"
"YANG module translator\n"
"Show default values\n"
"Show changes compared to the previous transaction\n")
{
#ifdef HAVE_CONFIG_ROLLBACKS
if (transaction_id) {
struct nb_config *config;
enum nb_cfg_format format;
struct yang_translator *translator = NULL;
if (json)
format = NB_CFG_FMT_JSON;
else if (xml)
format = NB_CFG_FMT_XML;
else
format = NB_CFG_FMT_CMDS;
if (translator_family) {
translator = yang_translator_find(translator_family);
if (!translator) {
vty_out(vty,
"%% Module translator \"%s\" not found\n",
translator_family);
return CMD_WARNING;
}
}
config = nb_db_transaction_load(transaction_id);
if (!config) {
vty_out(vty, "%% Transaction %u does not exist.\n\n",
(unsigned int)transaction_id);
return CMD_WARNING;
}
if (changes) {
struct nb_config *prev_config;
int ret;
/* NOTE: this can be NULL. */
prev_config =
nb_db_transaction_load(transaction_id - 1);
ret = nb_cli_show_config_compare(
vty, prev_config, config, format, translator);
if (prev_config)
nb_config_free(prev_config);
nb_config_free(config);
return ret;
}
nb_cli_show_config(vty, config, format, translator,
!!with_defaults);
nb_config_free(config);
return CMD_SUCCESS;
}
return nb_cli_show_transactions(vty);
#else
vty_out(vty,
"%% FRR was compiled without --enable-config-rollbacks.\n\n");
return CMD_WARNING;
#endif /* HAVE_CONFIG_ROLLBACKS */
}
static int nb_cli_oper_data_cb(const struct lysc_node *snode,
struct yang_translator *translator,
struct yang_data *data, void *arg)
{
struct lyd_node *dnode = arg;
struct ly_ctx *ly_ctx;
if (translator) {
int ret;
ret = yang_translate_xpath(translator,
YANG_TRANSLATE_FROM_NATIVE,
data->xpath, sizeof(data->xpath));
switch (ret) {
case YANG_TRANSLATE_SUCCESS:
break;
case YANG_TRANSLATE_NOTFOUND:
goto exit;
case YANG_TRANSLATE_FAILURE:
goto error;
}
ly_ctx = translator->ly_ctx;
} else
ly_ctx = ly_native_ctx;
LY_ERR err =
lyd_new_path(dnode, ly_ctx, data->xpath, (void *)data->value,
LYD_NEW_PATH_UPDATE, &dnode);
if (err) {
flog_warn(EC_LIB_LIBYANG, "%s: lyd_new_path(%s) failed: %s",
__func__, data->xpath, ly_errmsg(ly_native_ctx));
goto error;
}
exit:
return NB_OK;
error:
return NB_ERR;
}
DEFPY (show_yang_operational_data,
show_yang_operational_data_cmd,
"show yang operational-data XPATH$xpath\
[{\
format <json$json|xml$xml>\
|translate WORD$translator_family\
|with-config$with_config\
}]",
SHOW_STR
"YANG information\n"
"Show YANG operational data\n"
"XPath expression specifying the YANG data path\n"
"Set the output format\n"
"JavaScript Object Notation\n"
"Extensible Markup Language\n"
"Translate operational data\n"
"YANG module translator\n"
"Merge configuration data\n")
{
LYD_FORMAT format;
struct yang_translator *translator = NULL;
struct ly_ctx *ly_ctx;
struct lyd_node *dnode;
char *strp;
uint32_t print_options = LYD_PRINT_WITHSIBLINGS;
int ret;
if (xml)
format = LYD_XML;
else
format = LYD_JSON;
if (translator_family) {
translator = yang_translator_find(translator_family);
if (!translator) {
vty_out(vty, "%% Module translator \"%s\" not found\n",
translator_family);
return CMD_WARNING;
}
ly_ctx = translator->ly_ctx;
} else
ly_ctx = ly_native_ctx;
/* Obtain data. */
if (translator) {
dnode = yang_dnode_new(ly_ctx, false);
ret = nb_oper_iterate_legacy(xpath, translator, 0,
nb_cli_oper_data_cb, dnode, NULL);
} else {
dnode = NULL;
ret = nb_oper_iterate_legacy(xpath, NULL, 0, NULL, NULL, &dnode);
}
if (ret != NB_OK) {
if (format == LYD_JSON)
vty_out(vty, "{}\n");
else {
/* embed ly_last_errmsg() when we get newer libyang */
vty_out(vty, "<!-- Not found -->\n");
}
if (dnode)
yang_dnode_free(dnode);
return CMD_WARNING;
}
if (with_config && yang_dnode_exists(running_config->dnode, xpath)) {
struct lyd_node *config_dnode =
yang_dnode_get(running_config->dnode, xpath);
if (config_dnode != NULL) {
lyd_merge_tree(&dnode, yang_dnode_dup(config_dnode),
LYD_MERGE_DESTRUCT);
print_options |= LYD_PRINT_WD_ALL;
}
}
(void)lyd_validate_all(&dnode, ly_ctx, 0, NULL);
/* Display the data. */
if (lyd_print_mem(&strp, dnode, format, print_options) != 0 || !strp) {
vty_out(vty, "%% Failed to display operational data.\n");
yang_dnode_free(dnode);
return CMD_WARNING;
}
vty_out(vty, "%s", strp);
free(strp);
yang_dnode_free(dnode);
return CMD_SUCCESS;
}
DEFPY (show_yang_module,
show_yang_module_cmd,
"show yang module [module-translator WORD$translator_family]",
SHOW_STR
"YANG information\n"
"Show loaded modules\n"
"YANG module translator\n"
"YANG module translator\n")
{
struct ly_ctx *ly_ctx;
struct yang_translator *translator = NULL;
const struct lys_module *module;
struct ttable *tt;
uint32_t idx = 0;
if (translator_family) {
translator = yang_translator_find(translator_family);
if (!translator) {
vty_out(vty, "%% Module translator \"%s\" not found\n",
translator_family);
return CMD_WARNING;
}
ly_ctx = translator->ly_ctx;
} else
ly_ctx = ly_native_ctx;
/* Prepare table. */
tt = ttable_new(&ttable_styles[TTSTYLE_BLANK]);
ttable_add_row(tt, "Module|Version|Revision|Flags|Namespace");
tt->style.cell.rpad = 2;
tt->style.corner = '+';
ttable_restyle(tt);
ttable_rowseps(tt, 0, BOTTOM, true, '-');
while ((module = ly_ctx_get_module_iter(ly_ctx, &idx))) {
char flags[8];
snprintf(flags, sizeof(flags), "%c%c",
module->implemented ? 'I' : ' ',
LY_ARRAY_COUNT(module->deviated_by) ? 'D' : ' ');
ttable_add_row(tt, "%s|%s|%s|%s|%s", module->name,
(module->parsed->version == 2) ? "1.1" : "1.0",
module->revision ? module->revision : "-", flags,
module->ns);
}
/* Dump the generated table. */
if (tt->nrows > 1) {
char *table;
vty_out(vty, " Flags: I - Implemented, D - Deviated\n\n");
table = ttable_dump(tt, "\n");
vty_out(vty, "%s\n", table);
XFREE(MTYPE_TMP_TTABLE, table);
} else
vty_out(vty, "No YANG modules to display.\n\n");
ttable_del(tt);
return CMD_SUCCESS;
}
DEFPY(show_yang_module_detail, show_yang_module_detail_cmd,
"show yang module\
[module-translator WORD$translator_family]\
WORD$module_name <compiled$compiled|summary|tree$tree|yang$yang|yin$yin>",
SHOW_STR
"YANG information\n"
"Show loaded modules\n"
"YANG module translator\n"
"YANG module translator\n"
"Module name\n"
"Display compiled module in YANG format\n"
"Display summary information about the module\n"
"Display module in the tree (RFC 8340) format\n"
"Display module in the YANG format\n"
"Display module in the YIN format\n")
{
struct ly_ctx *ly_ctx;
struct yang_translator *translator = NULL;
const struct lys_module *module;
LYS_OUTFORMAT format;
char *strp;
if (translator_family) {
translator = yang_translator_find(translator_family);
if (!translator) {
vty_out(vty, "%% Module translator \"%s\" not found\n",
translator_family);
return CMD_WARNING;
}
ly_ctx = translator->ly_ctx;
} else
ly_ctx = ly_native_ctx;
module = ly_ctx_get_module_latest(ly_ctx, module_name);
if (!module) {
vty_out(vty, "%% Module \"%s\" not found\n", module_name);
return CMD_WARNING;
}
if (yang)
format = LYS_OUT_YANG;
else if (yin)
format = LYS_OUT_YIN;
else if (compiled)
format = LYS_OUT_YANG_COMPILED;
else if (tree)
format = LYS_OUT_TREE;
else {
vty_out(vty,
"%% libyang v2 does not currently support summary\n");
return CMD_WARNING;
}
if (lys_print_mem(&strp, module, format, 0) == 0) {
vty_out(vty, "%s\n", strp);
free(strp);
} else {
/* Unexpected. */
vty_out(vty, "%% Error generating module information\n");
return CMD_WARNING;
}
return CMD_SUCCESS;
}
DEFPY (show_yang_module_translator,
show_yang_module_translator_cmd,
"show yang module-translator",
SHOW_STR
"YANG information\n"
"Show loaded YANG module translators\n")
{
struct yang_translator *translator;
struct ttable *tt;
/* Prepare table. */
tt = ttable_new(&ttable_styles[TTSTYLE_BLANK]);
ttable_add_row(tt, "Family|Module|Deviations|Coverage (%%)");
tt->style.cell.rpad = 2;
tt->style.corner = '+';
ttable_restyle(tt);
ttable_rowseps(tt, 0, BOTTOM, true, '-');
RB_FOREACH (translator, yang_translators, &yang_translators) {
struct yang_tmodule *tmodule;
struct listnode *ln;
for (ALL_LIST_ELEMENTS_RO(translator->modules, ln, tmodule)) {
ttable_add_row(tt, "%s|%s|%s|%.2f", translator->family,
tmodule->module->name,
tmodule->deviations->name,
tmodule->coverage);
}
}
/* Dump the generated table. */
if (tt->nrows > 1) {
char *table;
table = ttable_dump(tt, "\n");
vty_out(vty, "%s\n", table);
XFREE(MTYPE_TMP_TTABLE, table);
} else
vty_out(vty, "No YANG module translators to display.\n\n");
ttable_del(tt);
return CMD_SUCCESS;
}
#ifdef HAVE_CONFIG_ROLLBACKS
static int nb_cli_rollback_configuration(struct vty *vty,
uint32_t transaction_id)
{
struct nb_context context = {};
struct nb_config *candidate;
char comment[80];
char errmsg[BUFSIZ] = {0};
int ret;
candidate = nb_db_transaction_load(transaction_id);
if (!candidate) {
vty_out(vty, "%% Transaction %u does not exist.\n\n",
transaction_id);
return CMD_WARNING;
}
snprintf(comment, sizeof(comment), "Rollback to transaction %u",
transaction_id);
context.client = NB_CLIENT_CLI;
context.user = vty;
ret = nb_candidate_commit(context, candidate, true, comment, NULL,
errmsg, sizeof(errmsg));
nb_config_free(candidate);
switch (ret) {
case NB_OK:
vty_out(vty,
"%% Configuration was successfully rolled back.\n\n");
/* Print warnings (if any). */
if (strlen(errmsg) > 0)
vty_out(vty, "%s\n", errmsg);
return CMD_SUCCESS;
case NB_ERR_NO_CHANGES:
vty_out(vty,
"%% Aborting - no configuration changes detected.\n\n");
return CMD_WARNING;
default:
vty_out(vty, "%% Rollback failed.\n\n");
vty_show_nb_errors(vty, ret, errmsg);
return CMD_WARNING;
}
}
#endif /* HAVE_CONFIG_ROLLBACKS */
DEFPY (rollback_config,
rollback_config_cmd,
"rollback configuration (1-4294967295)$transaction_id",
"Rollback to a previous state\n"
"Running configuration\n"
"Transaction ID\n")
{
#ifdef HAVE_CONFIG_ROLLBACKS
return nb_cli_rollback_configuration(vty, transaction_id);
#else
vty_out(vty,
"%% FRR was compiled without --enable-config-rollbacks.\n\n");
return CMD_SUCCESS;
#endif /* HAVE_CONFIG_ROLLBACKS */
}
/* Debug CLI commands. */
DEFPY (debug_nb,
debug_nb_cmd,
"[no] debug northbound\
[<\
callbacks$cbs [{configuration$cbs_cfg|state$cbs_state|rpc$cbs_rpc|notify$cbs_notify}]\
|notifications$notifications\
|events$events\
|libyang$libyang\
>]",
NO_STR
DEBUG_STR
"Northbound debugging\n"
"Callbacks\n"
"Configuration\n"
"State\n"
"RPC\n"
"Notifications\n"
"Notifications\n"
"Events\n"
"libyang debugging\n")
{
uint32_t mode = DEBUG_NODE2MODE(vty->node);
bool all = false;
/* no specific debug --> act on all of them */
if (strmatch(argv[argc - 1]->text, "northbound"))
all = true;
if (cbs || all) {
bool none = (!cbs_cfg && !cbs_state && !cbs_rpc && !cbs_notify);
if (none || cbs_cfg)
DEBUG_MODE_SET(&nb_dbg_cbs_config, mode, !no);
if (none || cbs_state)
DEBUG_MODE_SET(&nb_dbg_cbs_state, mode, !no);
if (none || cbs_rpc)
DEBUG_MODE_SET(&nb_dbg_cbs_rpc, mode, !no);
if (none || cbs_notify)
DEBUG_MODE_SET(&nb_dbg_cbs_notify, mode, !no);
}
if (notifications || all)
DEBUG_MODE_SET(&nb_dbg_notif, mode, !no);
if (events || all)
DEBUG_MODE_SET(&nb_dbg_events, mode, !no);
if (libyang || all) {
DEBUG_MODE_SET(&nb_dbg_libyang, mode, !no);
yang_debugging_set(!no);
}
return CMD_SUCCESS;
}
void nb_cli_install_default(int node)
{
_install_element(node, &show_config_candidate_section_cmd);
if (frr_get_cli_mode() != FRR_CLI_TRANSACTIONAL)
return;
_install_element(node, &config_commit_cmd);
_install_element(node, &config_commit_comment_cmd);
_install_element(node, &config_commit_check_cmd);
_install_element(node, &config_update_cmd);
_install_element(node, &config_discard_cmd);
_install_element(node, &show_config_running_cmd);
_install_element(node, &show_config_candidate_cmd);
_install_element(node, &show_config_compare_cmd);
_install_element(node, &show_config_transaction_cmd);
}
/* YANG module autocomplete. */
static void yang_module_autocomplete(vector comps, struct cmd_token *token)
{
const struct lys_module *module;
struct yang_translator *module_tr;
uint32_t idx;
idx = 0;
while ((module = ly_ctx_get_module_iter(ly_native_ctx, &idx)))
vector_set(comps, XSTRDUP(MTYPE_COMPLETION, module->name));
RB_FOREACH (module_tr, yang_translators, &yang_translators) {
idx = 0;
while ((module = ly_ctx_get_module_iter(module_tr->ly_ctx,
&idx)))
vector_set(comps,
XSTRDUP(MTYPE_COMPLETION, module->name));
}
}
/* YANG module translator autocomplete. */
static void yang_translator_autocomplete(vector comps, struct cmd_token *token)
{
struct yang_translator *module_tr;
RB_FOREACH (module_tr, yang_translators, &yang_translators)
vector_set(comps, XSTRDUP(MTYPE_COMPLETION, module_tr->family));
}
static const struct cmd_variable_handler yang_var_handlers[] = {
{.varname = "module_name", .completions = yang_module_autocomplete},
{.varname = "translator_family",
.completions = yang_translator_autocomplete},
{.completions = NULL}};
void nb_cli_init(struct event_loop *tm)
{
master = tm;
/* Initialize the shared candidate configuration. */
vty_shared_candidate_config = nb_config_new(NULL);
debug_install(&nb_dbg_cbs_config);
debug_install(&nb_dbg_cbs_state);
debug_install(&nb_dbg_cbs_rpc);
debug_install(&nb_dbg_cbs_notify);
debug_install(&nb_dbg_notif);
debug_install(&nb_dbg_events);
debug_install(&nb_dbg_libyang);
install_element(ENABLE_NODE, &debug_nb_cmd);
install_element(CONFIG_NODE, &debug_nb_cmd);
/* Install commands specific to the transaction-base mode. */
if (frr_get_cli_mode() == FRR_CLI_TRANSACTIONAL) {
install_element(ENABLE_NODE, &config_exclusive_cmd);
install_element(ENABLE_NODE, &config_private_cmd);
install_element(ENABLE_NODE,
&show_config_compare_without_candidate_cmd);
install_element(ENABLE_NODE, &show_config_transaction_cmd);
install_element(ENABLE_NODE, &rollback_config_cmd);
install_element(ENABLE_NODE, &clear_config_transactions_cmd);
install_element(CONFIG_NODE, &config_load_cmd);
install_element(CONFIG_NODE,
&config_database_max_transactions_cmd);
}
/* Other commands. */
install_element(ENABLE_NODE, &show_config_running_cmd);
install_element(CONFIG_NODE, &yang_module_translator_load_cmd);
install_element(CONFIG_NODE, &yang_module_translator_unload_cmd);
install_element(ENABLE_NODE, &show_yang_operational_data_cmd);
install_element(ENABLE_NODE, &show_yang_module_cmd);
install_element(ENABLE_NODE, &show_yang_module_detail_cmd);
install_element(ENABLE_NODE, &show_yang_module_translator_cmd);
cmd_variable_handler_register(yang_var_handlers);
}
void nb_cli_terminate(void)
{
nb_config_free(vty_shared_candidate_config);
}
|