About this guide

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

  • CLI

  • gNMI

  • JSON

  • NETCONF

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. See the for SR Linux Software Release Notes information about features supported in each load.

Configuration and command outputs shown in this guide are examples only; actual displays may differ depending on supported functionality and user configuration.

Precautionary and information messages

The following are information symbols used in the documentation.

DANGER: Danger warns that the described activity or situation may result in serious personal injury or death. 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: Warning indicates that the described activity or situation may, or will, cause equipment damage, serious performance problems, or loss of data.
Caution: Caution indicates that the described activity or situation may reduce your component or system performance.
Note: Note provides additional operational information.
Tip: Tip provides suggestions for use or best practices.

Conventions

The Nokia SR Linux documentation uses the following command conventions:

  • Bold type indicates a command that the user must enter.
  • Input and output examples are displayed in Courier text.
  • A vertical bar (|) indicates a mutually exclusive argument.
  • Square brackets ([ ]) indicate optional elements.
  • Braces ({ }) indicate a required choice. When braces are contained within square brackets, they indicate a required choice within an optional element.
  • Italic type indicates a variable.
The following table outlines platform grouping conventions used in the SR Linux documentation suite.
Note: Some platforms in the 7250 IXR support mixed systems. For more information about mixed system support, see "Chassis types" in the Configuration Basics Guide.
Table 1. Platform grouping legend
Platform group Description
7215 IXS 7215 IXS-A1
7220 IXR All 7220 IXR platforms
7220 IXR-Dx 7220 IXR-D1, 7220 IXR-D2, 7220 IXR-D2L, 7220 IXR-D3, 7220 IXR-D3L, 7220 IXR-D4, 7220 IXR-D5
7220 IXR-Hx 7220 IXR-H2, 7220 IXR-H3, 7220 IXR-H4, 7220 IXR-H4-32D, 7220 IXR-H5-32D, 7220 IXR-H5-64D, 7220 IXR-H5-64O
7250 IXR1 7250 IXR platforms
7250 IXR Gen 2 7250 IXR-6, 7250 IXR-10
7250 IXR Gen 2c+ 7250 IXR-6e with IMM2, 7250 IXR-10e with IMM2, 7250 IXR-X1b, 7250 IXR-X3b
7250 IXR Gen 3 7250 IXR-6e with IMM3, 7250 IXR-10e with IMM3, 7250 IXR-18e, 7250 IXR-X4
7250 IXR-6e/10e (mixed system) 7250 IXR-6e (mixed system)2, 7250 IXR-10e (mixed system)2
7730 SXR 7730 SXR-1-32D, 7730 SXR-1d-32D, 7730 SXR-1x-44S
1 References to the 7250 IXR platform group may be appended with (including mixed systems) or (excluding mixed systems) to indicate mixed system support.
2 References to this platform as part of 7250 IXR (mixed system) indicate mixed system support of 7250 IXR Gen 2c+ (IMM2) and 7250 IXR Gen 3 (IMM3). That is, the 7250 IXR-6e and 7250 IXR-10e can hold and support both IMM2 and IMM3 at the same time.