intf.proto¶
IntfCounterMgrService¶
intf_counters¶
rpc intf_counters(IntfCountersRequest) IntfCountersResponse
Queries the given interface for the current counters.
EosSdk reference: eos::intf_counter_mgr::counters
intf_traffic_rates¶
rpc intf_traffic_rates(IntfTrafficRatesRequest) IntfTrafficRatesResponse
Queries the given interface for the current traffic rates.
EosSdk reference: eos::intf_counter_mgr::traffic_rates
intf_traffic_rates_stream¶
rpc intf_traffic_rates_stream(IntfTrafficRatesStreamRequest) IntfTrafficRatesStreamResponse
Streams traffic rate updates
IntfMgrService¶
watch¶
rpc watch(WatchIntfRequest) WatchIntfResponse
Subscription to monitor changes on interface properties or status. This request stays active until it is cancelled from client side or the server is shut down. Making this request with all = false and no intf_id has no effect.
EosSdk reference: eos::intf_handler (class)
intfs¶
rpc intfs(IntfsRequest) IntfsResponse
Enumerates the interfaces.
EosSdk reference: eos::intf_mgr::intf_iter
exists¶
rpc exists(IntfExistsRequest) IntfExistsResponse
Queries whether an interface exists or not.
EosSdk reference: eos::intf_mgr::exists
kernel_intf_name¶
rpc kernel_intf_name(KernelIntfNameRequest) KernelIntfNameResponse
Queries the kernel device for a particular interface.
EosSdk reference: eos::intf_mgr::kernel_intf_name
eos_intf_name¶
rpc eos_intf_name(EosIntfNameRequest) EosIntfNameResponse
Queries EOS interface name for a particular kernel device.
EosSdk reference: eos::intf_mgr::eos_intf_name
admin_enabled¶
rpc admin_enabled(AdminEnabledRequest) AdminEnabledResponse
Queries if an interface is configured to be enabled.
EosSdk reference: eos::intf_mgr::admin_enabled
admin_enabled_is¶
rpc admin_enabled_is(AdminEnabledIsRequest) AdminEnabledIsResponse
Changes the enabled status of an interface.
EosSdk reference: eos::intf_mgr::admin_enabled_is
bulk_admin_enabled_is¶
rpc bulk_admin_enabled_is(BulkAdminEnabledIsRequest) BulkAdminEnabledIsResponse
Changes the enabled status of multiple interfaces.
EosSdk reference: eos::intf_mgr::admin_enabled_is
description¶
rpc description(DescriptionRequest) DescriptionResponse
Queries the description of an interface
EosSdk reference: eos::intf_mgr::description
description_is¶
rpc description_is(DescriptionIsRequest) DescriptionIsResponse
Changes the description of an interface
EosSdk reference: eos::intf_mgr::description_is
bulk_description_is¶
rpc bulk_description_is(BulkDescriptionIsRequest) BulkDescriptionIsResponse
Changes descriptions of multiple interfaces
EosSdk reference: eos::intf_mgr::oper_description_is
oper_status¶
rpc oper_status(OperStatusRequest) OperStatusResponse
Queries the current operational status of the given interface.
EosSdk reference: eos::intf_mgr::oper_status
Messages¶
AdminEnabledIsRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
| enabled | bool | New enabled status for the interface. |
AdminEnabledIsResponse¶
Empty message.
AdminEnabledRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Linux kernel device name for the interface. |
AdminEnabledResponse¶
| Name | Value | Description |
|---|---|---|
| enabled | bool | True if interface is enabled, false otherwise. |
BulkAdminEnabledIsRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated AdminEnabledIsRequest | Array of AdminEnabledIsRequest. |
BulkAdminEnabledIsResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of successful requests. |
| status | RpcResponseStatus | Error details in case of failure. |
BulkDescriptionIsRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated DescriptionIsRequest | Array of DescriptionIsRequest. |
BulkDescriptionIsResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of successful requests. |
| status | RpcResponseStatus | Error details in case of failure. |
DescriptionIsRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
| description | string | New description for the interface. |
DescriptionIsResponse¶
Empty message.
DescriptionRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
DescriptionResponse¶
| Name | Value | Description |
|---|---|---|
| description | string | Description currently set for the interface. |
EosIntfNameRequest¶
| Name | Value | Description |
|---|---|---|
| name | string | Linux kernel device name for the interface. |
EosIntfNameResponse¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
IntfCountersRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
IntfCountersResponse¶
| Name | Value | Description |
|---|---|---|
| counters | IntfCounters | The counters associated with the interface. |
IntfExistsRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
IntfExistsResponse¶
| Name | Value | Description |
|---|---|---|
| exists | bool | True if the interface is present, false otherwise. |
IntfFieldsControl¶
| Name | Value | Description |
|---|---|---|
| fields | repeated IntfWatchedField |
IntfTrafficRatesRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
IntfTrafficRatesResponse¶
| Name | Value | Description |
|---|---|---|
| rates | IntfTrafficRates | The traffic rates associated with the interface. |
IntfTrafficRatesStreamRequest¶
| Name | Value | Description |
|---|---|---|
| ack | bool | Set to true when an ackowledgment is desired. |
| intf_name_regex | string | Regular expression to report only interfaces with matching names. When empty, all interfaces are sent. |
IntfTrafficRatesStreamResponse¶
| Name | Value | Description |
|---|---|---|
| ack | bool | If true the agent is now actively watching for events. |
| data | map IntfTrafficRatesStreamResponse.DataEntry | Traffic rates data |
IntfTrafficRatesStreamResponse.DataEntry¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Interface name |
| rates | IntfTrafficRates | The traffic rates associated with the interface. |
IntfsRequest¶
Empty message.
IntfsResponse¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
KernelIntfNameRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
KernelIntfNameResponse¶
| Name | Value | Description |
|---|---|---|
| name | string | Linux kernel device name for the interface. |
OperStatusRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
OperStatusResponse¶
| Name | Value | Description |
|---|---|---|
| status | OperStatuses | Operational status of the interface. |
WatchIntfRequest¶
| Name | Value | Description |
|---|---|---|
| oneof overloads.all_intfs | bool | |
| oneof overloads.intf_id | IntfId | Name of a particular interface to watch. |
| ack | bool | Set to true when an ackowledgment is desired. |
| dump_fields | IntfFieldsControl | Controls whether a dump of the existing state is performed and what data it contains. This dump takes place when the watcher starts up. At least one IntfWatchedField must be specified in order to perform a dump. |
WatchIntfResponse¶
Events are streamed as changes happen.
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Interface whose status changed. |
| oneof event_present.event | IntfEvents | Interface has been added or removed. |
| oneof oper_status_present.status | OperStatuses | |
| oneof admin_enabled_present.admin_enabled | bool | Enabled status has been changed. |
| oneof description_present.description | string | Interface's description has changed. |
| ack | bool | If true, this is not an event and the fields below are invalid. It will be sent immediately if a dump is not being performed and an acknowledgement was requested. If a dump is taking place it will instead be sent at the end of the dump regardless of whether an acknowledgement was requested or not. |
Enums¶
IntfEvents¶
| Name | Value | Description |
|---|---|---|
| EVENT_INTF_NO_CHANGES | 0 | |
| EVENT_INTF_CREATED | 1 | |
| EVENT_INTF_DELETED | 2 |
IntfWatchedField¶
| Name | Value | Description |
|---|---|---|
| INTF_ALL_FIELDS | 0 | |
| INTF_OPER_STATUS | 1 | |
| INTF_ADMIN_ENABLED | 2 | |
| INTF_DESCRIPTION | 3 |