ipsec: increment SPD policy counters for bypass and discard actions in ipsec4_input_node - vpp

about summary refs log tree commit diff stats

diff options

author	Zachary Leaf <zachary.leaf@arm.com>	2021-06-07 03:01:07 -0500
committer	Neale Ranns <neale@graphiant.com>	2021-06-29 14:52:41 +0000
commit	fbab65bc1c186a3029804e32e678c0fe7f823f8e (patch)
tree	529284dd5aba361b33e3e51be27afa47b618f6b5 /src/vnet
parent	b940fd4d5a16b62a5aa09b924140a135fd06c6bb (diff)

ipsec: increment SPD policy counters for bypass and discard actions in ipsec4_input_node

ipsec_spd_policy_counters are incremented only for matched inbound PROTECT actions (:273 and :370). BYPASS + DISCARD actions also have SPD policy counters that should be incremented on match. This fix increments the counters for inbound BYPASS and DISCARD actions. Type: fix Signed-off-by: Zachary Leaf <zachary.leaf@arm.com> Change-Id: Iac3c6d344be25ba5326e1ed45115ca299dee5f49

Diffstat (limited to 'src/vnet')

-rw-r--r--

src/vnet/ipsec/ipsec_input.c

1 files changed, 20 insertions, 0 deletions

2'>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

# Copyright (c) 2016 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Keywords to manipulate interface configuration using Honeycomb REST API.

The keywords make possible to put and get configuration data and to get
operational data.
"""
from robot.api import logger

from resources.libraries.python.topology import Topology
from resources.libraries.python.HTTPRequest import HTTPCodes
from resources.libraries.python.honeycomb.HoneycombSetup import HoneycombError
from resources.libraries.python.honeycomb.HoneycombUtil \
    import DataRepresentation
from resources.libraries.python.honeycomb.HoneycombUtil \
    import HoneycombUtil as HcUtil


# pylint: disable=too-many-public-methods
# pylint: disable=too-many-lines
class InterfaceKeywords(object):
    """Keywords for Interface manipulation.

    Implements keywords which get configuration and operational data about
    vpp interfaces and set the interface's parameters using Honeycomb REST API.
    """

    INTF_PARAMS = ("name", "description", "type", "enabled",
                   "link-up-down-trap-enable", "v3po:l2", "v3po:vxlan-gpe",
                   "vpp-vlan:sub-interfaces")
    IPV4_PARAMS = ("enabled", "forwarding", "mtu")
    IPV6_PARAMS = ("enabled", "forwarding", "mtu", "dup-addr-detect-transmits")
    IPV6_AUTOCONF_PARAMS = ("create-global-addresses",
                            "create-temporary-addresses",
                            "temporary-valid-lifetime",
                            "temporary-preferred-lifetime")
    ETH_PARAMS = ("mtu", )
    ROUTING_PARAMS = ("vrf-id", )
    VXLAN_PARAMS = ("src", "dst", "vni", "encap-vrf-id")
    L2_PARAMS = ("bridge-domain", "split-horizon-group",
                 "bridged-virtual-interface")
    TAP_PARAMS = ("tap-name", "mac", "device-instance")
    VHOST_USER_PARAMS = ("socket", "role")
    SUB_IF_PARAMS = ("identifier",
                     "vlan-type",
                     "enabled")
    SUB_IF_MATCH = ("default",
                    "untagged",
                    "vlan-tagged",
                    "vlan-tagged-exact-match")
    BD_PARAMS = ("bridge-domain",
                 "split-horizon-group",
                 "bridged-virtual-interface")
    VXLAN_GPE_PARAMS = ("local",
                        "remote",
                        "vni",
                        "next-protocol",
                        "encap-vrf-id",
                        "decap-vrf-id")

    def __init__(self):
        pass

    @staticmethod
    def _configure_interface(node, interface, data,
                             data_representation=DataRepresentation.JSON):
        """Send interface configuration data and check the response.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param data: Configuration data to be sent in PUT request.
        :param data_representation: How the data is represented.
        :type node: dict
        :type interface: str
        :type data: dict
        :type data_representation: DataRepresentation
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the status code in response on PUT is not
        200 = OK.
        """

        status_code, resp = HcUtil.\
            put_honeycomb_data(node, "config_vpp_interfaces", data,
                               data_representation=data_representation)
        if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
            raise HoneycombError(
                "The configuration of interface '{0}' was not successful. "
                "Status code: {1}.".format(interface, status_code))
        return resp

    @staticmethod
    def get_all_interfaces_cfg_data(node):
        """Get configuration data about all interfaces from Honeycomb.

        :param node: Honeycomb node.
        :type node: dict
        :returns: Configuration data about all interfaces from Honeycomb.
        :rtype: list
        :raises HoneycombError: If it is not possible to get configuration data.
        """

        status_code, resp = HcUtil.\
            get_honeycomb_data(node, "config_vpp_interfaces")
        if status_code != HTTPCodes.OK:
            raise HoneycombError(
                "Not possible to get configuration information about the "
                "interfaces. Status code: {0}.".format(status_code))
        try:
            return resp["interfaces"]["interface"]

        except (KeyError, TypeError):
            return []

    @staticmethod
    def get_interface_cfg_data(node, interface):
        """Get configuration data about the given interface from Honeycomb.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :type node: dict
        :type interface: str
        :returns: Configuration data about the given interface from Honeycomb.
        :rtype: dict
        """

        intfs = InterfaceKeywords.get_all_interfaces_cfg_data(node)
        for intf in intfs:
            if intf["name"] == interface:
                return intf
        return {}

    @staticmethod
    def get_all_interfaces_oper_data(node):
        """Get operational data about all interfaces from Honeycomb.

        :param node: Honeycomb node.
        :type node: dict
        :returns: Operational data about all interfaces from Honeycomb.
        :rtype: list
        :raises HoneycombError: If it is not possible to get operational data.
        """

        status_code, resp = HcUtil.\
            get_honeycomb_data(node, "oper_vpp_interfaces")
        if status_code != HTTPCodes.OK:
            raise HoneycombError(
                "Not possible to get operational information about the "
                "interfaces. Status code: {0}.".format(status_code))
        try:
            return resp["interfaces-state"]["interface"]

        except (KeyError, TypeError):
            return []

    @staticmethod
    def get_disabled_interfaces_oper_data(node):
        """Get operational data about all disabled interfaces from Honeycomb.

        :param node: Honeycomb node.
        :type node: dict
        :returns: Operational data about disabled interfaces.
        :rtype: list
        :raises HoneycombError: If it is not possible to get operational data.
        """

        status_code, resp = HcUtil. \
            get_honeycomb_data(node, "oper_disabled_interfaces")
        if status_code == HTTPCodes.NOT_FOUND:
            raise HoneycombError(
                "No disabled interfaces present on node."
            )
        if status_code != HTTPCodes.OK:
            raise HoneycombError(
                "Not possible to get operational information about the "
                "interfaces. Status code: {0}.".format(status_code))
        try:
            return resp["disabled-interfaces"]["disabled-interface-index"]

        except (KeyError, TypeError):
            return []

    @staticmethod
    def get_interface_oper_data(node, interface):
        """Get operational data about the given interface from Honeycomb.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :type node: dict
        :type interface: str
        :returns: Operational data about the given interface from Honeycomb.
        :rtype: dict
        """

        intfs = InterfaceKeywords.get_all_interfaces_oper_data(node)
        for intf in intfs:
            if intf["name"] == interface:
                return intf
        return {}

    @staticmethod
    def _set_interface_properties(node, interface, path, new_value=None):
        """Set interface properties.

        This method reads interface configuration data, creates, changes or
        removes the requested data and puts it back to Honeycomb.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param path:  Path to data we want to change / create / remove.
        :param new_value: The new value to be set. If None, the item will be
        removed.
        :type node: dict
        :type interface: str
        :type path: tuple
        :type new_value: str, dict or list
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If it is not possible to get or set the data.
        """

        status_code, resp = HcUtil.\
            get_honeycomb_data(node, "config_vpp_interfaces")
        if status_code != HTTPCodes.OK:
            raise HoneycombError(
                "Not possible to get configuration information about the "
                "interfaces. Status code: {0}.".format(status_code))

        if new_value:
            new_data = HcUtil.set_item_value(resp, path, new_value)
        else:
            new_data = HcUtil.remove_item(resp, path)
        return InterfaceKeywords._configure_interface(node, interface, new_data)

    @staticmethod
    def set_interface_state(node, interface, state="up"):
        """Set VPP interface state.

        The keyword changes the administration state of interface to up or down
        depending on the parameter "state".

        :param node: Honeycomb node.
        :param interface: Interface name, key, link name or sw_if_index.
        :param state: The requested state, only "up" and "down" are valid
        values.
        :type node: dict
        :type interface: str
        :type state: str
        :returns: Content of response.
        :rtype: bytearray
        :raises KeyError: If the argument "state" is nor "up" or "down".
        :raises HoneycombError: If the interface is not present on the node.
        """

        intf_state = {"up": "true",
                      "down": "false"}

        interface = Topology.convert_interface_reference(
            node, interface, "name")

        intf = interface.replace("/", "%2F")
        path = "/interface/{0}".format(intf)

        status_code, resp = HcUtil.\
            get_honeycomb_data(node, "config_vpp_interfaces", path)
        if status_code != HTTPCodes.OK:
            raise HoneycombError(
                "Not possible to get configuration information about the "
                "interfaces. Status code: {0}.".format(status_code))

        resp["interface"][0]["enabled"] = intf_state[state.lower()]

        status_code, resp = HcUtil. \
            put_honeycomb_data(node, "config_vpp_interfaces", resp, path,
                               data_representation=DataRepresentation.JSON)
        if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
            raise HoneycombError(
                "The configuration of interface '{0}' was not successful. "
                "Status code: {1}.".format(interface, status_code))
        return resp

    @staticmethod
    def set_interface_up(node, interface):
        """Set the administration state of VPP interface to up.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :type node: dict
        :type interface: str
        :returns: Content of response
        :rtype: bytearray
        """

        return InterfaceKeywords.set_interface_state(node, interface, "up")

    @staticmethod
    def set_interface_down(node, interface):
        """Set the administration state of VPP interface to down.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :type node: dict
        :type interface: str
        :returns: Content of response.
        :rtype: bytearray
        """

        return InterfaceKeywords.set_interface_state(node, interface, "down")

    @staticmethod
    def add_bridge_domain_to_interface(node, interface, bd_name,
                                       split_horizon_group=None, bvi=None):
        """Add a new bridge domain to an interface and set its parameters.

        :param node: Honeycomb node.
        :param interface: Interface name, key, link name or sw_if_index.
        :param bd_name: Bridge domain name.
        :param split_horizon_group: Split-horizon group name.
        :param bvi: The bridged virtual interface.
        :type node: dict
        :type interface: str
        :type bd_name: str
        :type split_horizon_group: str
        :type bvi: str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the interface is not present on the node.
        """

        interface = Topology.convert_interface_reference(
            node, interface, "name")

        v3po_l2 = {"bridge-domain": str(bd_name)}
        if split_horizon_group:
            v3po_l2["split-horizon-group"] = str(split_horizon_group)
        if bvi:
            v3po_l2["bridged-virtual-interface"] = str(bvi)

        path = ("interfaces", ("interface", "name", str(interface)), "v3po:l2")

        return InterfaceKeywords._set_interface_properties(
            node, interface, path, v3po_l2)

    @staticmethod
    def remove_bridge_domain_from_interface(node, interface):
        """Remove bridge domain assignment from interface.

        :param node: Honeycomb node.
        :param interface: Interface name, key, link name or sw_if_index.
        :type node: dict
        :type interface: str or int

        :raises HoneycombError: If the operation fails.
        """

        interface = Topology.convert_interface_reference(
            node, interface, "name")

        intf = interface.replace("/", "%2F")

        path = "/interface/{0}/v3po:l2".format(intf)

        status_code, response = HcUtil.delete_honeycomb_data(
            node, "config_vpp_interfaces", path)

        if status_code != HTTPCodes.OK:
            if '"error-tag":"data-missing"' in response:
                logger.debug("Data does not exist in path.")
            else:
                raise HoneycombError(
                    "Could not remove bridge domain assignment from interface "
                    "'{0}'. Status code: {1}.".format(interface, status_code))

    @staticmethod
    def get_bd_oper_data_from_interface(node, interface):
        """Returns operational data about bridge domain settings in the
        interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :type node: dict
        :type interface: str
        :returns: Operational data about bridge domain settings in the
        interface.
        :rtype: dict
        """

        if_data = InterfaceKeywords.get_interface_oper_data(node, interface)

        if if_data:
            try:
                return if_data["v3po:l2"]
            except KeyError:
                return {}
        return {}

    @staticmethod
    def configure_interface_base(node, interface, param, value):
        """Configure the base parameters of interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param param: Parameter to configure (set, change, remove)
        :param value: The value of parameter. If None, the parameter will be
        removed.
        :type node: dict
        :type interface: str
        :type param: str
        :type value: str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        if param not in InterfaceKeywords.INTF_PARAMS:
            raise HoneycombError("The parameter {0} is invalid.".format(param))

        path = ("interfaces", ("interface", "name", interface), param)
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, value)

    @staticmethod
    def configure_interface_ipv4(node, interface, param, value):
        """Configure IPv4 parameters of interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param param: Parameter to configure (set, change, remove)
        :param value: The value of parameter. If None, the parameter will be
        removed.
        :type node: dict
        :type interface: str
        :type param: str
        :type value: str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        interface = Topology.convert_interface_reference(
            node, interface, "name")

        if param not in InterfaceKeywords.IPV4_PARAMS:
            raise HoneycombError("The parameter {0} is invalid.".format(param))

        path = ("interfaces", ("interface", "name", interface),
                "ietf-ip:ipv4", param)
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, value)

    @staticmethod
    def add_first_ipv4_address(node, interface, ip_addr, network):
        """Add the first IPv4 address.

        If there are any other addresses configured, they will be removed.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param ip_addr: IPv4 address to be set.
        :param network: Netmask or length of network prefix.
        :type node: dict
        :type interface: str
        :type ip_addr: str
        :type network: str or int
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the provided netmask or prefix is not valid.
        """

        interface = Topology.convert_interface_reference(
            node, interface, "name")

        path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv4")
        if isinstance(network, basestring):
            address = {"address": [{"ip": ip_addr, "netmask": network}, ]}
        elif isinstance(network, int) and (0 < network < 33):
            address = {"address": [{"ip": ip_addr, "prefix-length": network}, ]}
        else:
            raise HoneycombError("Value {0} is not a valid netmask or network "
                                 "prefix length.".format(network))
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, address)

    @staticmethod
    def add_ipv4_address(node, interface, ip_addr, network):
        """Add IPv4 address.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param ip_addr: IPv4 address to be set.
        :param network: Netmask or length of network prefix.
        :type node: dict
        :type interface: str
        :type ip_addr: str
        :type network: str or int
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the provided netmask or prefix is not valid.
        """

        interface = Topology.convert_interface_reference(
            node, interface, "name")

        path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv4",
                "address")
        if isinstance(network, basestring):
            address = {"address": [{"ip": ip_addr, "netmask": network}, ]}
        elif isinstance(network, int) and (0 < network < 33):
            address = {"address": [{"ip": ip_addr, "prefix-length": network}, ]}
        else:
            raise HoneycombError("Value {0} is not a valid netmask or network "
                                 "prefix length.".format(network))
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, address)

    @staticmethod
    def remove_all_ipv4_addresses(node, interface):
        """Remove all IPv4 addresses from interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :type node: dict
        :type interface: str
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv4",
                "address")
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, None)

    @staticmethod
    def add_ipv4_neighbor(node, interface, ip_addr, link_layer_address):
        """Add the IPv4 neighbour.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param ip_addr: IPv4 address of neighbour to be set.
        :param link_layer_address: Link layer address.
        :type node: dict
        :type interface: str
        :type ip_addr: str
        :type link_layer_address: str
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv4",
                "neighbor")
        neighbor = [{"ip": ip_addr, "link-layer-address": link_layer_address}, ]
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, neighbor)

    @staticmethod
    def remove_all_ipv4_neighbors(node, interface):
        """Remove all IPv4 neighbours.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :type node: dict
        :type interface: str
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv4",
                "neighbor")
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, None)

    @staticmethod
    def configure_interface_ipv6(node, interface, param, value):
        """Configure IPv6 parameters of interface

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param param: Parameter to configure (set, change, remove)
        :param value: The value of parameter. If None, the parameter will be
        removed.
        :type node: dict
        :type interface: str
        :type param: str
        :type value: str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        if param in InterfaceKeywords.IPV6_PARAMS:
            path = ("interfaces", ("interface", "name", interface),
                    "ietf-ip:ipv6", param)
        elif param in InterfaceKeywords.IPV6_AUTOCONF_PARAMS:
            path = ("interfaces", ("interface", "name", interface),
                    "ietf-ip:ipv6", "autoconf", param)
        else:
            raise HoneycombError("The parameter {0} is invalid.".format(param))

        return InterfaceKeywords._set_interface_properties(
            node, interface, path, value)

    @staticmethod
    def add_first_ipv6_address(node, interface, ip_addr, prefix_len):
        """Add the first IPv6 address.

        If there are any other addresses configured, they will be removed.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param ip_addr: IPv6 address to be set.
        :param prefix_len: Prefix length.
        :type node: dict
        :type interface: str
        :type ip_addr: str
        :type prefix_len: str
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv6")
        address = {"address": [{"ip": ip_addr, "prefix-length": prefix_len}, ]}
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, address)

    @staticmethod
    def add_ipv6_address(node, interface, ip_addr, prefix_len):
        """Add IPv6 address.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param ip_addr: IPv6 address to be set.
        :param prefix_len: Prefix length.
        :type node: dict
        :type interface: str
        :type ip_addr: str
        :type prefix_len: str
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv6",
                "address")
        address = [{"ip": ip_addr, "prefix-length": prefix_len}, ]
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, address)

    @staticmethod
    def remove_all_ipv6_addresses(node, interface):
        """Remove all IPv6 addresses from interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :type node: dict
        :type interface: str
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv6",
                "address")
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, None)

    @staticmethod
    def add_ipv6_neighbor(node, interface, ip_addr, link_layer_address):
        """Add the IPv6 neighbour.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param ip_addr: IPv6 address of neighbour to be set.
        :param link_layer_address: Link layer address.
        :type node: dict
        :type interface: str
        :type ip_addr: str
        :type link_layer_address: str
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv6",
                "neighbor")
        neighbor = [{"ip": ip_addr, "link-layer-address": link_layer_address}, ]
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, neighbor)

    @staticmethod
    def remove_all_ipv6_neighbors(node, interface):
        """Remove all IPv6 neighbours.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :type node: dict
        :type interface: str
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces", ("interface", "name", interface), "ietf-ip:ipv6",
                "neighbor")
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, None)

    @staticmethod
    def configure_interface_ethernet(node, interface, param, value):
        """Configure the ethernet parameters of interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param param: Parameter to configure (set, change, remove)
        :param value: The value of parameter. If None, the parameter will be
        removed.
        :type node: dict
        :type interface: str
        :type param: str
        :type value: str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        if param not in InterfaceKeywords.ETH_PARAMS:
            raise HoneycombError("The parameter {0} is invalid.".format(param))
        path = ("interfaces", ("interface", "name", interface), "v3po:ethernet",
                param)
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, value)

    @staticmethod
    def configure_interface_routing(node, interface, param, value):
        """Configure the routing parameters of interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param param: Parameter to configure (set, change, remove)
        :param value: The value of parameter. If None, the parameter will be
        removed.
        :type node: dict
        :type interface: str
        :type param: str
        :type value: str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        if param not in InterfaceKeywords.ROUTING_PARAMS:
            raise HoneycombError("The parameter {0} is invalid.".format(param))

        path = ("interfaces", ("interface", "name", interface), "v3po:routing",
                param)
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, value)

    @staticmethod
    def create_vxlan_interface(node, interface, **kwargs):
        """Create a new VxLAN interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param kwargs: Parameters and their values. The accepted parameters are
        defined in InterfaceKeywords.VXLAN_PARAMS.
        :type node: dict
        :type interface: str
        :type kwargs: dict
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        new_vx_lan = {
            "name": interface,
            "type": "v3po:vxlan-tunnel",
            "v3po:vxlan": {}
        }
        for param, value in kwargs.items():
            if param not in InterfaceKeywords.VXLAN_PARAMS:
                raise HoneycombError("The parameter {0} is invalid.".
                                     format(param))
            new_vx_lan["v3po:vxlan"][param] = value

        path = ("interfaces", "interface")
        vx_lan_structure = [new_vx_lan, ]
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, vx_lan_structure)

    @staticmethod
    def delete_interface(node, interface):
        """Delete an interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :type node: dict
        :type interface: str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If it is not possible to get information about
        interfaces or it is not possible to delete the interface.
        """

        path = ("interfaces", ("interface", "name", interface))

        status_code, resp = HcUtil.\
            get_honeycomb_data(node, "config_vpp_interfaces")
        if status_code != HTTPCodes.OK:
            raise HoneycombError(
                "Not possible to get configuration information about the "
                "interfaces. Status code: {0}.".format(status_code))

        new_data = HcUtil.remove_item(resp, path)
        status_code, resp = HcUtil.\
            put_honeycomb_data(node, "config_vpp_interfaces", new_data)
        if status_code != HTTPCodes.OK:
            raise HoneycombError("Not possible to remove interface {0}. "
                                 "Status code: {1}.".
                                 format(interface, status_code))
        return resp

    @staticmethod
    def configure_interface_vxlan(node, interface, **kwargs):
        """Configure VxLAN on the interface.

        The keyword configures VxLAN parameters on the given interface. The type
        of interface must be set to "v3po:vxlan-tunnel".
        The new VxLAN parameters overwrite the current configuration. If a
        parameter in new configuration is missing, it is removed from VxLAN
        configuration.
        If the dictionary kwargs is empty, VxLAN configuration is removed.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param kwargs: Parameters and their values. The accepted parameters are
        defined in InterfaceKeywords.VXLAN_PARAMS.
        :type node: dict
        :type interface: str
        :type kwargs: dict
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        vx_lan_structure = dict()
        for param, value in kwargs.items():
            if param not in InterfaceKeywords.VXLAN_PARAMS:
                raise HoneycombError("The parameter {0} is invalid.".
                                     format(param))
            vx_lan_structure[param] = value

        path = ("interfaces", ("interface", "name", interface), "v3po:vxlan")
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, vx_lan_structure)

    @staticmethod
    def configure_interface_l2(node, interface, param, value):
        """Configure the L2 parameters of interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param param: Parameter to configure (set, change, remove)
        :param value: The value of parameter. If None, the parameter will be
        removed.
        :type node: dict
        :type interface: str
        :type param: str
        :type value: str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        if param not in InterfaceKeywords.L2_PARAMS:
            raise HoneycombError("The parameter {0} is invalid.".format(param))
        path = ("interfaces", ("interface", "name", interface), "v3po:l2",
                param)
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, value)

    @staticmethod
    def create_tap_interface(node, interface, **kwargs):
        """Create a new TAP interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param kwargs: Parameters and their values. The accepted parameters are
        defined in InterfaceKeywords.TAP_PARAMS.
        :type node: dict
        :type interface: str
        :type kwargs: dict
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        new_tap = {
            "name": interface,
            "type": "v3po:tap",
            "v3po:tap": {}
        }
        for param, value in kwargs.items():
            if param not in InterfaceKeywords.TAP_PARAMS:
                raise HoneycombError("The parameter {0} is invalid.".
                                     format(param))
            new_tap["v3po:tap"][param] = value

        path = ("interfaces", "interface")
        new_tap_structure = [new_tap, ]
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, new_tap_structure)

    @staticmethod
    def configure_interface_tap(node, interface, **kwargs):
        """Configure TAP on the interface.

        The keyword configures TAP parameters on the given interface. The type
        of interface must be set to "v3po:tap".
        The new TAP parameters overwrite the current configuration. If a
        parameter in new configuration is missing, it is removed from TAP
        configuration.
        If the dictionary kwargs is empty, TAP configuration is removed.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param kwargs: Parameters and their values. The accepted parameters are
        defined in InterfaceKeywords.TAP_PARAMS.
        :type node: dict
        :type interface: str
        :type kwargs: dict
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        tap_structure = dict()
        for param, value in kwargs.items():
            if param not in InterfaceKeywords.TAP_PARAMS:
                raise HoneycombError("The parameter {0} is invalid.".
                                     format(param))
            tap_structure[param] = value

        path = ("interfaces", ("interface", "name", interface), "v3po:tap")
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, tap_structure)

    @staticmethod
    def configure_interface_vhost_user(node, interface, **kwargs):
        """Configure vhost-user on the interface.

        The keyword configures vhost-user parameters on the given interface.
        The type of interface must be set to "v3po:vhost-user".
        The new vhost-user parameters overwrite the current configuration. If a
        parameter in new configuration is missing, it is removed from vhost-user
        configuration.
        If the dictionary kwargs is empty, vhost-user configuration is removed.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param kwargs: Parameters and their values. The accepted parameters are
        defined in InterfaceKeywords.VHOST_USER_PARAMS.
        :type node: dict
        :type interface: str
        :type kwargs: dict
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        vhost_structure = dict()
        for param, value in kwargs.items():
            if param not in InterfaceKeywords.VHOST_USER_PARAMS:
                raise HoneycombError("The parameter {0} is invalid.".
                                     format(param))
            vhost_structure[param] = value

        path = ("interfaces", ("interface", "name", interface),
                "v3po:vhost-user")
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, vhost_structure)

    @staticmethod
    def create_vhost_user_interface(node, interface, **kwargs):
        """Create a new vhost-user interface.

        :param node: Honeycomb node.
        :param interface: The name of interface.
        :param kwargs: Parameters and their values. The accepted parameters are
        defined in InterfaceKeywords.VHOST_USER_PARAMS.
        :type node: dict
        :type interface: str
        :type kwargs: dict
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        """

        new_vhost = {
            "name": interface,
            "type": "v3po:vhost-user",
            "v3po:vhost-user": {}
        }
        for param, value in kwargs.items():
            if param not in InterfaceKeywords.VHOST_USER_PARAMS:
                raise HoneycombError("The parameter {0} is invalid.".
                                     format(param))
            new_vhost["v3po:vhost-user"][param] = value

        path = ("interfaces", "interface")
        new_vhost_structure = [new_vhost, ]
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, new_vhost_structure)

    @staticmethod
    def create_sub_interface(node, super_interface, match, tags=None, **kwargs):
        """Create a new sub-interface.

        :param node: Honeycomb node.
        :param super_interface: Super interface.
        :param match: Match type. The valid values are defined in
        InterfaceKeywords.SUB_IF_MATCH.
        :param tags: List of tags.
        :param kwargs: Parameters and their values. The accepted parameters are
        defined in InterfaceKeywords.SUB_IF_PARAMS.
        :type node: dict
        :type super_interface: str
        :type match: str
        :type tags: list
        :type kwargs: dict
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the parameter is not valid.
        :raises KeyError: If the parameter 'match' is invalid.
        """

        match_type = {
            "default":
                {"default": {}},
            "untagged":
                {"untagged": {}},
            "vlan-tagged":
                {"vlan-tagged": {"match-exact-tags": "false"}},
            "vlan-tagged-exact-match":
                {"vlan-tagged": {"match-exact-tags": "true"}}
        }

        new_sub_interface = {
            "tags": {
                "tag": []
            },
        }

        for param, value in kwargs.items():
            if param in InterfaceKeywords.SUB_IF_PARAMS:
                new_sub_interface[param] = value
            else:
                raise HoneycombError("The parameter {0} is invalid.".
                                     format(param))
        try:
            new_sub_interface["match"] = match_type[match]
        except KeyError:
            raise HoneycombError("The value '{0}' of parameter 'match' is "
                                 "invalid.".format(match))

        if tags:
            new_sub_interface["tags"]["tag"].extend(tags)

        path = ("interfaces",
                ("interface", "name", super_interface),
                "vpp-vlan:sub-interfaces",
                "sub-interface")
        new_sub_interface_structure = [new_sub_interface, ]
        return InterfaceKeywords._set_interface_properties(
            node, super_interface, path, new_sub_interface_structure)

    @staticmethod
    def get_sub_interface_oper_data(node, super_interface, identifier):
        """Retrieves sub-interface operational data using Honeycomb API.

        :param node: Honeycomb node.
        :param super_interface: Super interface.
        :param identifier: The ID of sub-interface.
        :type node: dict
        :type super_interface: str
        :type identifier: int
        :returns: Sub-interface operational data.
        :rtype: dict
        :raises HoneycombError: If there is no sub-interface with the given ID.
        """

        if_data = InterfaceKeywords.get_interface_oper_data(node,
                                                            super_interface)
        for sub_if in if_data["vpp-vlan:sub-interfaces"]["sub-interface"]:
            if str(sub_if["identifier"]) == str(identifier):
                return sub_if

        raise HoneycombError("The interface {0} does not have sub-interface "
                             "with ID {1}".format(super_interface, identifier))

    @staticmethod
    def remove_all_sub_interfaces(node, super_interface):
        """Remove all sub-interfaces from the given interface.

        :param node: Honeycomb node.
        :param super_interface: Super interface.
        :type node: dict
        :type super_interface: str
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces",
                ("interface", "name", super_interface),
                "vpp-vlan:sub-interfaces")

        return InterfaceKeywords._set_interface_properties(
            node, super_interface, path, {})

    @staticmethod
    def set_sub_interface_state(node, super_interface, identifier, state):
        """Set the administrative state of sub-interface.

        :param node: Honeycomb node.
        :param super_interface: Super interface.
        :param identifier: The ID of sub-interface.
        :param state: Required sub-interface state - up or down.
        :type node: dict
        :type super_interface: str
        :type identifier: int
        :type state: str
        :returns: Content of response.
        :rtype: bytearray
        """

        intf_state = {"up": "true",
                      "down": "false"}

        path = ("interfaces",
                ("interface", "name", super_interface),
                "vpp-vlan:sub-interfaces",
                ("sub-interface", "identifier", identifier),
                "enabled")

        return InterfaceKeywords._set_interface_properties(
            node, super_interface, path, intf_state[state])

    @staticmethod
    def add_bridge_domain_to_sub_interface(node, super_interface, identifier,
                                           config):
        """Add a sub-interface to a bridge domain and set its parameters.

        :param node: Honeycomb node.
        :param super_interface: Super interface.
        :param identifier: The ID of sub-interface.
        :param config: Bridge domain configuration.
        :type node: dict
        :type super_interface: str
        :type identifier: int
        :type config: dict
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces",
                ("interface", "name", super_interface),
                "vpp-vlan:sub-interfaces",
                ("sub-interface", "identifier", int(identifier)),
                "l2")

        return InterfaceKeywords._set_interface_properties(
            node, super_interface, path, config)

    @staticmethod
    def get_bd_data_from_sub_interface(node, super_interface, identifier):
        """Get the operational data about the bridge domain from sub-interface.

        :param node: Honeycomb node.
        :param super_interface: Super interface.
        :param identifier: The ID of sub-interface.
        :type node: dict
        :type super_interface: str
        :type identifier: int
        :returns: Operational data about the bridge domain.
        :rtype: dict
        :raises HoneycombError: If there is no sub-interface with the given ID.
        """

        try:
            bd_data = InterfaceKeywords.get_sub_interface_oper_data(
                node, super_interface, identifier)["l2"]
            return bd_data
        except KeyError:
            raise HoneycombError("The operational data does not contain "
                                 "information about a bridge domain.")

    @staticmethod
    def configure_tag_rewrite(node, super_interface, identifier, config):
        """Add / change / disable vlan tag rewrite on a sub-interface.

        :param node: Honeycomb node.
        :param super_interface: Super interface.
        :param identifier: The ID of sub-interface.
        :param config: Rewrite tag configuration.
        :type node: dict
        :type super_interface: str
        :type identifier: int
        :type config: dict
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces",
                ("interface", "name", super_interface),
                "vpp-vlan:sub-interfaces",
                ("sub-interface", "identifier", int(identifier)),
                "l2",
                "rewrite")

        return InterfaceKeywords._set_interface_properties(
            node, super_interface, path, config)

    @staticmethod
    def get_tag_rewrite_oper_data(node, super_interface, identifier):
        """Get the operational data about tag rewrite.

        :param node: Honeycomb node.
        :param super_interface: Super interface.
        :param identifier: The ID of sub-interface.
        :type node: dict
        :type super_interface: str
        :type identifier: int
        :returns: Operational data about tag rewrite.
        :rtype: dict
        :raises HoneycombError: If there is no sub-interface with the given ID.
        """

        try:
            tag_rewrite = InterfaceKeywords.get_sub_interface_oper_data(
                node, super_interface, identifier)["l2"]["rewrite"]
            return tag_rewrite
        except KeyError:
            raise HoneycombError("The operational data does not contain "
                                 "information about the tag-rewrite.")

    @staticmethod
    def add_ipv4_address_to_sub_interface(node, super_interface, identifier,
                                          ip_addr, network):
        """Add an ipv4 address to the specified sub-interface, with the provided
        netmask or network prefix length. Any existing ipv4 addresses on the
        sub-interface will be replaced.

        :param node: Honeycomb node.
        :param super_interface: Super interface.
        :param identifier: The ID of sub-interface.
        :param ip_addr: IPv4 address to be set.
        :param network: Network mask or network prefix length.
        :type node: dict
        :type super_interface: str
        :type identifier: int
        :type ip_addr: str
        :type network: str or int
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the provided netmask or prefix is not valid.
        """

        path = ("interfaces",
                ("interface", "name", super_interface),
                "vpp-vlan:sub-interfaces",
                ("sub-interface", "identifier", int(identifier)),
                "ipv4")

        if isinstance(network, basestring):
            address = {"address": [{"ip": ip_addr, "netmask": network}, ]}

        elif isinstance(network, int) and 0 < network < 33:
            address = {"address": [{"ip": ip_addr, "prefix-length": network}, ]}

        else:
            raise HoneycombError("{0} is not a valid netmask or prefix length."
                                 .format(network))

        return InterfaceKeywords._set_interface_properties(
            node, super_interface, path, address)

    @staticmethod
    def remove_all_ipv4_addresses_from_sub_interface(node, super_interface, # pylint: disable=invalid-name
                                                     identifier):
        """Remove all ipv4 addresses from the specified sub-interface.

        :param node: Honeycomb node.
        :param super_interface: Super interface.
        :param identifier: The ID of sub-interface.
        :type node: dict
        :type super_interface: str
        :type identifier: int
        :returns: Content of response.
        :rtype: bytearray
        """

        path = ("interfaces",
                ("interface", "name", super_interface),
                "vpp-vlan:sub-interfaces",
                ("sub-interface", "identifier", int(identifier)),
                "ipv4", "address")

        return InterfaceKeywords._set_interface_properties(
            node, super_interface, path, None)

    @staticmethod
    def compare_data_structures(data, ref, ignore=(), list_order=True):
        """Checks if data obtained from UUT is as expected.

        :param data: Data to be checked.
        :param ref: Referential data used for comparison.
        :param ignore: Dictionary keys to be ignored.
        :param list_order: Whether to consider the order of list items\
        in comparison.
        :type data: dict
        :type ref: dict
        :type ignore: iterable
        :type list_order: bool

        :raises HoneycombError: If a parameter from referential data is not
        present in operational data or if it has different value.
        """

        errors = ""

        for key, item in ref.items():
            if key in ignore:
                continue
            try:
                if data[key] != item:
                    if not list_order and sorted(data[key]) == sorted(item):
                        pass
                    else:
                        errors += ("\nThe value of parameter '{0}' is "
                                   "incorrect. It should be "
                                   "'{1}' but it is '{2}'".
                                   format(key, item, data[key]))
            except KeyError:
                errors += ("\nThe parameter '{0}' is not present in "
                           "operational data".format(key))

        if errors:
            raise HoneycombError(errors)

    @staticmethod
    def compare_interface_lists(list1, list2):
        """Compare provided lists of interfaces by name.

        :param list1: List of interfaces.
        :param list2: List of interfaces.
        :type list1: list
        :type list2: list
        :raises HoneycombError: If an interface exists in only one of the lists.
        """

        ignore = ["vx_tunnel0", "vxlan_gpe_tunnel0"]
        # these have no equivalent in config data and no effect on VPP

        names1 = [x['name'] for x in list1]
        names2 = [x['name'] for x in list2]

        for name in names1:
            if name not in names2 and name not in ignore:
                raise HoneycombError("Interface {0} not present in list {1}"
                                     .format(name, list2))
        for name in names2:
            if name not in names1 and name not in ignore:
                raise HoneycombError("Interface {0} not present in list {1}"
                                     .format(name, list1))

    @staticmethod
    def create_vxlan_gpe_interface(node, interface, **kwargs):
        """Create a new VxLAN GPE interface.

        :param node: Honeycomb node.
        :param interface: The name of interface to be created.
        :param kwargs: Parameters and their values. The accepted parameters are
        defined in InterfaceKeywords.VXLAN_GPE_PARAMS.
        :type node: dict
        :type interface: str
        :type kwargs: dict
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If a parameter in kwargs is not valid.
        """

        new_vxlan_gpe = {
            "name": interface,
            "type": "v3po:vxlan-gpe-tunnel",
            "v3po:vxlan-gpe": {}
        }
        for param, value in kwargs.items():
            if param in InterfaceKeywords.INTF_PARAMS:
                new_vxlan_gpe[param] = value
            elif param in InterfaceKeywords.VXLAN_GPE_PARAMS:
                new_vxlan_gpe["v3po:vxlan-gpe"][param] = value
            else:
                raise HoneycombError("The parameter {0} is invalid.".
                                     format(param))
        path = ("interfaces", "interface")
        vxlan_gpe_structure = [new_vxlan_gpe, ]
        return InterfaceKeywords._set_interface_properties(
            node, interface, path, vxlan_gpe_structure)

    @staticmethod
    def enable_acl_on_interface(node, interface, table_name):
        """Enable ACL on the given interface.

        :param node: Honeycomb node.
        :param interface: The interface where the ACL will be enabled.
        :param table_name: Name of the classify table.
        :type node: dict
        :type interface: str
        :type table_name: str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the configuration of interface is not
        successful.
        """

        interface = interface.replace("/", "%2F")

        data = {
            "v3po:acl": {
                "ingress": {
                    "ip4-acl": {
                        "classify-table": table_name
                    },
                    "l2-acl": {
                        "classify-table": table_name
                    }
                }
            }
        }

        path = "/interface/" + interface + "/v3po:acl"
        status_code, resp = HcUtil.\
            put_honeycomb_data(node, "config_vpp_interfaces", data, path,
                               data_representation=DataRepresentation.JSON)
        if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
            raise HoneycombError(
                "The configuration of interface '{0}' was not successful. "
                "Status code: {1}.".format(interface, status_code))
        return resp

    @staticmethod
    def disable_acl_on_interface(node, interface):
        """Disable ACL on the given interface.

        :param node: Honeycomb node.
        :param interface: The interface where the ACL will be disabled.
        :type node: dict
        :type interface: str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the configuration of interface is not
        successful.
        """

        interface = interface.replace("/", "%2F")

        path = "/interface/" + interface + "/v3po:acl"

        status_code, resp = HcUtil.\
            delete_honeycomb_data(node, "config_vpp_interfaces", path)

        if status_code != HTTPCodes.OK:
            raise HoneycombError(
                "The configuration of interface '{0}' was not successful. "
                "Status code: {1}.".format(interface, status_code))
        return resp

    @staticmethod
    def create_pbb_sub_interface(node, intf, params):
        """Creates a PBB sub-interface on the given interface and sets its
        parameters.

        :param node: Honeycomb node.
        :param intf: The interface where PBB sub-interface will be configured.
        :param params: Configuration parameters of the sub-interface to be
        created.
        :type node: dict
        :type intf: str
        :type params: dict
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the configuration of sub-interface is not
        successful.
        """

        interface = intf.replace("/", "%2F")
        path = "/interface/{0}/pbb-rewrite/".format(interface)
        status_code, resp = HcUtil. \
            put_honeycomb_data(node, "config_vpp_interfaces", params, path,
                               data_representation=DataRepresentation.JSON)
        if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
            raise HoneycombError(
                "The configuration of PBB sub-interface '{0}' was not "
                "successful. Status code: {1}.".format(intf, status_code))
        return resp

    @staticmethod
    def delete_pbb_sub_interface(node, intf):
        """Deletes the given PBB sub-interface.

        :param node: Honeycomb node.
        :param intf: The interface where PBB sub-interface will be deleted.
        :type node: dict
        :type intf: str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If the removal of sub-interface is not
        successful.
        """

        interface = intf.replace("/", "%2F")
        path = "/interface/{0}/pbb-rewrite".format(interface)

        status_code, resp = HcUtil. \
            delete_honeycomb_data(node, "config_vpp_interfaces", path)
        if status_code != HTTPCodes.OK:
            raise HoneycombError(
                "The removal of pbb sub-interface '{0}' was not successful. "
                "Status code: {1}.".format(intf, status_code))
        return resp

    @staticmethod
    def get_pbb_sub_interface_oper_data(node, intf, sub_if_id):
        """Retrieves PBB sub-interface operational data from Honeycomb.

        :param node: Honeycomb node.
        :param intf: The interface where PBB sub-interface is located.
        :param sub_if_id: ID of the PBB sub-interface.
        :type node: dict
        :type intf: str
        :type sub_if_id: str or int
        :returns: PBB sub-interface operational data.
        :rtype: dict
        :raises HoneycombError: If the removal of sub-interface is not
        successful.
        """

        raise NotImplementedError

    @staticmethod
    def check_disabled_interface(node, interface):
        """Retrieves list of disabled interface indices from Honeycomb,
        and matches with the provided interface by index.

        :param node: Honeycomb node.
        :param interface: Index number of an interface on the node.
        :type node: dict
        :type interface: int
        :returns: True if the interface exists in disabled interfaces.
        :rtype: bool
        :raises HoneycombError: If the interface is not present
         in retrieved list of disabled interfaces.
         """
        data = InterfaceKeywords.get_disabled_interfaces_oper_data(node)
        # decrement by one = conversion from HC if-index to VPP sw_if_index
        interface -= 1

        for item in data:
            if item["index"] == interface:
                return True
        raise HoneycombError("Interface index {0} not present in list"
                             " of disabled interfaces.".format(interface))

    @staticmethod
    def configure_interface_span(node, dst_interface, *src_interfaces):
        """Configure SPAN port mirroring on the specified interfaces. If no
         source interface is provided, SPAN will be disabled.

        :param node: Honeycomb node.
        :param dst_interface: Interface to mirror packets to.
        :param src_interfaces: List of interfaces to mirror packets from.
        :type node: dict
        :type dst_interface: str
        :type src_interfaces: list of str
        :returns: Content of response.
        :rtype: bytearray
        :raises HoneycombError: If SPAN could not be configured.
        """

        interface = dst_interface.replace("/", "%2F")
        path = "/interface/" + interface + "/span"

        if not src_interfaces:
            status_code, _ = HcUtil.delete_honeycomb_data(
                node, "config_vpp_interfaces", path)

        data = {
            "span": {
                "mirrored-interfaces": {
                    "mirrored-interface": src_interfaces
                }
            }
        }

        status_code, _ = HcUtil.put_honeycomb_data(
            node, "config_vpp_interfaces", data, path)

        if status_code not in (HTTPCodes.OK, HTTPCodes.ACCEPTED):
            raise HoneycombError(
                "Configuring SPAN failed. Status code:{0}".format(status_code))

    @staticmethod
    def add_interface_local0_to_topology(node):
        """Use Topology methods to add interface "local0" to working topology,
        if not already present.

        :param node: DUT node.
        :type node: dict
        """

        if Topology.get_interface_by_sw_index(node, 0) is None:
            local0_key = Topology.add_new_port(node, "localzero")
            Topology.update_interface_sw_if_index(node, local0_key, 0)
            Topology.update_interface_name(node, local0_key, "local0")


context:
space:
mode: