src/plugins/map/map.api

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 option version = "2.1.0";
  17
  18 import "vnet/ip/ip_types.api";
  19
  20 /** \brief Add MAP domains
  21     @param client_index - opaque cookie to identify the sender
  22     @param context - sender context, to match reply w/ request
  23     @param ip6_prefix - Rule IPv6 prefix
  24     @param ip4_prefix - Rule IPv4 prefix
  25     @param ip6_src - MAP domain IPv6 BR address / Tunnel source
  26     @param ea_bits_len - Embedded Address bits length
  27     @param psid_offset - Port Set Identifider (PSID) offset
  28     @param psid_length - PSID length
  29     @param mtu - MTU
  30 */
  31 define map_add_domain
  32 {
  33   u32 client_index;
  34   u32 context;
  35   vl_api_ip6_prefix_t ip6_prefix;
  36   vl_api_ip4_prefix_t ip4_prefix;
  37   vl_api_ip6_prefix_t ip6_src;
  38   u8 ea_bits_len;
  39   u8 psid_offset;
  40   u8 psid_length;
  41   u8 is_translation;
  42   u8 is_rfc6052;
  43   u16 mtu;
  44 };
  45
  46 /** \brief Reply for MAP domain add
  47     @param context - returned sender context, to match reply w/ request
  48     @param index - MAP domain index
  49     @param retval - return code
  50 */
  51 define map_add_domain_reply
  52 {
  53   u32 context;
  54   u32 index;
  55   i32 retval;
  56 };
  57
  58 /** \brief Delete MAP domain
  59     @param client_index - opaque cookie to identify the sender
  60     @param context - sender context, to match reply w/ request
  61     @param index - MAP Domain index
  62 */
  63 autoreply define map_del_domain
  64 {
  65   u32 client_index;
  66   u32 context;
  67   u32 index;
  68 };
  69
  70
  71 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
  72     @param client_index - opaque cookie to identify the sender
  73     @param context - sender context, to match reply w/ request
  74     @param index - MAP Domain index
  75     @param is_add - If 1 add rule, if 0 delete rule
  76     @param ip6_dst - MAP CE IPv6 address
  77     @param psid - Rule PSID
  78 */
  79 autoreply define map_add_del_rule
  80 {
  81   u32 client_index;
  82   u32 context;
  83   u32 index;
  84   u8 is_add;
  85   vl_api_ip6_address_t ip6_dst;
  86   u16 psid;
  87 };
  88
  89
  90 /** \brief Get list of map domains
  91     @param client_index - opaque cookie to identify the sender
  92 */
  93 define map_domain_dump
  94 {
  95   u32 client_index;
  96   u32 context;
  97 };
  98
  99 define map_domain_details
 100 {
 101   u32 context;
 102   u32 domain_index;
 103   vl_api_ip6_prefix_t ip6_prefix;
 104   vl_api_ip4_prefix_t ip4_prefix;
 105   vl_api_ip6_prefix_t ip6_src;
 106   u8 ea_bits_len;
 107   u8 psid_offset;
 108   u8 psid_length;
 109   u8 flags;
 110   u16 mtu;
 111   u8 is_translation;
 112 };
 113
 114 define map_rule_dump
 115 {
 116   u32 client_index;
 117   u32 context;
 118   u32 domain_index;
 119 };
 120
 121 define map_rule_details
 122 {
 123   u32 context;
 124   vl_api_ip6_address_t ip6_dst;
 125   u16 psid;
 126 };
 127
 128 /** \brief Request for a single block of summary stats
 129     @param client_index - opaque cookie to identify the sender
 130     @param context - sender context, to match reply w/ request
 131 */
 132 define map_summary_stats
 133 {
 134   u32 client_index;
 135   u32 context;
 136 };
 137
 138 /** \brief Reply for map_summary_stats request
 139     @param context - sender context, to match reply w/ request
 140     @param retval - return code for request
 141     @param total_bindings -
 142     @param total_pkts -
 143     @param total_ip4_fragments -
 144     @param total_security_check -
 145 */
 146 define map_summary_stats_reply
 147 {
 148   u32 context;
 149   i32 retval;
 150   u64 total_bindings;
 151   u64 total_pkts[2];
 152   u64 total_bytes[2];
 153   u64 total_ip4_fragments;
 154   u64 total_security_check[2];
 155 };