rib.xif

xorp源码hg

/* $XORP: xorp/xrl/interfaces/rib.xif,v 1.21 2006/01/04 05:55:29 pavlin Exp $ */

/*
 * Routing Information Base XRL interface.
 */

interface rib/0.1 {
	/**
	 * Enable/disable/start/stop RIB.
	 */
	enable_rib
	disable_rib
	start_rib
	stop_rib

	/**
	 * Make errors fatal; used to detect errors we'd normally mask
	 */
	make_errors_fatal

	/**
	 * Get the list of registered protocols.
	 *
	 * @param ipv4 if true, then include the IPv4 protocols.
	 * @param ipv6 if true, then include the IPv6 protocols.
	 * @param unicast if true, then include the protocols registered
	 * with the unicast RIB.
	 * @param multicast if true, then include the protocols registered
	 * with the multicast RIB.
	 * @param ipv4_unicast_protocols the list of IPv4 protocols registered
	 * with the unicast RIB.
	 * @param ipv6_unicast_protocols the list of IPv6 protocols registered
	 * with the unicast RIB.
	 * @param ipv4_multicast_protocols the list of IPv4 protocols
	 * registered with the multicast RIB.
	 * @param ipv6_multicast_protocols the list of IPv6 protocols
	 * registered with the multicast RIB.
	 */
	get_registered_protocols	? ipv4:bool & ipv6:bool		\
					& unicast:bool & multicast:bool	\
					-> ipv4_unicast_protocols:list	\
					& ipv6_unicast_protocols:list	\
					& ipv4_multicast_protocols:list	\
					& ipv6_multicast_protocols:list

	/**
	 * Add/delete an IGP or EGP table.
	 *
	 * @param protocol the name of the protocol.
	 * @param target_class the target class of the protocol.
	 * @param target_instance the target instance of the protocol.
	 * @param unicast true if the table is for the unicast RIB.
	 * @param multicast true if the table is for the multicast RIB.
	 */
	add_igp_table4		? protocol:txt				\
				& target_class:txt & target_instance:txt\
				& unicast:bool & multicast:bool

	add_igp_table6		? protocol:txt				\
				& target_class:txt & target_instance:txt\
				& unicast:bool & multicast:bool

	delete_igp_table4	? protocol:txt				\
				& target_class:txt & target_instance:txt\
				& unicast:bool & multicast:bool

	delete_igp_table6	? protocol:txt				\
				& target_class:txt & target_instance:txt\
				& unicast:bool & multicast:bool

	add_egp_table4		? protocol:txt				\
				& target_class:txt & target_instance:txt\
				& unicast:bool & multicast:bool

	add_egp_table6		? protocol:txt				\
				& target_class:txt & target_instance:txt\
				& unicast:bool & multicast:bool

	delete_egp_table4	? protocol:txt				\
				& target_class:txt & target_instance:txt\
				& unicast:bool & multicast:bool

	delete_egp_table6	? protocol:txt				\
				& target_class:txt & target_instance:txt\
				& unicast:bool & multicast:bool

	/**
	 * Add/replace/delete a route.
	 *
	 * @param protocol the name of the protocol this route comes from.
	 * @param unicast true if the route is for the unicast RIB.
	 * @param multicast true if the route is for the multicast RIB.
	 * @param network the network address prefix of the route.
	 * @param nexthop the address of the next-hop router toward the
	 * destination.
	 * @param metric the routing metric.
	 * @param policytags a set of policy tags used for redistribution.
	 */
	add_route4	? protocol:txt & unicast:bool & multicast:bool	\
			& network:ipv4net & nexthop:ipv4 & metric:u32   \
			& policytags:list

	add_route6	? protocol:txt & unicast:bool & multicast:bool	\
			& network:ipv6net & nexthop:ipv6 & metric:u32   \
			& policytags:list

	replace_route4	? protocol:txt & unicast:bool & multicast:bool	\
			& network:ipv4net & nexthop:ipv4 & metric:u32   \
			& policytags:list

	replace_route6	? protocol:txt & unicast:bool & multicast:bool	\
			& network:ipv6net & nexthop:ipv6 & metric:u32   \
			& policytags:list

	delete_route4	? protocol:txt & unicast:bool & multicast:bool	\
			& network:ipv4net

	delete_route6	? protocol:txt & unicast:bool & multicast:bool	\
			& network:ipv6net

	/**
	 * Add/replace a route by explicitly specifying the network
	 * interface toward the destination.
	 *
	 * @param protocol the name of the protocol this route comes from.
	 * @param unicast true if the route is for the unicast RIB.
	 * @param multicast true if the route is for the multicast RIB.
	 * @param network the network address prefix of the route.
	 * @param nexthop the address of the next-hop router toward the
	 * destination.
	 * @param ifname of the name of the physical interface toward the
	 * destination.
	 * @param vifname of the name of the virtual interface toward the
	 * destination.
	 * @param metric the routing metric.
	 * @param policytags a set of policy tags used for redistribution.
	 */
	add_interface_route4	? protocol:txt				\
				& unicast:bool & multicast:bool		\
				& network:ipv4net & nexthop:ipv4	\
				& ifname:txt & vifname:txt & metric:u32 \
				& policytags:list

	add_interface_route6	? protocol:txt				\
				& unicast:bool & multicast:bool		\
				& network:ipv6net & nexthop:ipv6	\
				& ifname:txt & vifname:txt & metric:u32 \
				& policytags:list

	replace_interface_route4 ? protocol:txt				\
				& unicast:bool & multicast:bool		\
				& network:ipv4net & nexthop:ipv4	\
				& ifname:txt & vifname:txt & metric:u32 \
				& policytags:list

	replace_interface_route6 ? protocol:txt				\
				& unicast:bool & multicast:bool		\
				& network:ipv6net & nexthop:ipv6	\
				& ifname:txt & vifname:txt & metric:u32 \
				& policytags:list

	/**
	 * Lookup nexthop.
	 *
	 * @param addr address to lookup.
	 *
	 * @param unicast look in unicast RIB.
	 *
	 * @param multicast look in multicast RIB.
	 *
	 * @param nexthop contains the resolved nexthop if successful,
	 * IPv4::ZERO otherwise.  It is an error for the unicast and multicast
	 * fields to both be true or both false.
	 */
	lookup_route_by_dest4 ? addr:ipv4 & unicast:bool & multicast:bool \
		-> nexthop:ipv4

	/**
	 * Lookup nexthop.
	 *
	 * @param addr address to lookup.
	 *
	 * @param unicast look in unicast RIB.
	 *
	 * @param multicast look in multicast RIB.
	 *
	 * @param nexthop contains the resolved nexthop if successful,
	 * IPv6::ZERO otherwise.  It is an error for the unicast and multicast
	 * fields to both be true or both false.
	 */
	lookup_route_by_dest6 ? addr:ipv6 & unicast:bool & multicast:bool \
		-> nexthop:ipv6

	/**
	 * Add a vif or a vif address to the RIB.
	 * This interface should be used only for testing purpose.
	 *
	 * @param name the name of the vif.
	 */
	new_vif ? name:txt

	/**
	 * Add a vif address to the RIB.
	 * This interface should be used only for testing purpose.
	 *
	 * @param name the name of the vif.
	 * @param addr the address to add.
	 * @param subnet the subnet address to add.
	 */
	add_vif_addr4 ? name:txt & addr:ipv4 & subnet:ipv4net

	add_vif_addr6 ? name:txt & addr:ipv6 & subnet:ipv6net

	/**
	 * Enable route redistribution from one routing protocol to
	 * another.
	 *
	 * @param to_xrl_target the XRL Target instance name of the caller.
	 *	  The caller must implement redist4/0.1.
	 *
	 * @param from_protocol the name of the routing process routes are
	 * to be redistributed from.
	 *
	 * @param unicast enable for unicast RIBs matching from and to.
	 *
	 * @param multicast enable for multicast RIBs matching from and to.
	 *
	 * @param network_prefix redistribite only the routes that fall
	 *        into this prefix address.
	 *
	 * @param cookie a text value passed back to creator in each call
	 *        from the RIB.  This allows creators to identity the source
	 *	  of updates it receives through the redist4/0.1
	 *	  interface.
	 */
	redist_enable4 ? to_xrl_target:txt				\
		       & from_protocol:txt				\
		       & unicast:bool					\
		       & multicast:bool					\
		       & network_prefix:ipv4net				\
		       & cookie:txt

	/**
	 * Enable route redistribution from one routing protocol to
	 * another.
	 *
	 * @param to_xrl_target the XRL Target instance name of the caller.
	 *	  The caller must implement redist6/0.1.
	 *
	 * @param from_protocol the name of the routing process routes are
	 * to be redistributed from.
	 *
	 * @param unicast enable for unicast RIBs matching from and to.
	 *
	 * @param multicast enable for multicast RIBs matching from and to.
	 *
	 * @param network_prefix redistribite only the routes that fall
	 *        into this prefix address.
	 *
	 * @param cookie a text value passed back to creator in each call
	 *        from the RIB.  This allows creators to identity the source
	 *	  of updates it receives through the redist6/0.1
	 *	  interface.
	 */
	redist_enable6 ? to_xrl_target:txt				\
		       & from_protocol:txt				\
		       & unicast:bool					\
		       & multicast:bool					\
		       & network_prefix:ipv6net				\
		       & cookie:txt

	/**
	 * Disable route redistribution from one routing protocol to
	 * another.
	 *
	 * @param to_xrl_target the XRL Target instance name of the caller.