nexthop_group.proto¶
NexthopGroupMgrService¶
watch¶
rpc watch(WatchNexthopGroupRequest) WatchNexthopGroupResponse
Subscription to monitor changes on nexthop groups. This request stays active until the client cancels or the server shuts down. When all = false and no name is specified, this request has no effect.
EosSdk reference: eos::nexthop_group_handler (class)
resync_init¶
rpc resync_init(ResyncNexthopGroupInitRequest) ResyncNexthopGroupInitResponse
Initiates a resync process. Starts a blank configuration to be applied once resync_complete is called.
EosSdk reference: eos::nexthop_group_mgr::resync_init
resync_complete¶
rpc resync_complete(ResyncNexthopGroupCompleteRequest) ResyncNexthopGroupCompleteResponse
Deletes current configuration and applies all changes since resync_init has been called last.
EosSdk reference: eos::nexthop_group_mgr::resync_complete
nexthop_groups¶
rpc nexthop_groups(NexthopGroupsRequest) NexthopGroupsResponse
Returns a list of all configured nexthop groups.
EosSdk reference: eos::nexthop_group_mgr::nexthop_group_iter
programmed_nexthop_groups¶
rpc programmed_nexthop_groups(ProgrammedNexthopGroupsRequest) ProgrammedNexthopGroupsResponse
Returns a list of all programmed nexthop groups.
EosSdk reference: eos::nexthop_group_mgr::programmed_nexthop_group_iter
nexthop_group¶
rpc nexthop_group(NexthopGroupRequest) NexthopGroupResponse
Returns the configured nexthop group specified by name, if exists.
EosSdk reference: eos::nexthop_group_mgr::nexthop_group
counter¶
rpc counter(CounterRequest) CounterResponse
Returns the counter corresponding to the given nexthop group name and entry.
EosSdk reference: eos::nexthop_group_mgr::counter
nhg_counters¶
rpc nhg_counters(NexthopGroupCountersRequest) NexthopGroupCountersResponse
Returns the counter corresponding to the given nexthop group name or a set of nexthop groups that have names matching the regex pattern or all nexthop groups in the system when all=true. When all = false and no name or regex is specified, this request has no effect. When multiple fields are set, the last set field takes precedence.
EosSdk reference: eos::nexthop_group_handler (class)
exists¶
rpc exists(NexthopGroupExistsRequest) NexthopGroupExistsResponse
Queries if the nexthop group with given name exists.
EosSdk reference: eos::nexthop_group_mgr::exists
active¶
rpc active(NexthopGroupActiveRequest) NexthopGroupActiveResponse
Queries whether a nexthop group is active
EosSdk reference: eos::nexthop_group_mgr::active
nexthop_group_set¶
rpc nexthop_group_set(NexthopGroupSetRequest) NexthopGroupSetResponse
Creates or updates a nexthop group and returns its version ID.
EosSdk reference: eos::nexthop_group_mgr::nexthop_group_set
bulk_nexthop_group_set¶
rpc bulk_nexthop_group_set(BulkNexthopGroupSetRequest) BulkNexthopGroupSetResponse
Creates or updates multiple nexthops groups in a single call and returns their version IDs.
EosSdk reference: eos::nexthop_group_mgr::nexthop_group_set
nexthop_group_del¶
rpc nexthop_group_del(NexthopGroupDelRequest) NexthopGroupDelResponse
Deletes a nexthop group.
EosSdk reference: eos::nexthop_group_mgr::nexthop_group_del
bulk_nexthop_group_del¶
rpc bulk_nexthop_group_del(BulkNexthopGroupDelRequest) BulkNexthopGroupDelResponse
Deletes multiple nexthop groups in a single call.
EosSdk reference: eos::nexthop_group_mgr::nexthop_group_del
programmed_nexthop_group¶
rpc programmed_nexthop_group(ProgrammedNexthopGroupRequest) ProgrammedNexthopGroupResponse
Queries a programmed nexthop group by name.
EosSdk reference: eos::nexthop_group_mgr::programmed_nexthop_group
Messages¶
BulkNexthopGroupDelRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated NexthopGroupDelRequest | List of NexthopGroupDelRequest. |
BulkNexthopGroupDelResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of consecutive successful requests. |
| status | RpcResponseStatus | Success or error details in case of failure. |
BulkNexthopGroupSetRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated NexthopGroupSetRequest | List of NexthopGroupSetRequest. |
BulkNexthopGroupSetResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of consecutive successful requests. |
| status | RpcResponseStatus | Success or error details in case of failure. |
| responses | repeated NexthopGroupSetResponse | List of NexthopGroupSetResponse. |
CounterRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | Name of the nexthop group to search. |
| entry | uint32 | Entry number (16-bit). |
CounterResponse¶
| Name | Value | Description |
|---|---|---|
| counter | NexthopGroupCounter | Counter data (empty if not found). |
NexthopGroupActiveRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | Name of the nexthop group. |
NexthopGroupActiveResponse¶
| Name | Value | Description |
|---|---|---|
| active | bool | True if the specified group is active. |
NexthopGroupCountersRequest¶
| Name | Value | Description |
|---|---|---|
| oneof overloads.all | bool | All nexthop groups. |
| oneof overloads.name | string | Name of a particular nexthop group to get the counters for. |
| oneof overloads.regex | string | ECMAScript regex to be pattern matched against all nexthop group names. |
NexthopGroupCountersResponse¶
| Name | Value | Description |
|---|---|---|
| name | string | Name of the nexthop_group. |
| counters | repeated NexthopGroupCounter | List of all nexthop groups' entry counters when all = true or when the name is given in a request that nexthop group's entries counters will be returned. |
NexthopGroupDelRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | Name of the nexthop group to delete. |
NexthopGroupDelResponse¶
Empty message.
NexthopGroupExistsRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | Name of the nexthop_group. |
NexthopGroupExistsResponse¶
| Name | Value | Description |
|---|---|---|
| exists | bool | True if the nexthop group exists. |
NexthopGroupFieldsControl¶
| Name | Value | Description |
|---|---|---|
| fields | repeated NexthopGroupWatchedField |
NexthopGroupRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | Name of the nexthop group to search. |
NexthopGroupResponse¶
| Name | Value | Description |
|---|---|---|
| nhg | NexthopGroup | Configured nexthop group (empty if not found). |
NexthopGroupSetRequest¶
| Name | Value | Description |
|---|---|---|
| nhg | NexthopGroup | Details of the new group. |
| oneof _client_version_id.client_version_id | optional uint32 | Must be in range 1 to 65535 |
NexthopGroupSetResponse¶
| Name | Value | Description |
|---|---|---|
| version_id | uint32 | The nexthop group's version ID. |
NexthopGroupsRequest¶
Empty message.
NexthopGroupsResponse¶
| Name | Value | Description |
|---|---|---|
| nhg | NexthopGroup | Configured nexthop group. |
ProgrammedNexthopGroupRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | Name of the programmed nexthop group. |
ProgrammedNexthopGroupResponse¶
| Name | Value | Description |
|---|---|---|
| nhg | NexthopGroup | Details of the nexthop group (empty if not found). |
ProgrammedNexthopGroupsRequest¶
Empty message.
ProgrammedNexthopGroupsResponse¶
| Name | Value | Description |
|---|---|---|
| name | string | Programmed nexthop group. |
ResyncNexthopGroupCompleteRequest¶
Empty message.
ResyncNexthopGroupCompleteResponse¶
Empty message.
ResyncNexthopGroupInitRequest¶
Empty message.
ResyncNexthopGroupInitResponse¶
Empty message.
WatchNexthopGroupRequest¶
| Name | Value | Description |
|---|---|---|
| oneof overloads.all | bool | |
| oneof overloads.name | string | Name of a particular nexthop group to watch. |
| ack | bool | Set to true when an ackowledgment is desired. |
| dump_fields | NexthopGroupFieldsControl |
WatchNexthopGroupResponse¶
Events are streamed as changes happen.
| Name | Value | Description |
|---|---|---|
| name | string | Interface whose status changed (ignored on confirmation). |
| oneof active_status_present.active_status | bool | There was a change in the active status. |
| oneof nhg_programmed_present.nhg_programmed | bool | NHG has been programmed. |
| version_id | uint32 | The nexthop group's version ID if it has been programmed. Only present when event is for a programmed callback. |
| ack | bool | If true, this is not an event and the fields below are invalid. |
| nhg | NexthopGroup | |
| on_nhg_programmed | OnNexthopGroupProgrammed |
Enums¶
NexthopGroupWatchedField¶
| Name | Value | Description |
|---|---|---|
| NEXTHOP_GROUP_ALL | 0 | 'NEXTHOP_GROUP_ALL' represents including all the fields in 'WatchNexthopGroupResponse' |
| NEXTHOP_GROUP_ACTIVE | 1 | |
| NEXTHOP_GROUP_PROGRAMMED | 2 | |
| NEXTHOP_GROUP_VERSION_ID | 3 | |
| NEXTHOP_GROUP_NHG | 4 | |
| NEXTHOP_GROUP_ON_NHG_PROGRAMMED | 5 |