/** \file
This file defines vpp IP control-plane API messages which are generally
- called through a shared memory interface.
+ called through a shared memory interface.
*/
-option version = "3.0.0";
+option version = "3.0.2";
+import "vnet/interface_types.api";
import "vnet/fib/fib_types.api";
import "vnet/ethernet/ethernet_types.api";
import "vnet/mfib/mfib_types.api";
/** \brief An IP table
@param is_ipv6 - V4 or V6 table
@param table_id - table ID associated with the route
- This table ID will apply to both the unicats
- and mlticast FIBs
+ This table ID will apply to both the unicast
+ and multicast FIBs
@param name - A client provided name/tag for the table. If this is
not set by the client, then VPP will generate something
- meaningfull.
+ meaningful.
*/
typedef ip_table
{
{
u32 client_index;
u32 context;
- bool is_add;
+ bool is_add [default=true];
vl_api_ip_table_t table;
};
has a very different set of entries it wants in the table than VPP
currently has. The CP would thus like to 'replace' VPP's current table
only by specifying what the new set of entries shall be, i.e. it is not
- going to delete anything that already eixts.
- the CP delcartes the start of this procedure with this begin_replace
+ going to delete anything that already exists.
+ the CP declares the start of this procedure with this begin_replace
API Call, and when it has populated all the entries it wants, it calls
- the below end_replace API. From this point on it is of coursce free
+ the below end_replace API. From this point on it is of course free
to add and delete entries as usual.
The underlying mechanism by which VPP implements this replace is
purposefully left unspecified.
@param context - sender context
@param table - description of the table
*/
-manual_endian manual_print define ip_table_details
+define ip_table_details
{
u32 context;
vl_api_ip_table_t table;
{
u32 client_index;
u32 context;
- bool is_add;
+ bool is_add [default=true];
bool is_multipath;
vl_api_ip_route_t route;
};
/** \brief IP FIB table entry response
@param route The route entry in the table
*/
-manual_endian manual_print define ip_route_details
+define ip_route_details
{
u32 context;
vl_api_ip_route_t route;
};
+/** \brief Lookup IP route from a table
+ @param client_index - opaque cookie to identify the sender
+ @param table_id - The IP table to look the route up in
+ @param exact - 0 for normal route lookup, 1 for exact match only
+ @param prefix - The prefix (or host) for route lookup.
+*/
+define ip_route_lookup
+{
+ u32 client_index;
+ u32 context;
+ u32 table_id;
+ u8 exact;
+ vl_api_prefix_t prefix;
+};
+
+/** \brief IP FIB table lookup response
+ @param retval - return code of the lookup
+ @param route - The route entry in the table if found
+*/
+define ip_route_lookup_reply
+{
+ u32 context;
+ i32 retval;
+ vl_api_ip_route_t route;
+};
+
/** \brief Set the ip flow hash config for a fib request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
*/
autoreply define set_ip_flow_hash
{
+ option deprecated;
u32 client_index;
u32 context;
u32 vrf_id;
bool is_ipv6;
- u8 src;
- u8 dst;
- u8 sport;
- u8 dport;
- u8 proto;
- u8 reverse;
- u8 symmetric;
+ bool src;
+ bool dst;
+ bool sport;
+ bool dport;
+ bool proto;
+ bool reverse;
+ bool symmetric;
+};
+
+/**
+ @brief flow hash settings for an IP table
+ @param src - include src in flow hash
+ @param dst - include dst in flow hash
+ @param sport - include sport in flow hash
+ @param dport - include dport in flow hash
+ @param proto - include proto in flow hash
+ @param reverse - include reverse in flow hash
+ @param symmetric - include symmetry in flow hash
+ @param flowlabel - include flowlabel in flow hash
+*/
+enumflag ip_flow_hash_config
+{
+ IP_API_FLOW_HASH_SRC_IP = 0x01,
+ IP_API_FLOW_HASH_DST_IP = 0x02,
+ IP_API_FLOW_HASH_SRC_PORT = 0x04,
+ IP_API_FLOW_HASH_DST_PORT = 0x08,
+ IP_API_FLOW_HASH_PROTO = 0x10,
+ IP_API_FLOW_HASH_REVERSE = 0x20,
+ IP_API_FLOW_HASH_SYMETRIC = 0x40,
+ IP_API_FLOW_HASH_FLOW_LABEL = 0x80,
+};
+
+autoreply define set_ip_flow_hash_v2
+{
+ u32 client_index;
+ u32 context;
+ u32 table_id;
+ vl_api_address_family_t af;
+ vl_api_ip_flow_hash_config_t flow_hash_config;
};
/** \brief IPv6 interface enable / disable request
typedef ip_mroute
{
u32 table_id;
- u32 entry_flags;
+ vl_api_mfib_entry_flags_t entry_flags;
u32 rpf_id;
vl_api_mprefix_t prefix;
u8 n_paths;
{
u32 client_index;
u32 context;
- bool is_add;
+ bool is_add [default=true];
bool is_multipath;
vl_api_ip_mroute_t route;
};
/** \brief IP Multicast Route Details
@param route - Details of the route
*/
-manual_endian manual_print define ip_mroute_details
+define ip_mroute_details
{
u32 context;
vl_api_ip_mroute_t route;
/** \brief IP unnumbered configurations
@param sw_if_index The interface that has unnumbered configuration
- @param ip_sw_if_index The IP interface that it is unnnumbered to
+ @param ip_sw_if_index The IP interface that it is unnumbered to
*/
define ip_unnumbered_details
{
{
u32 client_index;
u32 context;
- vl_api_interface_index_t sw_if_index;
+ vl_api_interface_index_t sw_if_index [default=0xffffffff];
};
define ip_details
u32 client_index;
u32 context;
u32 policer_index;
- bool is_add;
+ bool is_add [default=true];
bool is_ip6;
};
/** \brief Punt redirect type
@param rx_sw_if_index - specify the original RX interface of traffic
that should be redirected. ~0 means any interface.
- @param tx_sw_if_index - the TX interface to which traffic shoulde be
+ @param tx_sw_if_index - the TX interface to which traffic should be
redirected.
@param nh - the next-hop to redirect the traffic to.
@param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
u32 client_index;
u32 context;
vl_api_punt_redirect_t punt;
- bool is_add;
+ bool is_add [default=true];
};
define ip_punt_redirect_dump
u32 context;
vl_api_prefix_t pfx;
vl_api_interface_index_t sw_if_index;
- bool is_add;
+ bool is_add [default=true];
};
define ip_container_proxy_dump
{
u32 client_index;
u32 context;
- bool is_add;
+ bool is_add [default=true];
vl_api_prefix_t prefix;
u8 number_of_ranges;
u16 low_ports[32];
{
u32 client_index;
u32 context;
- bool is_add;
+ bool is_add [default=true];
vl_api_interface_index_t sw_if_index;
u32 tcp_in_vrf_id;
u32 tcp_out_vrf_id;
u32 udp_out_vrf_id;
};
-/** \brief Set interface source check request
+/** \brief IPv6 set link local address on interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param is_add - add or del
- @param loose - strict or loose
- @param sw_if_index - interface index
+ @param sw_if_index - interface to set link local on
+ @param ip - the new link local address
*/
-autoreply define ip_source_check_interface_add_del
+autoreply define sw_interface_ip6_set_link_local_address
{
u32 client_index;
u32 context;
- bool is_add;
- u8 loose;
vl_api_interface_index_t sw_if_index;
+ vl_api_ip6_address_t ip;
};
-/** \brief IPv6 set link local address on interface request
+/** \brief IPv6 get link local address on interface request
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface to set link local on
- @param ip - the new link local address
*/
-autoreply define sw_interface_ip6_set_link_local_address
+define sw_interface_ip6_get_link_local_address
{
u32 client_index;
u32 context;
vl_api_interface_index_t sw_if_index;
+};
+
+/** \brief IPv6 link local address detail
+ @param context - sender context, to match reply w/ request
+ @param ip - the link local address
+*/
+define sw_interface_ip6_get_link_local_address_reply
+{
+ u32 context;
+ i32 retval;
vl_api_ip6_address_t ip;
};
/** \brief IOAM enable : Enable in-band OAM
@param id - profile id
@param seqno - To enable Seqno Processing
- @param analyse - Enabling analysis of iOAM at decap node
- @param pot_enable - Proof of Work enabled or not flag
+ @param analyse - Enabling analysis of iOAM at decap node
+ @param pow_enable - Proof of Work enabled or not flag
@param trace_enable - iOAM Trace enabled or not flag
*/
autoreply define ioam_enable
u32 client_index;
u32 context;
u16 id;
- u8 seqno;
- u8 analyse;
- u8 pot_enable;
- u8 trace_enable;
+ bool seqno;
+ bool analyse;
+ bool pot_enable;
+ bool trace_enable;
u32 node_id;
};
Code Review / vpp.git / blobdiff