2.83. vpp_ip_route module

IP Routes

object abstractions for representing IP routes in VPP

class vpp_ip_route.DpoProto

DPO_PROTO_BIER = 4

DPO_PROTO_ETHERNET = 3

DPO_PROTO_IP4 = 0

DPO_PROTO_IP6 = 1

DPO_PROTO_MPLS = 2

DPO_PROTO_NSH = 5

class vpp_ip_route.MRouteEntryFlags

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

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

PIPE = 0

UNIFORM = 1

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

Bases: vpp_object.VppObject

IP Multicast Route

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.

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, is_ip6=0, is_local=0, is_unreach=0, is_prohibit=0)

Bases: vpp_object.VppObject

IP Route

add_vpp_config()

Add the configuration for this object to vpp.

modify(paths, is_local=0, is_unreach=0, is_prohibit=0)

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.

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.VppMFibSignal(test, route, interface, packet)

Bases: object

compare(signal)

class vpp_ip_route.VppMRoutePath(nh_sw_if_index, flags, proto=0, bier_imp=0)

Bases: vpp_ip_route.VppRoutePath

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)

Bases: vpp_object.VppObject

MPLS Route/LSP

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.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, is_interface_rx=0, is_resolve_host=0, is_resolve_attached=0, is_source_lookup=0, is_udp_encap=0, is_dvr=0, next_hop_id=4294967295, proto=0)

Bases: object

encode()

encode_labels()

vpp_ip_route.find_route(test, ip_addr, len, table_id=0, inet=2)