Documentation architecture
NSP documents and tools
The following table lists the documents and resources in the NSP documentation collection. The delivery locations and formats are explained in subsequent sections.
Table 3-1: NSP documents and tools
|
Document or resource |
Description |
Help Center (on product) |
Doc Center |
Software download site |
Public access |
|---|---|---|---|---|---|
|
Alarm Search Tool |
The Alarm Search Tool in the on-product Help Center contains a searchable list of alarms that are relevant to the NSP installation; the list expands dynamically when new artifacts and adaptors are installed in the system. A comprehensive version of the Alarm Search Tool containing all possible alarms for all supported NEs is delivered to the Doc Center and updated as new adaptor artifacts are released. |
HTML |
HTML |
No |
Yes |
|
Analytics Report Catalog |
The NSP Analytics Report Catalog provides information about the reports that NSP Analytics can generate. |
HTML |
HTML |
No |
Yes |
|
Artifact Guides |
NSP supports the management of many devices over model-driven interfaces through adaptor artifacts, which provide mapping between the devices and the NSP. For each NE family that is managed this way, there is an adaptor artifact guide that details the support and limitations. Artifact documentation is updated and delivered regularly, on cadence with the artifacts themselves. |
No |
PDF, starting with NSP 25.8 |
Yes |
Yes |
|
Classic Management |
The NSP NFM-P Classic Management User Guide provides information about using the NFM-P to manage service-aware IP/MPLS networks, including GUI operations, device and network management, and policy and service management. |
HTML |
HTML |
No |
Yes |
|
CLM User Guide |
The CLM User Guide describes how to configure and use the Centralized License Manager. This document applies to users of an independent CLM deployment as well as those who use a CLM deployment that is integrated with NSP. |
HTML |
HTML |
No |
Yes |
|
Data Collection and Analysis Guide |
The NSP Data Collection and Analysis Guide introduces NSP Data Collection and Analysis functions to operators and administrators by describing usage and features. |
HTML |
HTML |
No |
Yes |
|
Device Configuration Intent Type Catalog |
The NSP Device Configuration Intent Type Catalog lists and provides brief descriptions of the available NSP product intent type artifacts. The document is updated each time new or modified device configuration artifact bundles are delivered, which can happen off-cycle from NSP releases. |
No |
|
Yes |
Yes |
|
Device Management Guide |
The Device Management Guide provides information about device management using NSP to operators and administrators by describing usage and features. For information about device management using NFM-P, see the NSP NFM-P Classic Management User Guide. |
HTML |
HTML |
No |
Yes |
|
Enterprise Guide |
The NSP Enterprise Guide describes the supported use-cases for Enterprise deployments of the NSP. |
HTML |
HTML |
No |
Yes |
|
Getting Started Guide |
The NSP Getting Started Guide (this guide!) is designed to provide a starting place for both new and returning NSP users. |
HTML |
HTML |
No |
Yes |
|
Glossary |
The NSP Glossary is intended to expand acronyms and define unique terms that are used throughout NSP guides and products. This guide is not intended to define industry-standard terms and will only provide spell-outs in those cases. |
HTML |
HTML |
No |
Yes |
|
Host Environment Compatibility Reference |
The HECR provides information about virtualization environments, NSP and RHEL OS compatibility, NSP and Kubernetes compatibility, and HPE SPP compatibility. This document is reissued regularly |
No |
|
No |
Restricted |
|
Installation and Upgrade Guide |
The NSP Installation and Upgrade Guide is intended for a technology officer, network planner, or system administrator who intends to perform a Network Services Platform deployment function. |
HTML |
HTML |
No |
Yes |
|
IP/Optical Coordination Guide |
The IP/Optical Coordination Guide introduces the IP/Optical Coordination GUI to operators and administrators by describing usage and features. |
HTML |
HTML |
No |
Yes |
|
Network and Service Assurance Guide |
The NSP Network and Service Assurance Guide shows you how to monitor and troubleshoot your network for optimal performance. It introduces the Network Services Platform, or NSP, to technology officers and network operators by describing the tools used for network performance monitoring, including NE and service KPIs, alarm management, OAM testing, performance plots, and map views. |
HTML |
HTML |
No |
Yes |
|
Network Automation Guide |
The Network Automation Guide introduces NSP network automation functions to operators and administrators by describing usage and features. |
HTML |
HTML |
No |
Yes |
|
Network Element Compatibility Guide (Current) |
The current NSP NFM-P Network Element Compatibility Guide identifies the compatibility between the supported releases of the NFM-P and the network elements it manages via classic mediation. This document is reissued regularly to communicate support for NEs as they are released and tested. |
No |
|
No |
Restricted |
|
Network Element Compatibility Guide (Legacy) |
The Legacy NSP NFM-P Network Element Compatibility Guide archives information formerly published in the current version of the guide. Once a year, as an NFM-P release ages out of active support, this document is reissued to archive the information. |
No |
|
No |
Restricted |
|
NFM-P Statistics Search Tool |
This tool provides a filterable interface for viewing NFM-P performance or accounting statistics information. The NSP HTML collection on the Doc Center provides launch points to each statistic type from the Additional Resources menu. If you download the tool as a ZIP for offline use, the files stats.html and acc-stats.html launch the performance and accounting statistics views, respectively. |
No |
HTML ZIP |
No |
Yes |
|
Path Control and Simulation Guide |
This document provides important contextual information and procedures that will enable readers to use NSP’s path control and simulation functions. |
HTML |
HTML |
No |
Yes |
|
Planning Guide |
The NSP Planning Guide is intended for technology officers, network planners, and system administrators who need the information required to plan a successful deployment of the Nokia Network Services Platform, or NSP. The reader is encouraged to become familiar with the NSP architecture, the relevant components for both IP and optical networks, and the virtualization, system, and network requirements. |
HTML |
HTML |
No |
Yes |
|
Release Description |
The NSP Release Description is intended to assist network planners and administrators by providing high-level feature descriptions for the release, along with the schedule for delivery. This document is cumulative for a major release cycle, for example NSP 25.4 through 25.11, and then resets with the next release, such as NSP 26.4. |
HTML |
HTML |
No |
Yes |
|
Release Notice |
The NSP Release Notice covers known issues related to the installation, deployment, and operation of the NSP - including the optionally deployable Classic Mediation (NFM-P) component and the Centralized License Manager (CLM). |
No |
|
No |
Restricted |
|
Security Hardening Guide |
The NSP Security Hardening Guide is a reference document for increasing NSP security at the physical, OS, transport, user, and application levels. |
HTML |
HTML |
No |
Yes |
|
Service Management Guide |
This document is intended to manage services. |
HTML |
HTML |
No |
Yes |
|
Service Pack Notes |
NSP Service Pack Notes accompany every NSP service pack (patch) delivered on the software download site. These documents list the fixes delivered in the service pack and describe how to install it. |
No |
No |
Yes |
No |
|
Statistics Management Guide |
The NSP NFM-P Statistics Management Guide describes statistics management using the NFM-P. Supported performance and accounting statistics are searchable in the Statistics Search Tool. |
HTML |
HTML |
No |
Yes |
|
System Administrator Guide |
The NSP System Administrator Guide is intended for operators who have NSP system administrator privileges and need to understand or perform Network Services Platform system management or maintenance. The guide describes how to perform operations for system and component configuration, security, access, and database management. |
HTML |
HTML |
No |
Yes |
|
System Architecture Guide |
The NSP System Architecture Guide describes the Network Services Platform architecture and interoperation with other systems from a high-level perspective. The audience is a technology officer, network planner, or system administrator who requires a broad technical understanding of the NSP system structure and design methodology. |
HTML |
HTML |
No |
Yes |
|
Telemetry Statistics Search Tool |
The NSP Telemetry Statistic Search Tool lists telemetry types available for statistics collection. There are two versions of the tool, one available on the Doc Center, containing a complete database of telemetry statistics, and one available on-product which is dynamically updated and which contains only statistics that are relevant to your network. |
HTML |
HTML |
No |
Yes |
|
Transport Slice Controller Guide |
The Transport Slice Controller Guide introduces the Transport Slice Controller to operators and administrators. |
HTML |
HTML |
No |
Yes |
|
Troubleshooting Guide |
The NSP Troubleshooting Guide provides information about using NSP, NFM-P tools, and other functions to troubleshoot customer services and the NSP network management domain. |
HTML |
HTML |
No |
Yes |
|
Use Case Catalog Sample Procedures |
This guide is a multi-release document that provides tested procedures with release-specific sample commands from different NSP releases, depending on the use case. |
HTML |
HTML |
No |
Yes |
|
Wavence Device Support Guide |
NSP NFM-P Wavence Device Support Guide describes how to discover, configure, and manage Wavence devices using the NFM-P and NSP. The guide is intended for network planners, administrators, and operators and is to be used in conjunction with other guides in the NFM-P and NSP documentation suite where management of Wavence devices does not differ from other network elements. Nokia recommends that you review the entire NSP NFM-P Wavence Device Support Guide before you attempt to manage Wavence devices. |
HTML |
HTML |
No |
Yes |