bgp_path.proto¶
BgpPathMgrService¶
watch¶
rpc watch(BgpPathWatchRequest) BgpPathWatchResponse
Subscription to monitor changes to bgp paths. This request stays active until the client cancels or the server shuts down. When all = false and no version is specified, this request has no effect.
EosSdk reference: eos::bgp_path_handler (class)
ipv4_unicast_paths¶
rpc ipv4_unicast_paths(Ipv4UnicastPathsRequest) Ipv4UnicastPathsResponse
Iterates through all IPv4 paths in adj-RIB-in that match the search criteria.
EosSdk reference: eos::bgp_path_mgr::ipv4_unicast_path_iter
ipv4_unicast_path¶
rpc ipv4_unicast_path(Ipv4UnicastPathRequest) Ipv4UnicastPathResponse
Queries a single path, given its key and search criteria.
EosSdk reference: eos::bgp_path_mgr::ipv4_unicast_path
ipv4_unicast_bgp_convergence¶
rpc ipv4_unicast_bgp_convergence(Ipv4UnicastBgpConvergenceRequest) Ipv4UnicastBgpConvergenceResponse
Queries if IPv4 family has converged.
EosSdk reference: eos::bgp_path_mgr::ipv4_unicast_bgp_convergence
ipv6_unicast_paths¶
rpc ipv6_unicast_paths(Ipv6UnicastPathsRequest) Ipv6UnicastPathsResponse
Iterates through adj-RIB-in for paths that match the criteria.
EosSdk reference: eos::bgp_path_mgr::ipv6_unicast_path_iter
ipv6_unicast_path¶
rpc ipv6_unicast_path(Ipv6UnicastPathRequest) Ipv6UnicastPathResponse
Queries a single path, given its key and search criteria.
EosSdk reference: eos::bgp_path_mgr::ipv6_unicast_path
ipv6_unicast_bgp_convergence¶
rpc ipv6_unicast_bgp_convergence(Ipv6UnicastBgpConvergenceRequest) Ipv6UnicastBgpConvergenceResponse
Queries if IPv6 family has converged.
EosSdk reference: eos::bgp_path_mgr::ipv6_unicast_bgp_convergence
Messages¶
BgpPathWatchRequest¶
| Name | Value | Description |
|---|---|---|
| oneof overloads.all_paths | bool | |
| oneof overloads.ipv4_unicast_paths | bool | True if IPv4 unicast paths should be monitored. |
| oneof overloads.ipv6_unicast_paths | bool | True if IPv6 unicast paths should be monitored. |
| ack | bool | Set to true when an ackowledgment is desired. |
BgpPathWatchResponse¶
Events are streamed as changes happen.
| Name | Value | Description |
|---|---|---|
| ip_version | IpVersion | IP family affected by the event. |
| oneof events.path_key | BgpPathKey | Path changed in adj-RIB-in. |
| oneof events.converged | bool | BGP convergence changed for that IP family. |
| ack | bool | If true, this is not an event and the fields below are invalid. |
Ipv4UnicastBgpConvergenceRequest¶
Empty message.
Ipv4UnicastBgpConvergenceResponse¶
| Name | Value | Description |
|---|---|---|
| converged | bool | True if IPv4 family has converged. |
Ipv4UnicastPathRequest¶
| Name | Value | Description |
|---|---|---|
| path_key | BgpPathKey | |
| path_options | BgpPathOptions |
Ipv4UnicastPathResponse¶
| Name | Value | Description |
|---|---|---|
| path | BgpPath | Path matching criteria or empty if not found. |
Ipv4UnicastPathsRequest¶
| Name | Value | Description |
|---|---|---|
| path_options | BgpPathOptions |
Ipv4UnicastPathsResponse¶
| Name | Value | Description |
|---|---|---|
| path | BgpPath | List of paths that match the criteria. |
Ipv6UnicastBgpConvergenceRequest¶
Empty message.
Ipv6UnicastBgpConvergenceResponse¶
| Name | Value | Description |
|---|---|---|
| converged | bool | True if IPv6 family has converged. |
Ipv6UnicastPathRequest¶
| Name | Value | Description |
|---|---|---|
| path_key | BgpPathKey | |
| path_options | BgpPathOptions |
Ipv6UnicastPathResponse¶
| Name | Value | Description |
|---|---|---|
| path | BgpPath | Path matching criteria or empty if not found. |
Ipv6UnicastPathsRequest¶
| Name | Value | Description |
|---|---|---|
| path_options | BgpPathOptions |
Ipv6UnicastPathsResponse¶
| Name | Value | Description |
|---|---|---|
| path | BgpPath | A path that matches the criteria. |