FD.io VPP  v21.06
Vector Packet Processing
fib_types.api File Reference

Go to the source code of this file.

Enumerations

enum  fib_path_nh_proto {
  FIB_API_PATH_NH_PROTO_IP4 = 0, FIB_API_PATH_NH_PROTO_IP6, FIB_API_PATH_NH_PROTO_MPLS, FIB_API_PATH_NH_PROTO_ETHERNET,
  FIB_API_PATH_NH_PROTO_BIER
}
 brief A path's nexthop protocol More...
 
enum  fib_path_flags { FIB_API_PATH_FLAG_NONE = 0, FIB_API_PATH_FLAG_RESOLVE_VIA_ATTACHED = 1, FIB_API_PATH_FLAG_RESOLVE_VIA_HOST = 2, FIB_API_PATH_FLAG_POP_PW_CW = 4 }
 Flags for the path. More...
 
enum  fib_path_type {
  FIB_API_PATH_TYPE_NORMAL = 0, FIB_API_PATH_TYPE_LOCAL, FIB_API_PATH_TYPE_DROP, FIB_API_PATH_TYPE_UDP_ENCAP,
  FIB_API_PATH_TYPE_BIER_IMP, FIB_API_PATH_TYPE_ICMP_UNREACH, FIB_API_PATH_TYPE_ICMP_PROHIBIT, FIB_API_PATH_TYPE_SOURCE_LOOKUP,
  FIB_API_PATH_TYPE_DVR, FIB_API_PATH_TYPE_INTERFACE_RX, FIB_API_PATH_TYPE_CLASSIFY
}
 

Variables

option version = "2.0.1"
 
import vnet ip ip_types api
 
typedef fib_mpls_label
 MPLS label. More...
 
u32 label
 
u8 ttl
 
u8 exp
 
typedef fib_path_nh
 
u32 via_label
 
u32 obj_id
 
u32 classify_table_index
 
typedef fib_path
 FIB path. More...
 
u32 table_id
 
u32 rpf_id
 
u8 weight
 
u8 preference
 
vl_api_fib_path_type_t type
 
vl_api_fib_path_flags_t flags
 
vl_api_fib_path_nh_proto_t proto
 
vl_api_fib_path_nh_t nh
 
u8 n_labels
 
vl_api_fib_mpls_label_t label_stack [16]
 

Enumeration Type Documentation

◆ fib_path_flags

Flags for the path.

Enumerator
FIB_API_PATH_FLAG_NONE 
FIB_API_PATH_FLAG_RESOLVE_VIA_ATTACHED 
FIB_API_PATH_FLAG_RESOLVE_VIA_HOST 
FIB_API_PATH_FLAG_POP_PW_CW 

Definition at line 43 of file fib_types.api.

◆ fib_path_nh_proto

brief A path's nexthop protocol

Enumerator
FIB_API_PATH_NH_PROTO_IP4 
FIB_API_PATH_NH_PROTO_IP6 
FIB_API_PATH_NH_PROTO_MPLS 
FIB_API_PATH_NH_PROTO_ETHERNET 
FIB_API_PATH_NH_PROTO_BIER 

Definition at line 32 of file fib_types.api.

◆ fib_path_type

Enumerator
FIB_API_PATH_TYPE_NORMAL 
FIB_API_PATH_TYPE_LOCAL 
FIB_API_PATH_TYPE_DROP 
FIB_API_PATH_TYPE_UDP_ENCAP 
FIB_API_PATH_TYPE_BIER_IMP 
FIB_API_PATH_TYPE_ICMP_UNREACH 
FIB_API_PATH_TYPE_ICMP_PROHIBIT 
FIB_API_PATH_TYPE_SOURCE_LOOKUP 
FIB_API_PATH_TYPE_DVR 
FIB_API_PATH_TYPE_INTERFACE_RX 
FIB_API_PATH_TYPE_CLASSIFY 

Definition at line 71 of file fib_types.api.

Variable Documentation

◆ api

import vnet ip ip_types api

Definition at line 18 of file fib_types.api.

◆ classify_table_index

u32 classify_table_index

Definition at line 68 of file fib_types.api.

◆ exp

u8 exp

Definition at line 27 of file fib_types.api.

◆ fib_mpls_label

typedef fib_mpls_label
Initial value:
{
u8 is_uniform
unsigned char u8
Definition: types.h:56

MPLS label.

Definition at line 23 of file fib_types.api.

◆ fib_path

typedef fib_path
Initial value:
{
unsigned int u32
Definition: types.h:88
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34

FIB path.

Template Parameters
sw_if_index- index of the interface
table_id- The table ID in which to find the next-hop address (for recursive routes, i.e. when the interface is not given)
weight- The weight, for UCMP
preference- The preference of the path. lowest preference is prefered
rpf-id- For paths that pop to multicast, this the the RPF ID the packet will be given (0 and ~0 => unset)
type- the path type
flags- path flags
proto- protocol that describes the next-hop address
nh- the next-hop/net resolving object
n_labels- the number of labels present in the stack
label_stack- a stack of MPLS labels

Definition at line 116 of file fib_types.api.

◆ fib_path_nh

typedef fib_path_nh
Initial value:
{
vl_api_address_union_t address
manual_print typedef address
Definition: ip_types.api:96

Definition at line 60 of file fib_types.api.

◆ flags

vl_api_fib_path_flags_t flags

Definition at line 124 of file fib_types.api.

◆ label

u32 label

Definition at line 25 of file fib_types.api.

◆ label_stack

vl_api_fib_mpls_label_t label_stack[16]

Definition at line 128 of file fib_types.api.

◆ n_labels

u8 n_labels

Definition at line 127 of file fib_types.api.

◆ nh

vl_api_address_t nh

Definition at line 126 of file fib_types.api.

◆ obj_id

u32 obj_id

Definition at line 66 of file fib_types.api.

◆ preference

u8 preference

Definition at line 121 of file fib_types.api.

◆ proto

vl_api_fib_path_nh_proto_t proto

Definition at line 125 of file fib_types.api.

◆ rpf_id

u32 rpf_id

Definition at line 119 of file fib_types.api.

◆ table_id

u32 table_id

Definition at line 118 of file fib_types.api.

◆ ttl

u8 ttl

Definition at line 26 of file fib_types.api.

◆ type

vl_api_fib_path_type_t type

Definition at line 123 of file fib_types.api.

◆ version

option version = "2.0.1"

Definition at line 17 of file fib_types.api.

◆ via_label

u32 via_label

Definition at line 64 of file fib_types.api.

◆ weight

u8 weight

Definition at line 120 of file fib_types.api.