1. Getting started

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

1.1. About this document

This document describes the interfaces used with the Nokia Service Router Linux (SR Linux). These include:

  1. CLI
  2. gNMI
  3. JSON

This document also provides an overview to CLI plug-ins and details Nokia defined general and operation commands, and show commands.

This document is intended for network technicians, administrators, operators, service providers, and others who need to understand how to interface with the SR Linux.

Note:

This manual covers the current release and may also contain some content that will be released in later maintenance loads. Refer to the SR Linux Release Notes for information on features supported in each load.

1.2. What’s new

This is a new document that consolidates user interface reference material and procedures. In addition, the following release-level changes were made.

Table 1:  Change summary 

Topic

Location

Filtering of display output

  1. Using output filters
  2.   General and operational commands

Enhanced diff functionality

  1. Using the diff command
  2.   General and operational commands

Environment variable for CLI default network-instance

Configuring the network-instance environment variable

copy command

Using the copy command

replace command

Using the replace command

watch command

Setting commands to execute periodically

gNMI CAPABILITIES

gNMI capabilities RPC

gNMI subscribe STREAM TARGET

SubscriptionList message

Updated show reports

Pre-defined show reports

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 you begin 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 your 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.