About this Guide


Note

The documentation set for this product strives to use bias-free language. For 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. While any existing biased terms are being substituted, 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.

This guide provides details about the APIs available for the Cloud Native Broadband Network Gateway (cnBNG) Control Plane (CP).

Conventions Used

The following tables describe the conventions used throughout this documentation.

Notice Type Description

Information Note

Provides information about important features or instructions.

Caution

Alerts you of potential damage to a program, device, or system.

Warning

Alerts you of potential personal injury or fatality. May also alert you of potential electrical hazards.

Typeface Conventions Description

Text represented as a screen display

This typeface represents displays that appear on your terminal screen, for example:

Login:

Text represented as commands

This typeface represents commands that you enter, for example:

show ip access-list

This document always gives the full form of a command in lowercase letters. Commands are not case sensitive.

Text represented as a command variable

This typeface represents a variable that is part of a command, for example:

show card slot_number

slot_number is a variable representing the desired chassis slot number.

Text represented as menu or sub-menu names

This typeface represents menus and sub-menus that you access within a software application, for example:

Click the File menu, then click New