get_route_list(self,
scope,
filter,
range)
|
|
Gets the RIB routes from the network element for the specified scope,
filter and range. This method will make remote procedure call and
response time may be long.
Only routes which satisfy the filter and range are retrieved. This
method may not return all the number of routes as specified in the range
count per invocation. The platform controls the maximum number of routes
returned per invocation. To retrieve all the routes matching the
criteria, the application may have to call the method multiple times,
adjusting the start prefix and the type in the range argument
accordingly, until a list of size 0 is returned.
Also, to prevent connection timeout when getting a long list of
routes, application should increase the timeout by calling the following
method before connecting to a network element
#NetworkApplicaiton.set_default_socket_timeout(300)
- Parameters:
scope (L3unicastScope ) - Indicates which table in the RIB to retrieve route from.
filter (L3UnicastRIBFilter) - Specifies characteristic of a route must match for it to be
retrieved. Use default filter (instantiated with default
constructor) if no filtering is needed.the same as if a filter
with all default values passed in.
range (L3UnicastRouteRange) - Specifies range of route to be retrieved. Use default range
(instantiated with default constructor) if no range matching is
needed.
|