summaryrefslogtreecommitdiffstats
path: root/src/vnet
diff options
context:
space:
mode:
authorIan Wells <iawells@cisco.com>2018-10-04 12:31:11 -0700
committerNeale Ranns <nranns@cisco.com>2018-10-05 03:46:48 +0000
commit412ecd320acb9add4a22426b8ed4e035eb08ebc4 (patch)
tree14dd5d7222c04a373fdef3124f1bb473a197e140 /src/vnet
parentefd9cf302ff6cbaf3c51e69bb9ea6c29e2325a10 (diff)
Improve ip_mroute_add_del documentation
Change-Id: Ieb882cc67c37bf591b6c737234263c7c35416e6d Signed-Off-By: Ian Wells <iawells@cisco.com>
Diffstat (limited to 'src/vnet')
-rw-r--r--src/vnet/ip/ip.api28
1 files changed, 24 insertions, 4 deletions
diff --git a/src/vnet/ip/ip.api b/src/vnet/ip/ip.api
index 5cd0dfaac54..a34f0d0305f 100644
--- a/src/vnet/ip/ip.api
+++ b/src/vnet/ip/ip.api
@@ -443,12 +443,32 @@ define ip_add_del_route_reply
};
/** \brief Add / del route request
+
+ Adds a route, consisting both of the MFIB entry to match packets
+ (which may already exist) and a path to send those packets down.
+ Routes can be entered repeatedly to add multiple paths. Deletions are
+ per-path.
+
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param sw_if_index - software index of the new vlan's parent interface
- @param vrf_id - fib table /vrf associated with the route
- @param next_hop_afi - Use dpo_proto_t
- FIXME
+ @param table_id - fib table /vrf associated with the route
+ @param is_add - true if adding a route; false if deleting one
+ @param is_ipv6 - true iff all the addresses are v6
+ @param entry_flags - see fib_entry_flag_t
+ @param itf_flags - see mfib_entry_flags_t
+ @param next_hop_afi - see dpo_proto_t; the type of destination description
+ @param src_address - the source of the packet
+ @param grp_address - the group the packet is destined to
+ @param nh_address - the nexthop to forward the packet to
+ @param next_hop_sw_if_index - interface to emit packet on
+
+ BIER AFIs use the BIER imposition ID. v4 and v6 AFIs use either the
+ interface or the nexthop address.
+
+ Note that if the route is source-specific (S is supplied, not all 0s),
+ the prefix match is treated as exact (prefixlen /32 or /128).
+
+ FIXME not complete yet
*/
define ip_mroute_add_del
{