examples/bin_api/map.api.json

   1 {
   2     "messages": [
   3         [
   4             "map_add_domain",
   5             [
   6                 "u16",
   7                 "_vl_msg_id"
   8             ],
   9             [
  10                 "u32",
  11                 "client_index"
  12             ],
  13             [
  14                 "u32",
  15                 "context"
  16             ],
  17             [
  18                 "vl_api_ip6_prefix_t",
  19                 "ip6_prefix"
  20             ],
  21             [
  22                 "vl_api_ip4_prefix_t",
  23                 "ip4_prefix"
  24             ],
  25             [
  26                 "vl_api_ip6_prefix_t",
  27                 "ip6_src"
  28             ],
  29             [
  30                 "u8",
  31                 "ea_bits_len"
  32             ],
  33             [
  34                 "u8",
  35                 "psid_offset"
  36             ],
  37             [
  38                 "u8",
  39                 "psid_length"
  40             ],
  41             [
  42                 "bool",
  43                 "is_translation"
  44             ],
  45             [
  46                 "bool",
  47                 "is_rfc6052"
  48             ],
  49             [
  50                 "u16",
  51                 "mtu"
  52             ],
  53             {
  54                 "crc": "0x7a64714e"
  55             }
  56         ],
  57         [
  58             "map_add_domain_reply",
  59             [
  60                 "u16",
  61                 "_vl_msg_id"
  62             ],
  63             [
  64                 "u32",
  65                 "context"
  66             ],
  67             [
  68                 "u32",
  69                 "index"
  70             ],
  71             [
  72                 "i32",
  73                 "retval"
  74             ],
  75             {
  76                 "crc": "0x3e6d4e2c"
  77             }
  78         ],
  79         [
  80             "map_del_domain",
  81             [
  82                 "u16",
  83                 "_vl_msg_id"
  84             ],
  85             [
  86                 "u32",
  87                 "client_index"
  88             ],
  89             [
  90                 "u32",
  91                 "context"
  92             ],
  93             [
  94                 "u32",
  95                 "index"
  96             ],
  97             {
  98                 "crc": "0x8ac76db6"
  99             }
 100         ],
 101         [
 102             "map_del_domain_reply",
 103             [
 104                 "u16",
 105                 "_vl_msg_id"
 106             ],
 107             [
 108                 "u32",
 109                 "context"
 110             ],
 111             [
 112                 "i32",
 113                 "retval"
 114             ],
 115             {
 116                 "crc": "0xe8d4e804"
 117             }
 118         ],
 119         [
 120             "map_add_del_rule",
 121             [
 122                 "u16",
 123                 "_vl_msg_id"
 124             ],
 125             [
 126                 "u32",
 127                 "client_index"
 128             ],
 129             [
 130                 "u32",
 131                 "context"
 132             ],
 133             [
 134                 "u32",
 135                 "index"
 136             ],
 137             [
 138                 "bool",
 139                 "is_add"
 140             ],
 141             [
 142                 "vl_api_ip6_address_t",
 143                 "ip6_dst"
 144             ],
 145             [
 146                 "u16",
 147                 "psid"
 148             ],
 149             {
 150                 "crc": "0xe6132040"
 151             }
 152         ],
 153         [
 154             "map_add_del_rule_reply",
 155             [
 156                 "u16",
 157                 "_vl_msg_id"
 158             ],
 159             [
 160                 "u32",
 161                 "context"
 162             ],
 163             [
 164                 "i32",
 165                 "retval"
 166             ],
 167             {
 168                 "crc": "0xe8d4e804"
 169             }
 170         ],
 171         [
 172             "map_domain_dump",
 173             [
 174                 "u16",
 175                 "_vl_msg_id"
 176             ],
 177             [
 178                 "u32",
 179                 "client_index"
 180             ],
 181             [
 182                 "u32",
 183                 "context"
 184             ],
 185             {
 186                 "crc": "0x51077d14"
 187             }
 188         ],
 189         [
 190             "map_domain_details",
 191             [
 192                 "u16",
 193                 "_vl_msg_id"
 194             ],
 195             [
 196                 "u32",
 197                 "context"
 198             ],
 199             [
 200                 "u32",
 201                 "domain_index"
 202             ],
 203             [
 204                 "vl_api_ip6_prefix_t",
 205                 "ip6_prefix"
 206             ],
 207             [
 208                 "vl_api_ip4_prefix_t",
 209                 "ip4_prefix"
 210             ],
 211             [
 212                 "vl_api_ip6_prefix_t",
 213                 "ip6_src"
 214             ],
 215             [
 216                 "u8",
 217                 "ea_bits_len"
 218             ],
 219             [
 220                 "u8",
 221                 "psid_offset"
 222             ],
 223             [
 224                 "u8",
 225                 "psid_length"
 226             ],
 227             [
 228                 "u8",
 229                 "flags"
 230             ],
 231             [
 232                 "u16",
 233                 "mtu"
 234             ],
 235             [
 236                 "bool",
 237                 "is_translation"
 238             ],
 239             {
 240                 "crc": "0x7a986fe6"
 241             }
 242         ],
 243         [
 244             "map_rule_dump",
 245             [
 246                 "u16",
 247                 "_vl_msg_id"
 248             ],
 249             [
 250                 "u32",
 251                 "client_index"
 252             ],
 253             [
 254                 "u32",
 255                 "context"
 256             ],
 257             [
 258                 "u32",
 259                 "domain_index"
 260             ],
 261             {
 262                 "crc": "0xe43e6ff6"
 263             }
 264         ],
 265         [
 266             "map_rule_details",
 267             [
 268                 "u16",
 269                 "_vl_msg_id"
 270             ],
 271             [
 272                 "u32",
 273                 "context"
 274             ],
 275             [
 276                 "vl_api_ip6_address_t",
 277                 "ip6_dst"
 278             ],
 279             [
 280                 "u16",
 281                 "psid"
 282             ],
 283             {
 284                 "crc": "0x4f932665"
 285             }
 286         ],
 287         [
 288             "map_summary_stats",
 289             [
 290                 "u16",
 291                 "_vl_msg_id"
 292             ],
 293             [
 294                 "u32",
 295                 "client_index"
 296             ],
 297             [
 298                 "u32",
 299                 "context"
 300             ],
 301             {
 302                 "crc": "0x51077d14"
 303             }
 304         ],
 305         [
 306             "map_summary_stats_reply",
 307             [
 308                 "u16",
 309                 "_vl_msg_id"
 310             ],
 311             [
 312                 "u32",
 313                 "context"
 314             ],
 315             [
 316                 "i32",
 317                 "retval"
 318             ],
 319             [
 320                 "u64",
 321                 "total_bindings"
 322             ],
 323             [
 324                 "u64",
 325                 "total_pkts",
 326                 2
 327             ],
 328             [
 329                 "u64",
 330                 "total_bytes",
 331                 2
 332             ],
 333             [
 334                 "u64",
 335                 "total_ip4_fragments"
 336             ],
 337             [
 338                 "u64",
 339                 "total_security_check",
 340                 2
 341             ],
 342             {
 343                 "crc": "0x0e4ace0e"
 344             }
 345         ],
 346         [
 347             "map_param_set_fragmentation",
 348             [
 349                 "u16",
 350                 "_vl_msg_id"
 351             ],
 352             [
 353                 "u32",
 354                 "client_index"
 355             ],
 356             [
 357                 "u32",
 358                 "context"
 359             ],
 360             [
 361                 "bool",
 362                 "inner"
 363             ],
 364             [
 365                 "bool",
 366                 "ignore_df"
 367             ],
 368             {
 369                 "crc": "0x9ff54d90"
 370             }
 371         ],
 372         [
 373             "map_param_set_fragmentation_reply",
 374             [
 375                 "u16",
 376                 "_vl_msg_id"
 377             ],
 378             [
 379                 "u32",
 380                 "context"
 381             ],
 382             [
 383                 "i32",
 384                 "retval"
 385             ],
 386             {
 387                 "crc": "0xe8d4e804"
 388             }
 389         ],
 390         [
 391             "map_param_set_icmp",
 392             [
 393                 "u16",
 394                 "_vl_msg_id"
 395             ],
 396             [
 397                 "u32",
 398                 "client_index"
 399             ],
 400             [
 401                 "u32",
 402                 "context"
 403             ],
 404             [
 405                 "vl_api_ip4_address_t",
 406                 "ip4_err_relay_src"
 407             ],
 408             {
 409                 "crc": "0x4c0a4fd2"
 410             }
 411         ],
 412         [
 413             "map_param_set_icmp_reply",
 414             [
 415                 "u16",
 416                 "_vl_msg_id"
 417             ],
 418             [
 419                 "u32",
 420                 "context"
 421             ],
 422             [
 423                 "i32",
 424                 "retval"
 425             ],
 426             {
 427                 "crc": "0xe8d4e804"
 428             }
 429         ],
 430         [
 431             "map_param_set_icmp6",
 432             [
 433                 "u16",
 434                 "_vl_msg_id"
 435             ],
 436             [
 437                 "u32",
 438                 "client_index"
 439             ],
 440             [
 441                 "u32",
 442                 "context"
 443             ],
 444             [
 445                 "bool",
 446                 "enable_unreachable"
 447             ],
 448             {
 449                 "crc": "0x5d01f8c1"
 450             }
 451         ],
 452         [
 453             "map_param_set_icmp6_reply",
 454             [
 455                 "u16",
 456                 "_vl_msg_id"
 457             ],
 458             [
 459                 "u32",
 460                 "context"
 461             ],
 462             [
 463                 "i32",
 464                 "retval"
 465             ],
 466             {
 467                 "crc": "0xe8d4e804"
 468             }
 469         ],
 470         [
 471             "map_param_add_del_pre_resolve",
 472             [
 473                 "u16",
 474                 "_vl_msg_id"
 475             ],
 476             [
 477                 "u32",
 478                 "client_index"
 479             ],
 480             [
 481                 "u32",
 482                 "context"
 483             ],
 484             [
 485                 "bool",
 486                 "is_add"
 487             ],
 488             [
 489                 "vl_api_ip4_address_t",
 490                 "ip4_nh_address"
 491             ],
 492             [
 493                 "vl_api_ip6_address_t",
 494                 "ip6_nh_address"
 495             ],
 496             {
 497                 "crc": "0xea9a9a4a"
 498             }
 499         ],
 500         [
 501             "map_param_add_del_pre_resolve_reply",
 502             [
 503                 "u16",
 504                 "_vl_msg_id"
 505             ],
 506             [
 507                 "u32",
 508                 "context"
 509             ],
 510             [
 511                 "i32",
 512                 "retval"
 513             ],
 514             {
 515                 "crc": "0xe8d4e804"
 516             }
 517         ],
 518         [
 519             "map_param_set_reassembly",
 520             [
 521                 "u16",
 522                 "_vl_msg_id"
 523             ],
 524             [
 525                 "u32",
 526                 "client_index"
 527             ],
 528             [
 529                 "u32",
 530                 "context"
 531             ],
 532             [
 533                 "bool",
 534                 "is_ip6"
 535             ],
 536             [
 537                 "u16",
 538                 "lifetime_ms"
 539             ],
 540             [
 541                 "u16",
 542                 "pool_size"
 543             ],
 544             [
 545                 "u32",
 546                 "buffers"
 547             ],
 548             [
 549                 "f64",
 550                 "ht_ratio"
 551             ],
 552             {
 553                 "crc": "0x54172b10"
 554             }
 555         ],
 556         [
 557             "map_param_set_reassembly_reply",
 558             [
 559                 "u16",
 560                 "_vl_msg_id"
 561             ],
 562             [
 563                 "u32",
 564                 "context"
 565             ],
 566             [
 567                 "i32",
 568                 "retval"
 569             ],
 570             {
 571                 "crc": "0xe8d4e804"
 572             }
 573         ],
 574         [
 575             "map_param_set_security_check",
 576             [
 577                 "u16",
 578                 "_vl_msg_id"
 579             ],
 580             [
 581                 "u32",
 582                 "client_index"
 583             ],
 584             [
 585                 "u32",
 586                 "context"
 587             ],
 588             [
 589                 "bool",
 590                 "enable"
 591             ],
 592             [
 593                 "bool",
 594                 "fragments"
 595             ],
 596             {
 597                 "crc": "0x6abe9836"
 598             }
 599         ],
 600         [
 601             "map_param_set_security_check_reply",
 602             [
 603                 "u16",
 604                 "_vl_msg_id"
 605             ],
 606             [
 607                 "u32",
 608                 "context"
 609             ],
 610             [
 611                 "i32",
 612                 "retval"
 613             ],
 614             {
 615                 "crc": "0xe8d4e804"
 616             }
 617         ],
 618         [
 619             "map_param_set_traffic_class",
 620             [
 621                 "u16",
 622                 "_vl_msg_id"
 623             ],
 624             [
 625                 "u32",
 626                 "client_index"
 627             ],
 628             [
 629                 "u32",
 630                 "context"
 631             ],
 632             [
 633                 "bool",
 634                 "copy"
 635             ],
 636             [
 637                 "u8",
 638                 "class"
 639             ],
 640             {
 641                 "crc": "0x007ee563"
 642             }
 643         ],
 644         [
 645             "map_param_set_traffic_class_reply",
 646             [
 647                 "u16",
 648                 "_vl_msg_id"
 649             ],
 650             [
 651                 "u32",
 652                 "context"
 653             ],
 654             [
 655                 "i32",
 656                 "retval"
 657             ],
 658             {
 659                 "crc": "0xe8d4e804"
 660             }
 661         ],
 662         [
 663             "map_param_get",
 664             [
 665                 "u16",
 666                 "_vl_msg_id"
 667             ],
 668             [
 669                 "u32",
 670                 "client_index"
 671             ],
 672             [
 673                 "u32",
 674                 "context"
 675             ],
 676             {
 677                 "crc": "0x51077d14"
 678             }
 679         ],
 680         [
 681             "map_param_get_reply",
 682             [
 683                 "u16",
 684                 "_vl_msg_id"
 685             ],
 686             [
 687                 "u32",
 688                 "context"
 689             ],
 690             [
 691                 "i32",
 692                 "retval"
 693             ],
 694             [
 695                 "u8",
 696                 "frag_inner"
 697             ],
 698             [
 699                 "u8",
 700                 "frag_ignore_df"
 701             ],
 702             [
 703                 "vl_api_ip4_address_t",
 704                 "icmp_ip4_err_relay_src"
 705             ],
 706             [
 707                 "bool",
 708                 "icmp6_enable_unreachable"
 709             ],
 710             [
 711                 "vl_api_ip4_address_t",
 712                 "ip4_nh_address"
 713             ],
 714             [
 715                 "vl_api_ip6_address_t",
 716                 "ip6_nh_address"
 717             ],
 718             [
 719                 "u16",
 720                 "ip4_lifetime_ms"
 721             ],
 722             [
 723                 "u16",
 724                 "ip4_pool_size"
 725             ],
 726             [
 727                 "u32",
 728                 "ip4_buffers"
 729             ],
 730             [
 731                 "f64",
 732                 "ip4_ht_ratio"
 733             ],
 734             [
 735                 "u16",
 736                 "ip6_lifetime_ms"
 737             ],
 738             [
 739                 "u16",
 740                 "ip6_pool_size"
 741             ],
 742             [
 743                 "u32",
 744                 "ip6_buffers"
 745             ],
 746             [
 747                 "f64",
 748                 "ip6_ht_ratio"
 749             ],
 750             [
 751                 "bool",
 752                 "sec_check_enable"
 753             ],
 754             [
 755                 "bool",
 756                 "sec_check_fragments"
 757             ],
 758             [
 759                 "bool",
 760                 "tc_copy"
 761             ],
 762             [
 763                 "u8",
 764                 "tc_class"
 765             ],
 766             {
 767                 "crc": "0xb40e9226"
 768             }
 769         ]
 770     ],
 771     "vl_api_version": "0x14b499d0",
 772     "unions": [
 773         [
 774             "address_union",
 775             [
 776                 "vl_api_ip4_address_t",
 777                 "ip4"
 778             ],
 779             [
 780                 "vl_api_ip6_address_t",
 781                 "ip6"
 782             ],
 783             {
 784                 "crc": "0xd68a2fb4"
 785             }
 786         ]
 787     ],
 788     "services": {
 789         "map_param_set_fragmentation": {
 790             "reply": "map_param_set_fragmentation_reply"
 791         },
 792         "map_param_add_del_pre_resolve": {
 793             "reply": "map_param_add_del_pre_resolve_reply"
 794         },
 795         "map_rule_dump": {
 796             "reply": "map_rule_details",
 797             "stream": true
 798         },
 799         "map_param_set_icmp6": {
 800             "reply": "map_param_set_icmp6_reply"
 801         },
 802         "map_add_del_rule": {
 803             "reply": "map_add_del_rule_reply"
 804         },
 805         "map_domain_dump": {
 806             "reply": "map_domain_details",
 807             "stream": true
 808         },
 809         "map_param_get": {
 810             "reply": "map_param_get_reply"
 811         },
 812         "map_param_set_icmp": {
 813             "reply": "map_param_set_icmp_reply"
 814         },
 815         "map_add_domain": {
 816             "reply": "map_add_domain_reply"
 817         },
 818         "map_summary_stats": {
 819             "reply": "map_summary_stats_reply"
 820         },
 821         "map_param_set_traffic_class": {
 822             "reply": "map_param_set_traffic_class_reply"
 823         },
 824         "map_del_domain": {
 825             "reply": "map_del_domain_reply"
 826         },
 827         "map_param_set_reassembly": {
 828             "reply": "map_param_set_reassembly_reply"
 829         },
 830         "map_param_set_security_check": {
 831             "reply": "map_param_set_security_check_reply"
 832         }
 833     },
 834     "enums": [
 835         [
 836             "address_family",
 837             [
 838                 "ADDRESS_IP4",
 839                 0
 840             ],
 841             [
 842                 "ADDRESS_IP6",
 843                 1
 844             ],
 845             {
 846                 "enumtype": "u32"
 847             }
 848         ]
 849     ],
 850     "types": [
 851         [
 852             "address",
 853             [
 854                 "vl_api_address_family_t",
 855                 "af"
 856             ],
 857             [
 858                 "vl_api_address_union_t",
 859                 "un"
 860             ],
 861             {
 862                 "crc": "0x09f11671"
 863             }
 864         ],
 865         [
 866             "prefix",
 867             [
 868                 "vl_api_address_t",
 869                 "address"
 870             ],
 871             [
 872                 "u8",
 873                 "address_length"
 874             ],
 875             {
 876                 "crc": "0x0403aebc"
 877             }
 878         ],
 879         [
 880             "mprefix",
 881             [
 882                 "vl_api_address_family_t",
 883                 "af"
 884             ],
 885             [
 886                 "u16",
 887                 "grp_address_length"
 888             ],
 889             [
 890                 "vl_api_address_union_t",
 891                 "grp_address"
 892             ],
 893             [
 894                 "vl_api_address_union_t",
 895                 "src_address"
 896             ],
 897             {
 898                 "crc": "0x1c4cba05"
 899             }
 900         ],
 901         [
 902             "ip6_prefix",
 903             [
 904                 "vl_api_ip6_address_t",
 905                 "prefix"
 906             ],
 907             [
 908                 "u8",
 909                 "len"
 910             ],
 911             {
 912                 "crc": "0x779fd64f"
 913             }
 914         ],
 915         [
 916             "ip4_prefix",
 917             [
 918                 "vl_api_ip4_address_t",
 919                 "prefix"
 920             ],
 921             [
 922                 "u8",
 923                 "len"
 924             ],
 925             {
 926                 "crc": "0xea8dc11d"
 927             }
 928         ]
 929     ],
 930     "aliases": {
 931         "ip6_address": {
 932             "length": 16,
 933             "type": "u8"
 934         },
 935         "ip4_address": {
 936             "length": 4,
 937             "type": "u8"
 938         }
 939     }
 940 }