2.139. vpp_ip_route module

IP Routes

object abstractions for representing IP routes in VPP

class vpp_ip_route.FibPathFlags

Bases: object

FIB_PATH_FLAG_NONE = 0
FIB_PATH_FLAG_POP_PW_CW = 4
FIB_PATH_FLAG_RESOLVE_VIA_ATTACHED = 1
FIB_PATH_FLAG_RESOLVE_VIA_HOST = 2
class vpp_ip_route.FibPathProto

Bases: object

FIB_PATH_NH_PROTO_BIER = 4
FIB_PATH_NH_PROTO_ETHERNET = 3
FIB_PATH_NH_PROTO_IP4 = 0
FIB_PATH_NH_PROTO_IP6 = 1
FIB_PATH_NH_PROTO_MPLS = 2
FIB_PATH_NH_PROTO_NSH = 5
class vpp_ip_route.FibPathType

Bases: object

FIB_PATH_TYPE_BIER_IMP = 4
FIB_PATH_TYPE_CLASSIFY = 10
FIB_PATH_TYPE_DROP = 2
FIB_PATH_TYPE_DVR = 8
FIB_PATH_TYPE_ICMP_PROHIBIT = 6
FIB_PATH_TYPE_ICMP_UNREACH = 5
FIB_PATH_TYPE_INTERFACE_RX = 9
FIB_PATH_TYPE_LOCAL = 1
FIB_PATH_TYPE_NORMAL = 0
FIB_PATH_TYPE_SOURCE_LOOKUP = 7
FIB_PATH_TYPE_UDP_ENCAP = 3
class vpp_ip_route.MRouteEntryFlags

Bases: object

MFIB_ENTRY_FLAG_CONNECTED = 4
MFIB_ENTRY_FLAG_DROP = 2
MFIB_ENTRY_FLAG_INHERIT_ACCEPT = 8
MFIB_ENTRY_FLAG_NONE = 0
MFIB_ENTRY_FLAG_SIGNAL = 1
class vpp_ip_route.MRouteItfFlags

Bases: object

MFIB_ITF_FLAG_ACCEPT = 2
MFIB_ITF_FLAG_FORWARD = 4
MFIB_ITF_FLAG_INTERNAL_COPY = 16
MFIB_ITF_FLAG_NEGATE_SIGNAL = 1
MFIB_ITF_FLAG_NONE = 0
MFIB_ITF_FLAG_SIGNAL_PRESENT = 8
class vpp_ip_route.MplsLspMode

Bases: object

PIPE = 0
UNIFORM = 1
class vpp_ip_route.VppFibPathNextHop(addr, via_label=1048576, next_hop_id=4294967295)

Bases: object

encode()
proto()
class vpp_ip_route.VppIp6LinkLocalAddress(test, intf, addr)

Bases: vpp_object.VppObject

add_vpp_config()

Add the configuration for this object to vpp.

object_id()

Return a unique string representing this object.

query_vpp_config()

Query the vpp configuration.

Returns

True if the object is configured

remove_vpp_config()

Remove the configuration for this object from vpp.

class vpp_ip_route.VppIpInterfaceAddress(test, intf, addr, len, bind=None)

Bases: vpp_object.VppObject

add_vpp_config()

Add the configuration for this object to vpp.

object_id()

Return a unique string representing this object.

query_vpp_config()

Query the vpp configuration.

Returns

True if the object is configured

remove_vpp_config()

Remove the configuration for this object from vpp.

class vpp_ip_route.VppIpInterfaceBind(test, intf, table)

Bases: vpp_object.VppObject

add_vpp_config()

Add the configuration for this object to vpp.

object_id()

Return a unique string representing this object.

query_vpp_config()

Query the vpp configuration.

Returns

True if the object is configured

remove_vpp_config()

Remove the configuration for this object from vpp.

class vpp_ip_route.VppIpMRoute(test, src_addr, grp_addr, grp_addr_len, e_flags, paths, table_id=0, rpf_id=0)

Bases: vpp_object.VppObject

IP Multicast Route

add_vpp_config()

Add the configuration for this object to vpp.

encode(paths=None)
get_stats()
object_id()

Return a unique string representing this object.

query_vpp_config()

Query the vpp configuration.

Returns

True if the object is configured

remove_vpp_config()

Remove the configuration for this object from vpp.

update_entry_flags(flags)
update_path_flags(itf, flags)
update_rpf_id(rpf_id)
class vpp_ip_route.VppIpRoute(test, dest_addr, dest_addr_len, paths, table_id=0, register=True)

Bases: vpp_object.VppObject

IP Route

add_vpp_config()

Add the configuration for this object to vpp.

get_stats_to()
get_stats_via()
modify(paths)
object_id()

Return a unique string representing this object.

query_vpp_config()

Query the vpp configuration.

Returns

True if the object is configured

remove_vpp_config()

Remove the configuration for this object from vpp.

class vpp_ip_route.VppIpTable(test, table_id, is_ip6=0)

Bases: vpp_object.VppObject

add_vpp_config()

Add the configuration for this object to vpp.

dump()
flush()
mdump()
object_id()

Return a unique string representing this object.

query_vpp_config()

Query the vpp configuration.

Returns

True if the object is configured

remove_vpp_config()

Remove the configuration for this object from vpp.

replace_begin()
replace_end()
class vpp_ip_route.VppMFibSignal(test, route, interface, packet)

Bases: object

compare(signal)
class vpp_ip_route.VppMRoutePath(nh_sw_if_index, flags, nh=None, proto=0, type=0, bier_imp=4294967295)

Bases: vpp_ip_route.VppRoutePath

encode()
class vpp_ip_route.VppMplsIpBind(test, local_label, dest_addr, dest_addr_len, table_id=0, ip_table_id=0, is_ip6=0)

Bases: vpp_object.VppObject

MPLS to IP Binding

add_vpp_config()

Add the configuration for this object to vpp.

object_id()

Return a unique string representing this object.

query_vpp_config()

Query the vpp configuration.

Returns

True if the object is configured

remove_vpp_config()

Remove the configuration for this object from vpp.

class vpp_ip_route.VppMplsLabel(value, mode=0, ttl=64, exp=0)

Bases: object

encode()
class vpp_ip_route.VppMplsRoute(test, local_label, eos_bit, paths, table_id=0, is_multicast=0, eos_proto=0)

Bases: vpp_object.VppObject

MPLS Route/LSP

add_vpp_config()

Add the configuration for this object to vpp.

get_stats_to()
get_stats_via()
object_id()

Return a unique string representing this object.

query_vpp_config()

Query the vpp configuration.

Returns

True if the object is configured

remove_vpp_config()

Remove the configuration for this object from vpp.

class vpp_ip_route.VppMplsTable(test, table_id)

Bases: vpp_object.VppObject

add_vpp_config()

Add the configuration for this object to vpp.

object_id()

Return a unique string representing this object.

query_vpp_config()

Query the vpp configuration.

Returns

True if the object is configured

remove_vpp_config()

Remove the configuration for this object from vpp.

class vpp_ip_route.VppRoutePath(nh_addr, nh_sw_if_index, nh_table_id=0, labels=[], nh_via_label=1048576, rpf_id=0, next_hop_id=4294967295, proto=None, flags=0, type=0)

Bases: object

encode()
encode_labels()
vpp_ip_route.address_proto(ip_addr)
vpp_ip_route.fib_interface_ip_prefix(test, addr, len, sw_if_index)
vpp_ip_route.find_mpls_route(test, table_id, label, eos_bit, paths=None)
vpp_ip_route.find_mroute(test, grp_addr, src_addr, grp_addr_len, table_id=0)
vpp_ip_route.find_mroute_in_dump(dump, route, table)
vpp_ip_route.find_route(test, addr, len, table_id=0, sw_if_index=None)
vpp_ip_route.find_route_in_dump(dump, route, table)
vpp_ip_route.ip_to_dpo_proto(addr)
vpp_ip_route.mk_network(addr, len)