SdkMgrRouteService

Represents service for IP route operations.

Method Name Request / Response Type Description
RouteAddOrUpdate RouteAddRequest
RouteAddResponse

Add or update IP routes.

RouteDelete RouteDeleteRequest
RouteDeleteResponse

Delete IP routes.

SyncStart SyncRequest
SyncResponse

Synchronization start for IP routes

SyncEnd SyncRequest
SyncResponse

Synchronization end for IP routes

IpRouteNotification

Represents IP route notification.

Field Type Description
op SdkMgrOperation

Operation such as create, delete, or update

key RouteKeyPb

IP route key

data RoutePb

IP route data

IpRouteSubscriptionRequest

Represents IP route subscription request.

Field Type Description
key RouteKeyPb

Optional, to filter on name

RouteAddRequest

Represents route add request; can contain more than one route.

Field Type Description
routes (repeated) RouteInfo

IP routes

RouteAddResponse

Represents route add response.

Field Type Description
status SdkMgrStatus

Status of route add operation

error_str string

Detailed error string

RouteDeleteRequest

Represents route delete request; can contain more than one route.

Field Type Description
routes (repeated) RouteKeyPb

IP routes

RouteDeleteResponse

Represents route delete response.

Field Type Description
status SdkMgrStatus

Status of route delete operation

error_str string

Detailed error string

RouteInfo

Represents route information.

Field Type Description
key RouteKeyPb

Route key

data RoutePb

Route data

RouteKeyPb

Represents route key.

Field Type Description
net_inst_name string

Network instance name

ip_prefix IpAddrPrefLenPb

IP prefix

RoutePb

Represents route data.

Field Type Description
nexthop_group_name string

Next hop group name

preference uint32

Preference

metric uint32

Metric

nexthop (repeated) NextHop

List of next hops

owner_id uint32

Next hop owner identifier returned only on notification.

nhg_id uint64

Next-hop group identifier returned only on notification.

AgentReply

Empty message from agent.

Field Type Description
es_id bytes

Type 0 for now. hard-coded id

GlobalIfId

Represents global interface identifier.

Field Type Description
global_if_id uint32

Global interface identifier

IpAddrPrefLenPb

Represents IP prefix.

Field Type Description
ip_addr IpAddressPb

IP address

prefix_length uint32

IP address prefix length

IpAddressPb

Represents IP address.

Field Type Description
addr bytes

IP address

IpInterfaceAddrPrefixPb

Represents IP prefix state.

Field Type Description
prefix IpAddrPrefLenPb

IP prefix

state IpAddressState

IP prefix state

MacAddressPb

Represents MAC address.

Field Type Description
mac_address bytes

MAC address

MplsLabel

Represents MPLS label.

Field Type Description
mpls_label uint32

MPLS label

NetInstanceId

Represents network instance identifier.

Field Type Description
instance_id uint32

Network instance identifier

PortIdPb

Represents port identifier.

Field Type Description
port_id uint64

Port identifier

SyncRequest

Empty message for synchronization request.

SyncResponse

Empty message for synchronization end.

Field Type Description
status SdkMgrStatus

Error code

error_str string

Detailed error string

IfEthernetDuplexModeType

Represents interface ethernet duplex mode. Corresponds to yang values

Name Number Description
IF_ETH_DUPLEX_MODE_UNSET 0

duplex mode not supported

IF_ETH_DUPLEX_MODE_FULL 1

IF_ETH_DUPLEX_MODE_HALF 2

IfEthernetPortSpeedType

Represents interface ethernet port speed. Corresponds to yang values

Name Number Description
IF_ETH_PORT_SPEED_UNSET 0

Speed unknown

IF_ETH_PORT_SPEED_10M 1

IF_ETH_PORT_SPEED_100M 2

IF_ETH_PORT_SPEED_1G 3

IF_ETH_PORT_SPEED_10G 4

IF_ETH_PORT_SPEED_25G 5

IF_ETH_PORT_SPEED_40G 6

IF_ETH_PORT_SPEED_50G 7

IF_ETH_PORT_SPEED_100G 8

IF_ETH_PORT_SPEED_200G 9

IF_ETH_PORT_SPEED_400G 10

IF_ETH_PORT_SPEED_1T 11

IfMgrIfType

Represents interface type.

Name Number Description
ETHERNET 0

Ethernet interface

LOOPBACK 1

Loopback interface

MANAGEMENT 2

Management interface

AGGREGATE 3

Aggregate(LAG) interface

IRB 4

Integrated Routing and Bridging (IRB) interface

SYSTEM 5

System interface

LIF 6

linux interface

NIC 7

linux nic interface (bus/dev/fn)

VHOST 8

vhost-net interface, vhn-<name> name for sock-path

KKLIF 9

temp name for new style of lif interface

KKVHOST 10

temp name for new style of vhost interface

MAX 11

Name Number Description
IF_OPER_DOWN_NONE 0

IF_OPER_DOWN_PORT_ADMIN_DISABLED 1

IF_OPER_DOWN_MDA_ADMIN_DISABLED 2

IF_OPER_DOWN_TRANS_LASER_DISABLED 3

IF_OPER_DOWN_MDA_NOT_PRESENT 4

IF_OPER_DOWN_TRANS_NOT_PRESENT 5

IF_OPER_DOWN_PHY_INIT 6

IF_OPER_DOWN_LOOPBACK 7

IF_OPER_DOWN_LOWER_LAYER_DOWN 8

IF_OPER_DOWN_MTU_RESOURCES 9

IF_OPER_DOWN_UNSUPPORTED_SPEED 10

IF_OPER_DOWN_UNSUPPORTED_TRANS_FEC 11

IF_OPER_DOWN_OTHER 12

IF_OPER_DOWN_PORT_NOT_PRESENT 13

used internally by chassis mgr only - xdp never publish to IDB!

IF_OPER_DOWN_FABRIC_AVAILABILITY 14

used internally by chassis mgr only - xdp never publish to IDB!

IF_OPER_DOWN_NO_ACTIVE_LINKS 15

lag interface only

IF_OPER_DOWN_MIN_LINK_THRESHOLD 16

lag interface only

IF_OPER_DOWN_9_12_SPEED_MISMATCH 17

Vodka port 9-12 must all be same speed as port 9

IF_OPER_DOWN_LAG_RESOURCES 18

lag interface only

IF_OPER_DOWN_LAG_MEMBER_RESOURCES 19

lag member interface only

IF_OPER_DOWN_STANDBY_SIGNALING 20

ESM multihoming

IF_OPER_DOWN_HOLD_TIME_UP_ACTIVE 21

interface hold-time up is actively holding the interface down

IF_OPER_DOWN_RELOAD_TIME_ACTIVE 22

interface reload time is actively holding the interface down

IF_OPER_DOWN_CONNECTOR_DOWN 23

parent connector oper down forces breakout port oper down

IF_OPER_DOWN_AUTO_NEG_MISMATCH 24

IF_OPER_DOWN_EVENT_HANDLER 25

used internally by chassis mgr only - xdp never publish to IDB!

IfOperStateType

Represents interface operational state.

Name Number Description
IF_OPER_STATE_UP 0

Interface operational state up

IF_OPER_STATE_DOWN 1

Interface operational state down

IF_OPER_STATE_TESTING 2

Interface operational state testing

IF_OPER_STATE_UNKNOWN 3

Interface operational state unknown

IF_OPER_STATE_DORMANT 4

Interface operational state dormant

IF_OPER_STATE_NOT_PRESENT 5

Interface operational state not present

IF_OPER_STATE_LOWER_LAYER_DOWN 6

Interface operational state lower layer down

IfTransceiverFecType

Represents interface transceiver fec. Corresponds to yang values

Name Number Description
IF_TRANS_FEC_UNSET 0

Fec unknown

IF_TRANS_FEC_DISABLED 1

IF_TRANS_FEC_RS528 2

IF_TRANS_FEC_RS544 3

IF_TRANS_FEC_BASER 4

IF_TRANS_FEC_RS108 5

IpAddressState

Represents IP address state.

Name Number Description
IPADDR_STATE_UNKNOWN 0

IP address state unknown

IPADDR_STATE_TENTATIVE 1

IP address state tentative

IPADDR_STATE_DUPLICATED 2

IP address state duplicated

IPADDR_STATE_INACCESSIBLE 3

IP address state inaccessible

IPADDR_STATE_DEPRECATED 4

IP address state deprecated

IPADDR_STATE_PREFERRED 5

IP address state preferred

SdkMgrOperation

Represents enumeration value for operation in subscription.

Name Number Description
Create 0

Create operation

Update 1

Update operation

Delete 2

Delete operation

SdkMgrStatus

Represents status of network programming service calls.

Name Number Description
kSdkMgrSuccess 0

Successful service call

kSdkMgrFailed 1

Failed service call

Proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)

Created by Siva Sivakumar / Roman Dodin / srl-labs