cMAG-c documentation suite

This documentation suite covers the software features and functionality of the cMAG-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 software functionality for the cMAG-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.

Table 1. Software guides
Document Description Intended audience
A B C

Overview

cMAG-c Overview Guide Describes the Nokia containerized Multi-Access Gateway – controller, the control-plane component of the control and user plane separation (CUPS) solution. Built on SR Linux and deployed on Kubernetes, cMAG-c manages SR-based user-plane functions (UPFs) for BNG, combined SGW/PGW, and 5G UPF.

Install and commission

cMAG-c Installation Guide

Describes how to install the cMAG-c software and defines the prerequisites and procedures to install the cMAG-c elements.

Operate and maintain

cMAG-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 cMAG-c solution.

Monitor and troubleshoot

cMAG-c Log Events Reference Guide

Provides general information about log events.

cMAG-c Log Events Search Tool

Provides general information about log events as a searchable HTML list.

Reference

cMAG-c Data Model Guide

Gives general information about the configuration and state data models available for the Nokia cMAG-c and describes the predefined show reports.

cMAG-c CLI and Data Model Explorer

Allows users to browse through the configuration and state model for the Nokia cMAG-c and access detailed information for each transaction.

cMAG-c RADIUS Attributes and IU Triggers

Describes all supported RADIUS attributes and RADIUS interim update (IU) triggers in a searchable HTML list.

cMAG-c TPSDA Python 3 API

Describes the APIs used by Python developers to interact with various TPSDA protocols and applications on the cMAG-c.

Release Notes and Features Release Reference

The cMAG-c Release Notes and 7750 SR/VSR and cMAG-c Features Release Reference are not included with the cMAG-c software documentation package. See Accessing documentation for information about accessing the Release Notes and the Features Release Reference.

The 7750 SR/VSR and cMAG-c Features Release Reference lists the minimum software releases required for each feature in a CUPS deployment. A feature may require a minimum cMAG-c release (CP), a minimum SR OS release (UP), or minimum releases for both CP and UP.