ip_route.proto¶
IpRouteMgrService¶
tag¶
rpc tag(TagRequest) TagResponse
Queries for the current tag assigned to the ip route manager.
EosSdk reference: eos::ip_route_mgr::tag
tag_is¶
rpc tag_is(TagIsRequest) TagIsResponse
Sets the current tag for the ip route manager. This service will only interact with routes with the given tag.
EosSdk reference: eos::ip_route_mgr::tag_is
resync_init¶
rpc resync_init(IpRouteResyncInitRequest) IpRouteResyncInitResponse
Starts the route resync process, to set the routes to a known state. The resync_complete rpc, must be called to end the resync. Please check the EosSdk reference for further details.
EosSdk reference: eos::ip_route_mgr::resync_init
resync_complete¶
rpc resync_complete(IpRouteResyncCompleteRequest) IpRouteResyncCompleteResponse
Ends the current route resync process. All routes and vias not added or modified during the resync will be deleted.
EosSdk reference: eos::ip_route_mgr::resync_complete
ip_routes¶
rpc ip_routes(IpRoutesRequest) IpRoutesResponse
Enumerates all configured static routes.
EosSdk reference: eos::ip_route_mgr::ip_route_iter
ip_route_vias¶
rpc ip_route_vias(IpRouteViasRequest) IpRouteViasResponse
Enumerates all configured vias for a given route.
EosSdk reference: eos::ip_route_mgr::ip_route_via_iter
ip_route_exists¶
rpc ip_route_exists(IpRouteExistsRequest) IpRouteExistsResponse
Queries whether the given route is configured or not.
EosSdk reference: eos::ip_route_mgr::exists
ip_route_via_exists¶
rpc ip_route_via_exists(IpRouteViaExistsRequest) IpRouteViaExistsResponse
Queries whether the given via exists for the given route.
EosSdk reference: eos::ip_route_mgr::exists
ip_route¶
rpc ip_route(IpRouteRequest) IpRouteResponse
Queries the route for the given route key.
EosSdk reference: eos::ip_route_mgr::ip_route
ip_route_set¶
rpc ip_route_set(IpRouteSetRequest) IpRouteSetResponse
Sets a static route.
EosSdk reference: eos::ip_route_mgr::ip_route_set
bulk_ip_route_set¶
rpc bulk_ip_route_set(BulkIpRouteSetRequest) BulkIpRouteSetResponse
Sets multiple routes at once for each given route key.
EosSdk reference: eos::ip_route_mgr::ip_route_set
ip_route_del¶
rpc ip_route_del(IpRouteDelRequest) IpRouteDelResponse
Deletes a static route.
EosSdk reference: eos::ip_route_mgr::ip_route_del
bulk_ip_route_del¶
rpc bulk_ip_route_del(BulkIpRouteDelRequest) BulkIpRouteDelResponse
Deletes multiple static routes at once for each given route key.
EosSdk reference: eos::ip_route_mgr::ip_route_del
ip_route_via_set¶
rpc ip_route_via_set(IpRouteViaSetRequest) IpRouteViaSetResponse
Sets the via for a given route key. See EosSdk reference for more information.
EosSdk reference: eos::ip_route_mgr::ip_route_via_set
bulk_ip_route_via_set¶
rpc bulk_ip_route_via_set(BulkIpRouteViaSetRequest) BulkIpRouteViaSetResponse
Sets multiple vias at once for each given route key.
EosSdk reference: eos::ip_route_mgr::ip_route_via_set
ip_route_via_del¶
rpc ip_route_via_del(IpRouteViaDelRequest) IpRouteViaDelResponse
Deletes the via for a given route key.
EosSdk reference: eos::ip_route_mgr::ip_route_via_delete
bulk_ip_route_via_del¶
rpc bulk_ip_route_via_del(BulkIpRouteViaDelRequest) BulkIpRouteViaDelResponse
Deletes multiple vias at once for each given route key.
EosSdk reference: eos::ip_route_mgr::ip_route_via_delete
Messages¶
BulkIpRouteDelRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated IpRouteDelRequest | Array of IpRouteDelRequest. |
BulkIpRouteDelResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of successfully deleted routes. |
| status | RpcResponseStatus | Success or error details in case of failure. |
BulkIpRouteSetRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated IpRouteSetRequest | Array of IpRouteSetRequest. |
BulkIpRouteSetResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of successfully set routes. |
| status | RpcResponseStatus | Success or error details in case of failure. |
BulkIpRouteViaDelRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated IpRouteViaDelRequest | Array of IpRouteViaDelRequest. |
BulkIpRouteViaDelResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of successfully deleted vias. |
| status | RpcResponseStatus | Success or error details in case of failure. |
BulkIpRouteViaSetRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated IpRouteViaSetRequest | Array of IpRouteViaSetRequest. |
BulkIpRouteViaSetResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of successfully set vias. |
| status | RpcResponseStatus | Success or error details in case of failure. |
IpRouteDelRequest¶
| Name | Value | Description |
|---|---|---|
| key | IpRouteKey | The route to delete. |
| vrf_name | string | Optional: the VRF where the route is present. |
IpRouteDelResponse¶
Empty message.
IpRouteExistsRequest¶
| Name | Value | Description |
|---|---|---|
| key | IpRouteKey | The route to query. |
| vrf_name | string | Optional: the VRF where the route is present. |
IpRouteExistsResponse¶
| Name | Value | Description |
|---|---|---|
| exists | bool | True if the route exists, otherwise False. |
IpRouteRequest¶
| Name | Value | Description |
|---|---|---|
| key | IpRouteKey | The route to query. |
| vrf_name | string | Optional: the VRF where the route is present. |
IpRouteResponse¶
| Name | Value | Description |
|---|---|---|
| response | IpRoute | If a match is found. |
IpRouteResyncCompleteRequest¶
Empty message.
IpRouteResyncCompleteResponse¶
Empty message.
IpRouteResyncInitRequest¶
Empty message.
IpRouteResyncInitResponse¶
Empty message.
IpRouteSetRequest¶
| Name | Value | Description |
|---|---|---|
| route | IpRoute | The route to set. |
| oneof additional_arg.action | IpRouteActions | The type of vias to be attached. Used for more efficient route configuration. |
| oneof additional_arg.vrf_name | string | The VRF where the route will be present. |
| vias | repeated IpRouteVia | Optional: number of IpRouteVia messages to be created along with the route. If any of the vias fail, the route will be deleted at once and the error returned will be the reason for the via creation failure. |
| vias_action | IpRouteSetViasAction | defines how vias should be replaced, when applicable. |
IpRouteSetResponse¶
Empty message.
IpRouteViaDelRequest¶
| Name | Value | Description |
|---|---|---|
| via | IpRouteVia | The via to delete, including the route key. |
| vrf_name | string | Optional: the VRF where the via is present. |
IpRouteViaDelResponse¶
Empty message.
IpRouteViaExistsRequest¶
| Name | Value | Description |
|---|---|---|
| via | IpRouteVia | The via to query, including the route key. |
| vrf_name | string | Optional: the VRF where the via is present. |
IpRouteViaExistsResponse¶
| Name | Value | Description |
|---|---|---|
| exists | bool | True if the via exists, otherwise False. |
IpRouteViaSetRequest¶
| Name | Value | Description |
|---|---|---|
| via | IpRouteVia | The via to set, including the route key. |
| vrf_name | string | Optional: the VRF where the via should be present. |
IpRouteViaSetResponse¶
Empty message.
IpRouteViasRequest¶
| Name | Value | Description |
|---|---|---|
| key | IpRouteKey | The route to query vias for. |
| vrf_name | string | Optonal: the VRF where the route is present. |
IpRouteViasResponse¶
| Name | Value | Description |
|---|---|---|
| response | IpRouteVia | The configured via for the given route. |
IpRoutesRequest¶
Setting more than one field below will apply AND logic. With an exception for vrf_name, leaving filters unset disables them. In case of vrf_name, if unset, it reverts to the default VRF, in accordance with all SDK APIs. A special value "all" has been introduced to allow this function to return routes from all VRFs, in the same fashion as CLI commands.
In the presence of multiple vias, a route is selected if any of the underlying vias matches the criteria.
| Name | Value | Description |
|---|---|---|
| vrf_name | string | Filters response by VRF Name. |
| vtep_addr | bytes | Filters response by vtep address. |
| vni | uint32 | Filters responses by VNI. |
| vxlan_intf_id | IntfId | Filters responses by VXLAN Interface. |
| report_vias | bool | If true, the stream response will also include vias for every reported path. |
| suppress_routes | bool | If true, the stream response will contain only vias if report_vias is true, and be empty otherwise. |
| packed_route_vias | bool | If true, each route and all its vias will be streamed in a single message. When this flag is set to true, 'report_vias' and 'suppress_routes' are ignored. |
IpRoutesResponse¶
| Name | Value | Description |
|---|---|---|
| oneof item.response | IpRoute | The configured static route. |
| oneof item.via | IpRouteVia | VIA of a configured static route. |
| vias | repeated IpRouteVia |
TagIsRequest¶
| Name | Value | Description |
|---|---|---|
| tag | uint32 | The numeric value of the tag |
TagIsResponse¶
Empty message.
TagRequest¶
Empty message.
TagResponse¶
| Name | Value | Description |
|---|---|---|
| tag | uint32 | The numeric value of the current tag |
Enums¶
IpRouteSetViasAction¶
| Name | Value | Description |
|---|---|---|
| IP_ROUTE_SET_VIAS_CREATE | 0 | Convenience method to create routes and vias in a single RPC call. This is intended for route creation but when used with an existing route key will cause it to erase all previous vias associated with that key (at the SDK level). In case of failure to add vias, the route shall be deleted. |
| IP_ROUTE_SET_VIAS_REPLACE | 1 | Choosing this action with an existing route will replace vias in a make-before-break fashion within the RPC server, when possible. Vias that are common between the old set and the new set should remain untouched. If the operation fails, then the original via set is restored. |