MAG-c documentation suite
This documentation suite covers the software features and functionality of the MAG-c platform. The documentation suite describes topics such as software installation, functional overview, interface description, and technical reference.
Software guides
The software guides describe specific SR OS software functionality for the MAG-c platform. The guides are organized into functional chapters that describe concepts, implementation flow, and the command line interface (CLI) syntax and command usage. See Accessing documentation for information about accessing software guides.
Intended audience legend:
- A – network architects and designers
- B – installers
- C – network technicians, administrators, operators, and service providers
The following table describes the software guides in this documentation suite and the intended audience for each guide.
| Document | Description | Intended audience | ||
|---|---|---|---|---|
| A | B | C | ||
|
Overview |
||||
| MAG-c Overview Guide | Provides an overview of the Nokia control and user plane separation (CUPS) solution. The control plane (CP) is known as the MAG-c and has the ability to control SR OS based user planes (UPs). The various UP functions include BNG, combined SGW/PGW, and 5G UPF. |
✓ |
✓ |
✓ |
|
Install and commission |
||||
|
MAG-c Installation Guide |
Describes how to install the MAG-c software and defines the prerequisites and procedures to install the MAG-c elements. |
— |
✓ |
✓ |
|
Operate and maintain |
||||
|
MAG-c Control Plane Function Guide |
Describes the Nokia control plane (CP) functionality and provides concepts and descriptions of the implementation flow, CLI syntax, and command usage for the MAG-c solution. |
✓ |
— |
✓ |
|
MAG-c Control Plane Function Advanced Configuration Guide |
Provides feature and configuration explanations, CLI descriptions, and overall solutions for the control plane function (CPF) for control and user plane separation (CUPS) solutions. |
✓ |
— |
✓ |
|
Monitor and troubleshoot |
||||
| MAG-c Log Events Reference Guide |
Provides general information about log events. |
— |
— |
✓ |
|
MAG-c Log Events Search Tool |
Provides general information about log events as a searchable HTML list. |
— |
— |
✓ |
| MAG-c Troubleshooting Guide | Provides troubleshooting procedures for the MAG-c. Describes commonly encountered problems and events. |
— |
✓ |
✓ |
|
Reference |
||||
|
MAG-c CLI Reference Guide |
Describes CLI usage, all CLI commands, and the supported values and parameters for each command. |
✓ |
✓ |
✓ |
|
MAG-c PFCP Interface Description Guide |
Describes the applicability of the packet forwarding control protocol (PFCP) for fixed broadband access and the protocol extensions for the MAG-c. |
— |
— |
✓ |
|
MAG-c RADIUS Attributes and IU Triggers |
Describes all supported RADIUS attributes and RADIUS interim update (IU) triggers in a searchable HTML list. |
— |
— |
✓ |
|
MAG-c SBI IE Search Tool |
Lists all the information elements (IEs) for the different Service Based Interface (SBI) services. |
— |
— |
✓ |
|
MAG-c TPSDA Python 3 API |
Describes the APIs used by Python developers to interact with various TPSDA protocols and applications on the MAG-c. |
✓ |
— |
✓ |
MAG-c appliance guide
The MAG-c appliance guide describes the specific installation and configuration for the MAG-c appliance. See Accessing documentation for information about accessing the MAG-c appliance guide.
Intended audience legend:
- A – network architects and designers
- B – installers
- C – network technicians, administrators, operators, and service providers
The following table describes the MAG-c appliance guide in this documentation suite and the intended audience for it.
| Document | Description | Intended audience | ||
|---|---|---|---|---|
| A | B | C | ||
|
Install and commission |
||||
|
MAG-c Appliance Installation and Deployment Guide |
Describes how to install, configure, and deploy the MAG-c appliance. |
— |
✓ |
✓ |
Release Notes and Features Release Reference
The MAG-c Release Notes and 7750 SR and VSR BNG CUPS Features Release Reference are not included with the MAG-c software documentation package. See Accessing documentation for information about accessing the Release Notes and the Features Release Reference.
The 7750 SR and VSR BNG CUPS Features Release Reference gives an overview of the minimal software release needed for a specific feature. A feature can require a minimal MAG-c release only (CP), a minimal SR OS release only (UP), or in most cases a minimal release for both MAG-c and SR OS (CP and UP).
The Nokia customer documentation team has introduced the RN Navigator – an online tool for quickly finding information in the Release Notes –. The RN Navigator can be accessed online at https://documentation.nokia.com/rn-navigator/products/. A customer account login is required.