ip_intf.proto¶
IpIntfMgrService¶
watch¶
rpc watch(IpIntfWatchRequest) IpIntfEvent
Subscription to monitor changes on the IP addresses of interfaces. This request stays active until it is cancelled from client side or the server is shut down.
EosSdk reference: eos::ip_intf_handler (class)
exists¶
rpc exists(IpIntfExistsRequest) IpIntfExistsResponse
Queries whether the given interface exists and is able to have IP addresses.
EosSdk reference: eos::ip_intf_mgr::exists
ip_addrs¶
rpc ip_addrs(IpIntfAddrsRequest) IpIntfAddrsResponse
Queries all IP addresses associated with an interface.
EosSdk reference: eos::ip_intf_mgr::ip_addrs
ip_addrs_is¶
rpc ip_addrs_is(IpIntfAddrsIsRequest) IpIntfAddrsIsResponse
Sets IP addresses for an interface.
EosSdk reference: eos::ip_intf_mgr::ip_addrs_is
bulk_ip_addrs_is¶
rpc bulk_ip_addrs_is(BulkIpIntfAddrsIsRequest) BulkIpIntfAddrsIsResponse
Sets IP addresses for multiple interfaces.
EosSdk reference: eos::ip_intf_mgr::ip_addrs_is
ip_addr_modify¶
rpc ip_addr_modify(IpIntfAddrModifyRequest) IpIntfAddrModifyResponse
Adds or deletes one address to an interface.
EosSdk references: eos::ip_intf_mgr::ip_addr_add and eos::ip_intf_mgr::ip_addr_del
bulk_ip_addr_modify¶
rpc bulk_ip_addr_modify(BulkIpIntfAddrModifyRequest) BulkIpIntfAddrModifyResponse
Applies multiple IP address changes in a single call.
EosSdk references: eos::ip_intf_mgr::ip_addr_add and eos::ip_intf_mgr::ip_addr_del
ip_addr_merge_mode¶
rpc ip_addr_merge_mode(IpIntfAddrMergeModeRequest) IpIntfAddrMergeModeResponse
Queries the IP address merge mode for an interface.
EosSdk references: eos::ip_intf_mgr::ip_addr_merge_mode and eos::ip_intf_mgr::ip_addr_merge_mode_is
ip_addr_merge_mode_is¶
rpc ip_addr_merge_mode_is(IpIntfAddrMergeModeIsRequest) IpIntfAddrMergeModeIsResponse
Updates the IP address merge mode for an interface.
EosSdk reference: eos::ip_intf_mgr::ip_addr_merge_mode_is
bulk_ip_addr_merge_mode_is¶
rpc bulk_ip_addr_merge_mode_is(BulkIpIntfAddrMergeModeIsRequest) BulkIpIntfAddrMergeModeIsResponse
Updates the IP address merge mode for multiple interfaces.
EosSdk reference: eos::ip_intf_mgr::ip_addr_merge_mode_is
internal_vlan_id¶
rpc internal_vlan_id(IpIntfInternalVlanIdRequest) IpIntfInternalVlanIdResponse
Queries the internal VLAN ID associated with an interface
EosSdk reference: eos::ip_intf_mgr::internal_vlan_id
Messages¶
BulkIpIntfAddrMergeModeIsRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated IpIntfAddrMergeModeIsRequest | List of IpIntfAddrMergeModeRequest. |
BulkIpIntfAddrMergeModeIsResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of requests processed. |
| status | RpcResponseStatus | Success or error details in case of failure. |
BulkIpIntfAddrModifyRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated IpIntfAddrModifyRequest | List of IpIntfAddrModifyRequest. |
BulkIpIntfAddrModifyResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of requests processed. |
| status | RpcResponseStatus | Success or error details in case of failure. |
BulkIpIntfAddrsIsRequest¶
| Name | Value | Description |
|---|---|---|
| requests | repeated IpIntfAddrsIsRequest | List of IpIntfAddrsRequest. |
BulkIpIntfAddrsIsResponse¶
| Name | Value | Description |
|---|---|---|
| processed | uint64 | Number of requests processed. |
| status | RpcResponseStatus | Success or error details in case of failure. |
IpIntfAddrMergeModeIsRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
| merge_mode | bool | New IP address merge mode for the interface. |
IpIntfAddrMergeModeIsResponse¶
Empty message.
IpIntfAddrMergeModeRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
IpIntfAddrMergeModeResponse¶
| Name | Value | Description |
|---|---|---|
| merge_mode | bool | True if configuration should be merged with configuration from other agents or false if it should be replaced by those. |
IpIntfAddrModifyRequest¶
| Name | Value | Description |
|---|---|---|
| operation | IpAddrOperations | IP_ADDR_OP_ADD or IP_ADDR_OP_DELETE. |
| intf_id | IntfId | Name of the interface. |
| ip_addr_mask | IpAddrMask | IP address with mask. |
IpIntfAddrModifyResponse¶
Empty message.
IpIntfAddrsIsRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
| ip_addr_mask | repeated IpAddrMask | List of IP address with their masks. |
IpIntfAddrsIsResponse¶
Empty message.
IpIntfAddrsRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
IpIntfAddrsResponse¶
| Name | Value | Description |
|---|---|---|
| addrs | repeated IpAddrMask | List of IP addresses wtih masks. |
IpIntfEvent¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
| oneof ip_intf_event.addr | IpAddrEvent | Notifies a change in the interface's addresses. |
| oneof ip_intf_event.vlan_id | VlanId | Change in the interface's VLAN ID has changed. |
| ack | bool | If true, this is not an event and the fields below are invalid. |
IpIntfExistsRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
IpIntfExistsResponse¶
| Name | Value | Description |
|---|---|---|
| exists | bool | True if the interface exists, false otherwise. |
IpIntfInternalVlanIdRequest¶
| Name | Value | Description |
|---|---|---|
| intf_id | IntfId | Name of the interface. |
IpIntfInternalVlanIdResponse¶
| Name | Value | Description |
|---|---|---|
| vlan_id | VlanId | Internal VLAN ID associated with the interface. |
IpIntfWatchRequest¶
Making this request with all = false and no intf_id has no effect.
| 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. |