src/vnet/flow/flow.api

   1 /*
   2  * Copyright (c) 2015-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 /** \brief Configure IPFIX exporter process request
  17     @param client_index - opaque cookie to identify the sender
  18     @param context - sender context, to match reply w/ request
  19     @param collector_address - address of IPFIX collector
  20     @param collector_port - port of IPFIX collector
  21     @param src_address - address of IPFIX exporter
  22     @param vrf_id - VRF / fib table ID
  23     @param path_mtu - Path MTU between exporter and collector
  24     @param template_interval - number of seconds after which to resend template
  25     @param udp_checksum - UDP checksum calculation enable flag
  26 */
  27 autoreply define set_ipfix_exporter
  28 {
  29   u32 client_index;
  30   u32 context;
  31   u8 collector_address[16];
  32   u16 collector_port;
  33   u8 src_address[16];
  34   u32 vrf_id;
  35   u32 path_mtu;
  36   u32 template_interval;
  37   u8 udp_checksum;
  38 };
  39
  40 /** \brief IPFIX exporter dump request
  41     @param client_index - opaque cookie to identify the sender
  42     @param context - sender context, to match reply w/ request
  43 */
  44 define ipfix_exporter_dump
  45 {
  46   u32 client_index;
  47   u32 context;
  48 };
  49
  50 /** \brief Reply to IPFIX exporter dump request
  51     @param context - sender context which was passed in the request
  52     @param collector_address - address of IPFIX collector
  53     @param collector_port - port of IPFIX collector
  54     @param src_address - address of IPFIX exporter
  55     @param fib_index - fib table index
  56     @param path_mtu - Path MTU between exporter and collector
  57     @param template_interval - number of seconds after which to resend template
  58     @param udp_checksum - UDP checksum calculation enable flag
  59 */
  60 define ipfix_exporter_details
  61 {
  62   u32 context;
  63   u8 collector_address[16];
  64   u16 collector_port;
  65   u8 src_address[16];
  66   u32 vrf_id;
  67   u32 path_mtu;
  68   u32 template_interval;
  69   u8 udp_checksum;
  70 };
  71
  72 /** \brief IPFIX classify stream configure request
  73     @param client_index - opaque cookie to identify the sender
  74     @param context - sender context, to match reply w/ request
  75     @param domain_id - domain ID reported in IPFIX messages for classify stream
  76     @param src_port - source port of UDP session for classify stream
  77 */
  78 autoreply define set_ipfix_classify_stream {
  79     u32 client_index;
  80     u32 context;
  81     u32 domain_id;
  82     u16 src_port;
  83 };
  84
  85 /** \brief IPFIX classify stream dump request
  86     @param client_index - opaque cookie to identify the sender
  87     @param context - sender context, to match reply w/ request
  88 */
  89 define ipfix_classify_stream_dump {
  90     u32 client_index;
  91     u32 context;
  92 };
  93
  94 /** \brief Reply to IPFIX classify stream dump request
  95     @param context - sender context, to match reply w/ request
  96     @param domain_id - domain ID reported in IPFIX messages for classify stream
  97     @param src_port - source port of UDP session for classify stream
  98 */
  99 define ipfix_classify_stream_details {
 100     u32 context;
 101     u32 domain_id;
 102     u16 src_port;
 103 };
 104
 105 /** \brief IPFIX add or delete classifier table request
 106     @param client_index - opaque cookie to identify the sender
 107     @param context - sender context, to match reply w/ request
 108     @param table_id - classifier table ID
 109     @param ip_version - version of IP used in the classifier table
 110     @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
 111 */
 112 autoreply define ipfix_classify_table_add_del {
 113     u32 client_index;
 114     u32 context;
 115     u32 table_id;
 116     u8 ip_version;
 117     u8 transport_protocol;
 118     u8 is_add;
 119 };
 120
 121 /** \brief IPFIX classify tables dump request
 122     @param client_index - opaque cookie to identify the sender
 123     @param context - sender context, to match reply w/ request
 124 */
 125 define ipfix_classify_table_dump {
 126     u32 client_index;
 127     u32 context;
 128 };
 129
 130 /** \brief Reply to IPFIX classify tables dump request
 131     @param context - sender context, to match reply w/ request
 132     @param table_id - classifier table ID
 133     @param ip_version - version of IP used in the classifier table
 134     @param transport_protocol - transport protocol used in the classifier table or 255 for unspecified
 135 */
 136 define ipfix_classify_table_details {
 137     u32 context;
 138     u32 table_id;
 139     u8 ip_version;
 140     u8 transport_protocol;
 141 };
 142
 143 /*
 144  * Local Variables:
 145  * eval: (c-set-style "gnu")
 146  * End:
 147  */