rib.xrls

xorp源码hg

/**
 *  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.
 */
finder://rib/rib/0.1/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. The caller
 *  must implement redist4/0.1 and previously called redist_enable4.
 *
 *  @param unicast disable for unicast RIBs matching from and to.
 *
 *  @param multicast disable for multicast RIBs matching from and to.
 *
 *  @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.
 */
finder://rib/rib/0.1/redist_disable4?to_xrl_target:txt&from_protocol:txt&unicast:bool&multicast:bool&cookie:txt

/**
 *  Disable 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 and previously called redist_enable6.
 *
 *  @param unicast disable for unicast RIBs matching from and to.
 *
 *  @param multicast disable for multicast RIBs matching from and to.
 *
 *  @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.
 */
finder://rib/rib/0.1/redist_disable6?to_xrl_target:txt&from_protocol:txt&unicast:bool&multicast:bool&cookie:txt

/**
 *  Enable transaction-based route redistribution from one routing protocol to
 *  another.
 *
 *  @param to_xrl_target the XRL Target instance name of the caller. The caller
 *  must implement redist_transaction4/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 redist_transaction4/0.1 interface.
 */
finder://rib/rib/0.1/redist_transaction_enable4?to_xrl_target:txt&from_protocol:txt&unicast:bool&multicast:bool&network_prefix:ipv4net&cookie:txt

/**
 *  Enable transaction-based route redistribution from one routing protocol to
 *  another.
 *
 *  @param to_xrl_target the XRL Target instance name of the caller. The caller
 *  must implement redist_transaction6/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 redist_transaction6/0.1 interface.
 */
finder://rib/rib/0.1/redist_transaction_enable6?to_xrl_target:txt&from_protocol:txt&unicast:bool&multicast:bool&network_prefix:ipv6net&cookie:txt

/**
 *  Disable transaction-based route redistribution from one routing protocol to
 *  another.
 *
 *  @param to_xrl_target the XRL Target instance name of the caller. The caller
 *  must implement redist_transaction4/0.1 and previously called
 *  redist_transaction_enable4.
 *
 *  @param unicast disable for unicast RIBs matching from and to.
 *
 *  @param multicast disable for multicast RIBs matching from and to.
 *
 *  @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 redist_transaction4/0.1 interface.
 */
finder://rib/rib/0.1/redist_transaction_disable4?to_xrl_target:txt&from_protocol:txt&unicast:bool&multicast:bool&cookie:txt

/**
 *  Disable transaction-based route redistribution from one routing protocol to
 *  another.
 *
 *  @param to_xrl_target the XRL Target instance name of the caller. The caller
 *  must implement redist_transaction6/0.1 and previously called
 *  redist_transaction_enable6.
 *
 *  @param unicast disable for unicast RIBs matching from and to.
 *
 *  @param multicast disable for multicast RIBs matching from and to.
 *
 *  @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 redist_transaction6/0.1 interface.
 */
finder://rib/rib/0.1/redist_transaction_disable6?to_xrl_target:txt&from_protocol:txt&unicast:bool&multicast:bool&cookie:txt

/**
 *  Register an interest in a route.
 *
 *  @param target the name of the XRL module to notify when the information
 *  returned by this call becomes invalid.
 *
 *  @param addr address of interest.
 *
 *  @param resolves returns whether or not the address resolves to a route that
 *  can be used for forwarding.
 *
 *  @param base_addr returns the address of interest (actually the base address
 *  of the subnet covered by addr/prefix_len).
 *
 *  @param prefix_len returns the prefix length that the registration covers.
 *  This response applies to all addresses in addr/prefix_len.
 *
 *  @param real_prefix_len returns the actual prefix length of the route that
 *  will be used to route addr. If real_prefix_len is not the same as
 *  prefix_len, this is because there are some more specific routes that
 *  overlap addr/real_prefix_len. real_prefix_len is primarily given for
 *  debugging reasons.
 *
 *  @param nexthop returns the address of the next hop for packets sent to
 *  addr.
 *
 *  @param metric returns the IGP metric for this route.
 */
finder://rib/rib/0.1/register_interest4?target:txt&addr:ipv4->resolves:bool&base_addr:ipv4&prefix_len:u32&real_prefix_len:u32&nexthop:ipv4&metric:u32

/**
 *  De-register an interest in a route.
 *
 *  @param target the name of the XRL module that registered the interest.
 *
 *  @param addr the address of the previous registered interest. addr should be
 *  the base address of the add/prefix_len subnet.
 *
 *  @param prefix_len the prefix length of the registered interest, as given in
 *  the response from register_interest.
 */
finder://rib/rib/0.1/deregister_interest4?target:txt&addr:ipv4&prefix_len:u32

/**
 *  Register an interest in a route.
 *
 *  @param target the name of the XRL module to notify when the information
 *  returned by this call becomes invalid.
 *
 *  @param addr address of interest.
 *
 *  @param resolves returns whether or not the address resolves to a route that
 *  can be used for forwarding.
 *
 *  @param base_addr returns the address of interest (actually the base address
 *  of the subnet covered by addr/prefix_len).
 *
 *  @param prefix_len returns the prefix length that the registration covers.
 *  This response applies to all addresses in addr/prefix_len.
 *
 *  @param real_prefix_len returns the actual prefix length of the route that
 *  will be used to route addr. If real_prefix_len is not the same as
 *  prefix_len, this is because there are some more specific routes that
 *  overlap addr/real_prefix_len. real_prefix_len is primarily given for
 *  debugging reasons.
 *
 *  @param nexthop returns the address of the next hop for packets sent to
 *  addr.
 *
 *  @param metric returns the IGP metric for this route.
 */
finder://rib/rib/0.1/register_interest6?target:txt&addr:ipv6->resolves:bool&base_addr:ipv6&prefix_len:u32&real_prefix_len:u32&nexthop:ipv6&metric:u32

/**
 *  De-register an interest in a route.
 *
 *  @param target the name of the XRL module that registered the interest.
 *
 *  @param addr the address of the previous registered interest. addr should be
 *  the base address of the add/prefix_len subnet.
 *
 *  @param prefix_len the prefix length of the registered interest, as given in
 *  the response from register_interest.
 */
finder://rib/rib/0.1/deregister_interest6?target:txt&addr:ipv6&prefix_len:u32

/**
 *  Add policy tags for a specific protcol in the redistribution map.
 *
 *  @param protocol The destination protocol of the redistribution.
 *
 *  @param policytags The set of policytags of interest for the protocol.
 */
finder://rib/rib/0.1/insert_policy_redist_tags?protocol:txt&policytags:list

/**
 *  Reset the policy redistribution map. No policy based route redistribution
 *  will be available at this point.
 */
finder://rib/rib/0.1/reset_policy_redist_tags

/**
 *  Enable profiling
 *
 *  @param pname profile variable
 */
finder://rib/profile/0.1/enable?pname:txt

/**
 *  Disable profiling
 *
 *  @param pname profile variable
 */
finder://rib/profile/0.1/disable?pname:txt

/**
 *  Get log entries.
 *
 *  @param pname profile variable
 *
 *  @param instance_name to send the profiling info to.
 */
finder://rib/profile/0.1/get_entries?pname:txt&instance_name:txt

/**
 *  Clear the profiling entries
 *
 *  @param pname profile variable
 */
finder://rib/profile/0.1/clear?pname:txt

/**
 *  List all the profiling variables registered with this target.
 */
finder://rib/profile/0.1/list->info:txt