1. Getting started

This chapter provides an overview of this document, includes summaries of changes from previous releases, and lists precautionary messages and command conventions.

1.1. About this document

The NetOps Development Kit (NDK) allows operators to program high-performance, integrated agents that run alongside the Nokia Service Router Linux (SR Linux). This document provides programming gRPC APIs used with the NDK.

This document is intended for users who plan to program high-performance, integrated agents for SR Linux.

1.2. Summary of changes

This following changes were made in this release.

Table 1:  Change summary 

Topic

What’s changed

NextHopGroupNotification

New

NextHopGroupSubscriptionRequest

New

RoutePb

Updated

IfMgrIfType

Updated

IfOperDownReason

Updated

Notification

Updated

NotificationRegisterRequest

Updated

Scalar Values

Updated

1.3. Precautionary messages

Observe all dangers, warnings, and cautions in this document to avoid injury or equipment damage during installation and maintenance. Follow the safety procedures and guidelines when working with and near electrical equipment.

Table 2 describes information symbols contained in this document.

Table 2:  Information symbols  

Symbol

Meaning

Description

Danger

Warns that incorrect handling and installation could result in bodily injury. An electric shock hazard could exist. Before beginning work on this equipment, be aware of hazards involving electrical circuitry, be familiar with networking environments, and implement accident prevention procedures.

Warning

Warns that incorrect handling and installation could result in equipment damage or loss of data.

Caution

Warns that incorrect handling may reduce component or system performance.

Note

Notes contain suggestions or additional operational information.

1.4. Conventions

Nokia SR Linux documentation uses the following command conventions.

  1. Bold type indicates a command that the user must enter.
  2. Input and output examples are displayed in Courier text.
  3. An open right angle bracket indicates a progression of menu choices or simple command sequence (often selected from a user interface). Example: start > connect to
  4. Angle brackets (< >) indicate an item that is not used verbatim. For example, for the command show ethernet <name>, name should be replaced with the name of the interface.
  5. A vertical bar (|) indicates a mutually exclusive argument.
  6. Square brackets ([ ]) indicate optional elements.
  7. Braces ({ }) indicate a required choice. When braces are contained within square brackets, they indicate a required choice within an optional element.
  8. Italic type indicates a variable.

Generic IP addresses are used in examples. Replace these with the appropriate IP addresses used in the system.