Getting started

This guide provides information about the Model-Driven Command Line Interface (MD-CLI).

This guide is organized into functional sections and provides concepts and descriptions of the MD-CLI environment, the configuration workflow, and the syntax and command usage within the MD-CLI. It also describes how the MD-CLI interacts with the classic CLI to perform non-configuration operations.

For a list of unsupported features by platform and chassis, see the SR OS R23.x.Rx Software Release Notes, part number 3HE 19269 000 x TQZZA.

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

Note: This guide generically covers Release 23.x.Rx content and may contain some content that will be released in later maintenance loads. See the SR OS R23.x.Rx Software Release Notes, part number 3HE 19269 000 x TQZZA, for information about features supported in each load of the Release 23.x.Rx software.

Using the MD-CLI

All references to the term “CLI” in the SR OS user documentation are generally referencing the classic CLI. The classic CLI is the CLI that has been supported in SR OS from the initial introduction of SR OS.

The MD-CLI is a management interface that can be used to manage Nokia SR OS routers. Some of the benefits of the MD-CLI include:

  • follows the model-driven networking strategy, based on the same YANG models for a structured configuration and state. Consistency is maintained between the MD-CLI, NETCONF, and the gRPC model-driven interfaces.

  • uses the transactional configuration method which uses a candidate configuration to hold the current configuration changes before they are applied to the running configuration, and avoids configuration ordering requirements

  • provides multiuser candidate configuration modes (global, exclusive, private, and read-only) that control access to the configuration, allowing a user exclusive access to the configuration such that no other configuration changes can be made

  • allows the use of configuration groups with flexible templates that simplify the configuration process by applying the template instead of repeating the same configuration

  • provides MD-CLI commands to simplify integration with automation, such as displaying configuration and state in a structured format (JSON IETF or XML) and displaying contexts in an XPath format

The management interface configuration mode must be configured appropriately before using the MD-CLI. For more information, see the 7450 ESS, 7750 SR, 7950 XRS, and VSR System Management Guide, “Model-Driven Management Interfaces”.

Table 1. Command syntax symbols used in this guide
Symbol Description

|

A vertical bar represents an OR, indicating that only one of the parameters in the brackets or parentheses can be selected.

( )

Parentheses indicate that one of the parameters must be selected.

[ ]

Brackets indicate optional parameters.

Bold

Commands in bold indicate commands and keywords.

Italic

Commands in italics indicate that you must enter text based on the parameter.

In the following examples, location and graceful-shutdown are command names. For the location command, keyword must be one of the keywords cf1, cf2, or cf3. For the graceful-shutdown command, boolean must be one of the keywords true or false, although explicitly using the keyword true is optional.

location keyword

keyword - (cf1 | cf2 | cf3)

graceful-shutdown boolean

boolean - ([true] | false)

Conventions

This section describes the general conventions used in this guide.

Precautionary and information messages

The following information symbols are 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.

Options or substeps in procedures and sequential workflows

Options in a procedure or a sequential workflow are indicated by a bulleted list. In the following example, at step 1, the user must perform the described action. At step 2, the user must perform one of the listed options to complete the step.

Options in a procedure

  1. User must perform this step.
  2. This step offers three options. User must perform one option to complete this step.
    • This is one option.
    • This is another option.
    • This is yet another option.

Substeps in a procedure or a sequential workflow are indicated by letters. In the following example, at step 1, the user must perform the described action. At step 2, the user must perform two substeps (a. and b.) to complete the step.

Substeps in a procedure

  1. User must perform this step.
  2. User must perform all substeps to complete this action.
    1. This is one substep.
    2. This is another substep.