Protocol Documentation

name

Application name

author

Author name

is_connected

Connected to IDB or not

version

Version string

id

Application id

op

Operation such as create, delete, or update

key

AppIdent key

data

AppIdent data

key

Optional, to filter on name

op

Operation such as session create, delete, or update

key

Session key

data

Session data

key

Optional, to filter on name

status

Status of the session

sub_type

Subtype of the session

src_if_id

src_if_id is only populated for P2P type Source interface ID

type

type is always present, other key field presence is determined by type Session type

p2p

microbfd

sbfdecho

interface_name

src_ip_addr

Source IP address of the session

dst_ip_addr

Destination IP address of the session

instance_id

Network instance identifier

ipv6_ll_if_id

Global if id for ipv6 link local session, otherwise 0

instance_id

Network instance identifier

sr_policy_segment_list_id

sr_policy_color

sr_policy_endpoint

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

SESSION_SUB_TYPE_SBFD_ECHO

4

microbfd session

INVALID

0

Session invalid

ADMIN_DOWN

1

Admin down

DOWN

2

Status down

INIT

3

Status initializing

UP

4

Status up and running

SESSION_TYPE_UNKNOWN

0

Unknown session type

SESSION_TYPE_P2P

1

Peer-to-peer session type

SESSION_TYPE_MICROBFD

2

microbfd session type

SESSION_TYPE_SBFD_ECHO

3

seamless BFD session type, echo initiator

json

Entire configuration fragment as JSON string

js_path

JSON path formatted string from YANG; for example, interface{.name==ethernet1/1}.my_field

keys

repeated

Value for keys

op

Operation indicating create, delete, or update

key

Configuration key

data

Configuration data

key

Optional, to filter on name

admin_is_up

Admin state

mtu

Maximum transmission unit

if_type

Interface type; for example, loopback, physical, or LAG

port_id

Port identifier

description

Interface description

mac_addr

MAC address

aggregate_id

associated aggregate id

oper_is_up

Operational state

if_name

Interface name; for example, ethernet 1/1

op

Operation such as create, delete, or update

key

Interface key

data

Interface data

key

Optional, to filter on name

port_id

Port identifier

port_type

Port type

source_mac

Port MAC address

bgp_peer_address

repeated

LLDP BGP autodiscovered addresses

bgp_group_id

BGP group identifier

system_name

System name

system_description

System description

interface_name

Local interface name

chassis_id

Chassis identifier

chassis_type

Chassis type

op

Operation such as create, delete, or update

key

LLDP neighbor key

data

LLDP neighbor data

key

Optional, to filter on name

RESERVED

0

Reserved for future use

INTERFACE_ALIAS

1

Alias of the interface

PORT_COMPONENT

2

Port identifier based on a locally defined port component

MAC_ADDRESS

3

MAC address

NETWORK_ADDRESS

4

Network address

INTERFACE_NAME

5

Name of the interface

AGENT_CIRCUIT_ID

6

Port identifier based on the circuit ID in the DHCP relay agent information option

LOCALLY_ASSIGNED

7

Port identifier based on a locally defined alphanumeric string

RESERVED

0

Reserved for future use

CHASSIS_COMPONENT

1

Chassis identifier based on a locally defined chassis component

INTERFACE_ALIAS

2

Alias of the interface

PORT_COMPONENT

3

Chassis identifier based on a locally defined port component

MAC_ADDRESS

4

MAC address

NETWORK_ADDRESS

5

Network address

INTERFACE_NAME

6

Name of the interface

LOCALLY_ASSIGNED

7

Chassis identifier based on a locally defined value

routes

repeated

MPLS routes

status

Status of MPLS route add request

error_str

Detailed error string

routes

repeated

MPLS routes

status

Status of MPLS route delete request

error_str

Detailed error string

key

MPLS route key

data

MPLS route data

top_label

Top label

net_inst_name

Network instance name

nexthop_group_name

Next hop group name

operation

Operation such as POP or SWAP

preference

Route preference

INVALID_OP

0

Invalid operation

POP

1

Pop operation

SWAP

2

Swap operation

MplsRouteAddOrUpdate

MPLS route add or update; can add or update more than one MPLS route in one request

MplsRouteDelete

MPLS route delete; can delete more than one MPLS route in one request

SyncStart

Synchronization start to begin synchronization operation

SyncEnd

Synchronization end to close synchronization operation

MplsRouteAddOrUpdate

true

MplsRouteDelete

true

net_inst_id

Network instance identifier

base_name

Base name

oper_is_up

Operation status

router_id

Router identifier

inst_type

Network instance type

inst_name

Network instance name

op

Operation such as create, delete, or update

key

Network key

data

Network data

DEFAULT

0

Default network instance type

L3VRF

1

L3VRF network instance type

ip_nexthop

Next-hop IP address

label_stack

repeated

MPLS label stack

resolve_to

Resolve-to type

type

Resolution type

ip_nexthop

IP next-hop address

mpls_nexthop

MPLS next-hop

next_hop

repeated

Next-hops

group_key

repeated

Next-hop group key details

status

Response for next-hop group request

error_str

Detailed error string

key

Next-hop group key

data

Next-hop group data

name

Next-hop group name

network_instance_name

Next-hop group network instance name

op

Operation such as create, delete, or update

key

Next-hop group key

data

Next-hop group data

group_info

repeated

Next-hop group details

status

Response for next-hop group request

error_str

Detailed error string

key

Optional, to filter on name

INVALID

0

Invalid resolution

REGULAR

1

Regular resolution

MPLS

2

MPLS resolution

LOCAL

0

Resolve to local routes

DIRECT

1

Resolve to direct routes

INDIRECT

2

Resolve to indirect routes

NextHopGroupAddOrUpdate

Add or update one or more next-hop groups.

NextHopGroupDelete

Delete next-hop group.

SyncStart

Synchronization start to open synchronization operation.

SyncEnd

Synchronization end to close synchronization operation.

op

Operation such as create, delete, or update

key

IP route key

data

IP route data

key

Optional, to filter on name

routes

repeated

IP routes

status

Status of route add operation

error_str

Detailed error string

routes

repeated

IP routes

status

Status of route delete operation

error_str

Detailed error string

key

Route key

data

Route data

net_inst_name

Network instance name

ip_prefix

IP prefix

nexthop_group_name

Next hop group name

preference

Preference

metric

Metric

nexthop

repeated

List of next hops

owner_id

Next hop owner identifier returned only on notification.

nhg_id

Next-hop group identifier returned only on notification.

RouteAddOrUpdate

Add or update IP routes.

RouteDelete

Delete IP routes.

SyncStart

Synchronization start for IP routes

SyncEnd

Synchronization end for IP routes

es_id

Type 0 for now. hard-coded id

global_if_id

Global interface identifier

ip_addr

IP address

prefix_length

IP address prefix length

addr

IP address

prefix

IP prefix

state

IP prefix state

mac_address

MAC address

mpls_label

MPLS label

instance_id

Network instance identifier

port_id

Port identifier

status

Error code

error_str

Detailed error string

IF_ETH_DUPLEX_MODE_UNSET

0

duplex mode not supported

IF_ETH_DUPLEX_MODE_FULL

1

IF_ETH_DUPLEX_MODE_HALF

2

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

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

OTC

11

SAS otc interface

MAX

12

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!

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

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

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

Create

0

Create operation

Change

1

Change operation

Delete

2

Delete operation

kSdkMgrSuccess

0

Successful service call

kSdkMgrFailed

1

Failed service call

js_path

repeated

Optional, JSON path formatted strings, which are used in telemetry. Format of js_path follows hierarchical YANG. for example: .interface{.name==*}.my_app. .my_app.tunnel{.name==*} '*'' needs to be replaced with a specific key.

agent_liveliness

Kill this agent unless a keepalive is received within this many seconds. Value of 0 means do not monitor this agent for liveliness.

status

Status of the register; for example: kOk, kFailed

error_str

Detailed error text

app_id

Application ID assigned by SDK manager.

name

Application name

status

Status of the call; for example, kOk, kFailed

id

Identifier for the given application name

status

Status of keepalive; for example, kOk or kFailed

sub_id

Subscription identifier

intf

Interface details

nw_inst

Network instance details

lldp_neighbor

LLDP neighbor details

config

Configuration notification

bfd_session

BFD session details

route

IP route details

appid

App identification details

nhg

Next-hop group details

stream_id

Stream identifier, in NotificationRegisterResponse

subscriptions

repeated

List of subscription details

status

Status of the query

sub_id

Subscription identifier

description

Subscription description

stream_id

Unset on create, set otherwise

op

Specific operation in the notification register request

sub_id

Set for delete subscription, unset otherwise

intf

Interface subscription request

nw_inst

Network instance subscription request

lldp_neighbor

LLDP neighbor subscription request

config

Configuration subscription request

bfd_session

BFD session subscription request

route

IP route subscription request

appid

App identification subscription request

nhg

Nexthop Group subscription request

stream_id

Stream identifier. This needs to be passed to the SDK manager for further notification subscription changes specific to the current subscription

sub_id

Subscription identifier. Each subscription gets an identifier, which can be used to delete a subscription

status

Status of subscription

stream_id

Stream identifier

notification

repeated

Notification details

Create

0

Create a subscription

Delete

1

Delete all subscriptions

AddSubscription

2

Add subscription to existing subscriptions

DeleteSubscription

3

Delete one subscription from existing subscriptions

AgentRegister

Register agent

AgentUnRegister

Unregister agent

NotificationRegister

Register for event notifications

NotificationQuery

Returns current or specific notification subscription details

KeepAlive

Send periodic keepalive message

GetAppId

Get application name from application identifier

NotificationStream

Send stream of event notifications based on the agent subscriptions

json_content

Structured JSON telemetry data

key

repeated

Telemetry key

status

Status of delete request

error_str

Detailed error message

key

Telemetry key

data

Telemetry data

js_path

JSON path referencing the key for telemetry data

state

repeated

State of application

status

Status of telemetry update request

error_str

Detailed error message

TelemetryAddOrUpdate

Add or update telemetry data

TelemetryDelete

Delete telemetry data

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)