SR Linux NDK 0.1.0 Protobuf Documentation

SR Linux NDK 0.1.0 Protobuf Documentation^[src]

Represents configuration notification message to subscribe to configuration events

Represents MPLS route delete request, which can include one or more MPLS routes.

Methods with deprecated option

Network programming APIs and messages. This is the base layer for agent registration, router event notifications such as interface, LLDP, BFD, and so on; also provides keepalive functionality to detect agent liveliness

Represents application identifier request from agent. All applications are assigned an identifier by IDB.

Represents notification request from agent. Agent uses this message to subscribe to router events such as interface create, delete, or update, as well as LLDP neighbor create, delete, or update, and so on.

Represents base service that defines agent registration, unregistration, notification subscriptions, and keepalive messages.

Field	Type	Label	Description
name	string		Application name
author	string		Author name
is_connected	bool		Connected to IDB or not
version	string		Version string

Field	Type	Label	Description
id	uint32		Application id

Field	Type	Label	Description
op	SdkMgrOperation		Operation such as create, delete, or update
key	AppIdentKey		AppIdent key
data	AppIdentData		AppIdent data

Field	Type	Label	Description
key	AppIdentKey		Optional, to filter on name

Field	Type	Label	Description
op	SdkMgrOperation		Operation such as session create, delete, or update
key	BfdmgrGeneralSessionKeyPb		Session key
data	BfdmgrGeneralSessionDataPb		Session data

Name	Number	Description
SESSION_SUB_TYPE_UNKNOWN	0	Session subtype unknown
SESSION_SUB_TYPE_SINGLE_HOP	1	Single-hop session
SESSION_SUB_TYPE_MULTI_HOP	2	Multi-hop session
SESSION_SUB_TYPE_MICROBFD	3	microbfd session

Method Name	Request Type	Response Type	Description
MplsRouteAddOrUpdate	MplsRouteAddRequest	MplsRouteAddResponse	MPLS route add or update; can add or update more than one MPLS route in one request
MplsRouteDelete	MplsRouteDeleteRequest	MplsRouteDeleteResponse	MPLS route delete; can delete more than one MPLS route in one request
SyncStart	SyncRequest	SyncResponse	Synchronization start to begin synchronization operation
SyncEnd	SyncRequest	SyncResponse	Synchronization end to close synchronization operation

Method Name	Option
MplsRouteAddOrUpdate	true
MplsRouteDelete	true

.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)

Field	Type	Label	Description
status	BfdmgrSessionStatus		Status of the session
sub_type	BfdmgrGeneralSessionDataPb.BfdmgrSessionSubType		Subtype of the session
src_if_id	uint32		src_if_id is only populated for P2P type Source interface ID

Field	Type	Label	Description
type	BfdmgrSessionType		type is always present, other key field presence is determined by type Session type
src_ip_addr	IpAddressPb		key for type == SESSION_TYPE_P2P (if ipv6 link local also uses ipv6_ll_if_id below) Source IP address of the session
dst_ip_addr	IpAddressPb		Destination IP address of the session
instance_id	uint32		Network instance identifier
interface_name	string		type == SESSION_TYPE_MICROBFD
ipv6_ll_if_id	uint32		key for type == SESSION_TYPE_P2P (only ipv6 link local, in addition to other P2P fields above) Global if id for ipv6 link local session, otherwise 0

Name	Number	Description
INVALID	0	Session invalid
ADMIN_DOWN	1	Admin down
DOWN	2	Status down
INIT	3	Status initializing
UP	4	Status up and running

Name	Number	Description
SESSION_TYPE_UNKNOWN	0	Unknown session type
SESSION_TYPE_P2P	1	Peer-to-peer session type
SESSION_TYPE_MICROBFD	2	microbfd session type