src/plugins/stn/stn.api

   1 /*
   2  * Copyright (c) 2017 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 /**
  17  * @file stn.api
  18  * @brief VPP control-plane API messages for STN plugin.
  19  *
  20  */
  21
  22 option version = "1.0.0";
  23
  24 /** \brief Add/del STN rules
  25     @param client_index - opaque cookie to identify the sender
  26     @param context - sender context, to match reply w/ request
  27     @param is_ip4 - 1 if address type is IPv4
  28     @param ip_address - STN rule IP address
  29     @param sw_if_index - Interface index
  30     @param is_add - 1 if add, 0 if delete
  31 */
  32 autoreply manual_print define stn_add_del_rule {
  33   u32 client_index;
  34   u32 context;
  35   u8 is_ip4;
  36   u8 ip_address[16];
  37   u32 sw_if_index;
  38   u8 is_add;
  39 };
  40
  41 /** \brief Dump STN rules
  42     @param client_index - opaque cookie to identify the sender
  43     @param context - sender context, to match reply w/ request
  44 */
  45 define stn_rules_dump {
  46   u32 client_index;
  47   u32 context;
  48 };
  49
  50 /** \brief STN response to rules request
  51     @param context - sender context, to match reply w/ request
  52     @param is_ip4 - 1 if address type is IPv4
  53     @param ip_address - IP address
  54     @param sw_if_index - Interface index
  55 */
  56 define stn_rule_details {
  57   u32 context;
  58   u8 is_ip4;
  59   u8 ip_address[16];
  60   u32 sw_if_index;
  61 };
  62