Zebra

Zebra protocol parser/serializer

Zebra Protocol is used to communicate with the zebra daemon.

class ryu.lib.packet.zebra.InterfaceLinkParams(lp_status, te_metric, max_bw, max_reserved_bw, unreserved_bw, admin_group, remote_as, remote_ip, average_delay, min_delay, max_delay, delay_var, pkt_loss, residual_bw, average_bw, utilized_bw)

Interface Link Parameters class for if_link_params structure.

class ryu.lib.packet.zebra.NextHopBlackhole(ifindex=None, ifname=None, addr=None, type_=None)

Nexthop class for ZEBRA_NEXTHOP_BLACKHOLE type.

class ryu.lib.packet.zebra.NextHopIFIndex(ifindex=None, ifname=None, addr=None, type_=None)

Nexthop class for ZEBRA_NEXTHOP_IFINDEX type.

class ryu.lib.packet.zebra.NextHopIFName(ifindex=None, ifname=None, addr=None, type_=None)

Nexthop class for ZEBRA_NEXTHOP_IFNAME type.

class ryu.lib.packet.zebra.NextHopIPv4(ifindex=None, ifname=None, addr=None, type_=None)

Nexthop class for ZEBRA_NEXTHOP_IPV4 type.

class ryu.lib.packet.zebra.NextHopIPv4IFIndex(ifindex=None, ifname=None, addr=None, type_=None)

Nexthop class for ZEBRA_NEXTHOP_IPV4_IFINDEX type.

class ryu.lib.packet.zebra.NextHopIPv4IFName(ifindex=None, ifname=None, addr=None, type_=None)

Nexthop class for ZEBRA_NEXTHOP_IPV4_IFNAME type.

class ryu.lib.packet.zebra.NextHopIPv6(ifindex=None, ifname=None, addr=None, type_=None)

Nexthop class for ZEBRA_NEXTHOP_IPV6 type.

class ryu.lib.packet.zebra.NextHopIPv6IFIndex(ifindex=None, ifname=None, addr=None, type_=None)

Nexthop class for ZEBRA_NEXTHOP_IPV6_IFINDEX type.

class ryu.lib.packet.zebra.NextHopIPv6IFName(ifindex=None, ifname=None, addr=None, type_=None)

Nexthop class for ZEBRA_NEXTHOP_IPV6_IFNAME type.

class ryu.lib.packet.zebra.RegisteredNexthop(connected, family, prefix)

Unit of ZEBRA_NEXTHOP_REGISTER message body.

class ryu.lib.packet.zebra.ZebraHello(route_type=14)

Message body class for ZEBRA_HELLO.

class ryu.lib.packet.zebra.ZebraIPv4ImportLookup(prefix, metric=None, nexthops=None)

Message body class for ZEBRA_IPV4_IMPORT_LOOKUP.

class ryu.lib.packet.zebra.ZebraIPv4NexthopLookup(addr, metric=None, nexthops=None)

Message body class for ZEBRA_IPV4_NEXTHOP_LOOKUP.

class ryu.lib.packet.zebra.ZebraIPv4NexthopLookupMRib(addr, distance, metric, nexthops=None)

Message body class for ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB.

class ryu.lib.packet.zebra.ZebraIPv4RouteAdd(route_type, flags, message, safi=None, prefix=None, nexthops=None, ifindexes=None, distance=None, metric=None, mtu=None, tag=None, from_zebra=False)

Message body class for ZEBRA_IPV4_ROUTE_ADD.

class ryu.lib.packet.zebra.ZebraIPv4RouteDelete(route_type, flags, message, safi=None, prefix=None, nexthops=None, ifindexes=None, distance=None, metric=None, mtu=None, tag=None, from_zebra=False)

Message body class for ZEBRA_IPV4_ROUTE_DELETE.

class ryu.lib.packet.zebra.ZebraIPv6ImportLookup(prefix, metric=None, nexthops=None)

Message body class for ZEBRA_IPV6_IMPORT_LOOKUP.

class ryu.lib.packet.zebra.ZebraIPv6NexthopLookup(addr, metric=None, nexthops=None)

Message body class for ZEBRA_IPV6_NEXTHOP_LOOKUP.

class ryu.lib.packet.zebra.ZebraIPv6RouteAdd(route_type, flags, message, safi=None, prefix=None, nexthops=None, ifindexes=None, distance=None, metric=None, mtu=None, tag=None, from_zebra=False)

Message body class for ZEBRA_IPV6_ROUTE_ADD.

class ryu.lib.packet.zebra.ZebraIPv6RouteDelete(route_type, flags, message, safi=None, prefix=None, nexthops=None, ifindexes=None, distance=None, metric=None, mtu=None, tag=None, from_zebra=False)

Message body class for ZEBRA_IPV6_ROUTE_DELETE.

class ryu.lib.packet.zebra.ZebraInterfaceAdd(ifname, ifindex, status, if_flags, metric, ifmtu, ifmtu6, bandwidth, ll_type=None, hw_addr_len=0, hw_addr=None, link_params=None)

Message body class for ZEBRA_INTERFACE_ADD.

class ryu.lib.packet.zebra.ZebraInterfaceAddressAdd(ifindex, ifc_flags, family, prefix, dest)

Message body class for ZEBRA_INTERFACE_ADDRESS_ADD.

class ryu.lib.packet.zebra.ZebraInterfaceAddressDelete(ifindex, ifc_flags, family, prefix, dest)

Message body class for ZEBRA_INTERFACE_ADDRESS_DELETE.

class ryu.lib.packet.zebra.ZebraInterfaceDelete(ifname, ifindex, status, if_flags, metric, ifmtu, ifmtu6, bandwidth, ll_type=None, hw_addr_len=0, hw_addr=None, link_params=None)

Message body class for ZEBRA_INTERFACE_DELETE.

class ryu.lib.packet.zebra.ZebraInterfaceDown(ifname, ifindex, status, if_flags, metric, ifmtu, ifmtu6, bandwidth, ll_type=None, hw_addr_len=0, hw_addr=None, link_params=None)

Message body class for ZEBRA_INTERFACE_DOWN.

class ryu.lib.packet.zebra.ZebraInterfaceLinkParams(ifindex, link_params)

Message body class for ZEBRA_INTERFACE_LINK_PARAMS.

class ryu.lib.packet.zebra.ZebraInterfaceUp(ifname, ifindex, status, if_flags, metric, ifmtu, ifmtu6, bandwidth, ll_type=None, hw_addr_len=0, hw_addr=None, link_params=None)

Message body class for ZEBRA_INTERFACE_UP.

class ryu.lib.packet.zebra.ZebraMessage(length=None, version=3, vrf_id=0, command=None, body=None)

Zebra protocol parser/serializer class.

An instance has the following attributes at least. Most of them are same to the on-wire counterparts but in host byte order. __init__ takes the corresponding args in this order.

Attribute Description
length Total packet length including this header. The minimum length is 3 bytes for version 0 messages, 6 bytes for version 1/2 messages and 8 bytes for version 3 messages.
version Version number of the Zebra protocol message. To instantiate messages with other than the default version, version must be specified.
vrf_id VRF ID for the route contained in message. Not present in version 0/1/2 messages in the on-wire structure, and always 0 for theses version.
command Zebra Protocol command, which denotes message type.
body Messages body. An instance of subclass of _ZebraMessageBody named like "Zebra + <message name>" (e.g., ZebraHello). Or None if message does not contain any body.

Note

To instantiate Zebra messages, command can be omitted when the valid body is specified.

>>> from ryu.lib.packet import zebra
>>> zebra.ZebraMessage(body=zebra.ZebraHello())
ZebraMessage(body=ZebraHello(route_type=14),command=23,
length=None,version=3,vrf_id=0)

On the other hand, if body is omitted, command must be specified.

>>> zebra.ZebraMessage(command=zebra.ZEBRA_INTERFACE_ADD)
ZebraMessage(body=None,command=1,length=None,version=3,vrf_id=0)
class ryu.lib.packet.zebra.ZebraNexthopRegister(nexthops)

Message body class for ZEBRA_NEXTHOP_REGISTER.

class ryu.lib.packet.zebra.ZebraNexthopUnregister(nexthops)

Message body class for ZEBRA_NEXTHOP_UNREGISTER.

class ryu.lib.packet.zebra.ZebraNexthopUpdate(family, prefix, metric, nexthops=None)

Message body class for ZEBRA_NEXTHOP_UPDATE.

class ryu.lib.packet.zebra.ZebraRedistributeAdd(route_type)

Message body class for ZEBRA_REDISTRIBUTE_ADD.

class ryu.lib.packet.zebra.ZebraRedistributeDefaultAdd(route_type)

Message body class for ZEBRA_REDISTRIBUTE_DEFAULT_ADD.

class ryu.lib.packet.zebra.ZebraRedistributeDefaultDelete(route_type)

Message body class for ZEBRA_REDISTRIBUTE_DEFAULT_DELETE.

class ryu.lib.packet.zebra.ZebraRedistributeDelete(route_type)

Message body class for ZEBRA_REDISTRIBUTE_DELETE.

class ryu.lib.packet.zebra.ZebraRouterIDAdd

Message body class for ZEBRA_ROUTER_ID_ADD.

class ryu.lib.packet.zebra.ZebraRouterIDDelete

Message body class for ZEBRA_ROUTER_ID_DELETE.

class ryu.lib.packet.zebra.ZebraRouterIDUpdate(family, prefix)

Message body class for ZEBRA_ROUTER_ID_UPDATE.

class ryu.lib.packet.zebra.ZebraUnknownMessage(buf)

Message body class for Unknown command.

class ryu.lib.packet.zebra.ZebraVrfUnregister

Message body class for ZEBRA_VRF_UNREGISTER.

ryu.lib.packet.zebra.zebra

alias of ZebraMessage