About this guide

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, install, and use custom show commands.

Note:

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

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

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.

  • 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.

  • 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.

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