User Documentation Home

Welcome to the HTML library for the Nokia SR Linux

The SR Linux HTML library provides quick access to the technical documentation.

For product technical support, visit the Doc Center portal or the Product Index.

Navigating

The Home button (Home icon) displays the Welcome page.

Browse topics in the Contents frame (Contents icon) on the left. Click on a topic to have it displayed. Use the Back and Forward buttons to navigate within the history of viewed topics.

Searching

To quickly locate topics on a particular subject in the documentation, enter a query in the Search field. Use the Search frame (Search icon) to display the Search view. You can narrow the scope of your search by selecting only the sections you are interested in.

Please note that 500 is the maximum number of hits displayed in the search results. Use the scope feature to narrow the search, or try searching within individual topics or sections.

Synchronizing

Clicking the Show in Table of Contents button (Show in Table of Contents icon) will select that topic in the navigation tree. The Link with Contents button (Link with Contents icon) keeps the navigation tree synchronized to the current topic.

SR Linux Guides

  • CLI Plug-in Guide
    Describes how to create custom show routines, and defines the classes and utility functions used to create them.
  • Product Overview
    Describes at a high-level SR Linux functionality, including key components, and where it fits into the network.
  • Software Installation
    Describes basic concepts behind Linux kernel operation on SR Linux and provides procedures for upgrading the software using Zero Touch Provisioning (ZTP).

Search Tips

Search terms

You can search for:

  • single words
  • multiple words—search function returns documents that contain both items (Boolean AND)
  • hyphenated words
  • phrases

To search for a phrase or a hyphenated word, enter the words surrounded by double quotation marks. For example, when you enter "synchronous Ethernet " or "fabric-profile", any text that contains the exact words "synchronous Ethernet" or "fabric-profile" without any intervening words is displayed.

You can search for similar terms by using the ? and * wildcard characters. Use the ? character to denote a single-character wildcard. For example, when you enter 72?0, any documents that that contain "7250" or "7220" are displayed. Use the * character to denote a string wildcard. For example, when you enter channel*, any documents that contain "channel", "channels", or "channelized" are displayed.

(Note: If you use the ? or * wildcard character within quotation marks, the characters in the term or phrase are treated as literal characters, instead of wildcard characters.)

Boolean operators

You can include two or more search terms in a search query by combining them with a Boolean operator. Boolean operators must be uppercase.

(Note: When a Boolean operator is not included in a search query, the search automatically combines terms with the AND operator.)

When you combine terms with the OR Boolean operator, the search returns documents that contain at least one of the terms.

When you combine terms with the AND Boolean operator, the search returns documents that contain both of the terms.

When you combine terms with the NOT Boolean operator, the search returns documents that contain terms before the NOT operator, but do not contain terms after the NOT operator. For example, when you enter "clock" NOT adaptive differential, the search returns any documents that contain "clock", but do not contain "adaptive" or "differential".

Fuzzy searches

Fuzzy searches are enabled by default and can be used to find approximate term matches for a search query. Fuzzy searches:

  • ignore case
  • ignore inflections (letters added to beginning or ending of a base word to express a grammatical meaning (for example, when you enter "synchronous", the search may return "synchronization" and "asynchronous"; when you enter "present", the search may return "presents", "presented" and "representation")
  • ignore the following stop words: a, and, are, as, at, be, but, by, in, into, is, it, no, not, of, on, or, s, such, t, that, the, their, then, there, these, they, to, was, will, with
  • search within words (for example, when you enter "two" the search may return "network")

You can use quotation marks to eliminate some of the fuzzy search defaults. For example, when you enter "configuration", the search does not return topics that contain "configures" or other inflections of the word. You can include spaces in the quotation marks to avoid searching within words. For example, when you enter "IES", documents that contain "policies" are not returned. Case will still be ignored.

Scope

You can limit your search to specific documents or sections of a document. You can use the Search Topics feature, or you can define and save a scope.

You can search within one document or section of a document by using the Search Topics feature. Select an item from the Contents panel and click on the Search Topics button (Search icon). Choose "Search selected topic" or "Search selected topic and all subtopics" and enter your search query in the window that opens.

To define and save a scope, click on the Scope link next to the Search field. From the Select Scope window, you can choose a pre-defined scope, or click on the New button to define a scope. When you define a scope, you can choose multiple documents and/or sections.

Click on the tabs to view each section.