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 Nokia Service Router Linux (SR Linux) CLI is a python-based application that can load dynamic plug-ins. Plug-ins are custom show commands that you can create and run from the SR Linux CLI. This document describes how to create custom CLI plug-ins, and defines the classes and utility functions used to create them. It also defines how to install, modify, and remove a CLI plug-in.

This document is intended for network technicians, administrators, operators, service providers, and others who need to create and install custom show commands.

1.2. Summary of changes

There are no changes since the last release.

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 1 describes information symbols contained in this document.

Table 1:  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.