Command Line Interface Reference, Modes A - B, StarOS Release 21.1

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents

Find Matches in This Book

Available Languages

Download Options

Book Title

Command Line Interface Reference, Modes A - B, StarOS Release 21.1

Chapter Title

About this Guide

PDF - Complete Book (10.17 MB) PDF - This Chapter (1.1 MB)
View with Adobe Reader on a variety of devices

Results

Updated:: April 24, 2017

Chapter: About this Guide

About this Guide
- CLI Command Sections
- Supported Documentsand Resources
  - Related Common Documentation
    - Related Product Documentation
    - Obtaining Documentation

About this Guide

This preface describes the Command Line Interface Reference and its document conventions.

This reference describes how to use the command line interface (CLI) to interact with the products supported by the StarOS™. The CLI commands are organized by command modes in the code and in this reference. The command modes are presented alphabetically. The description of each command states the command's function, describes its syntax, presents limitations when applicable, and offers an example of its usage.

CLI Command Sections
Supported Documents and Resources

CLI Command Sections

The following table describes the individual sections in the command descriptions presented in this reference.

Section	Description
Platform	The platform(s) on which the CLI command is supported.
Product	The product(s) supporting the CLI command.
Privilege	The user privilege levels having access to the CLI command. For more information on user types and user privileges, refer to the CLI Administrative Users section in the Command Line Interface Overview chapter.
Mode	The command and configuration mode sequences to the CLI configuration mode for the CLI command. For more information on command modes, refer to the CLI Command Modes section in the Command Line Interface Overview chapter.
Syntax	The command's syntax. For more information on CLI command syntax, refer to the CLI Command Syntax section in the Command Line Interface Overview chapter.
	Description of the keyword(s) and variable(s) in the command.
Usage	Information about the command's usage including dependencies and limitations, if any.
Example	Example(s) of the command.