Nokia NSP Ansible Collection¶
Welcome to the Nokia NSP Ansible Collection documentation!
The nokia.nsp collection provides production-ready Ansible plugins and modules for automating Nokia Network Services Platform (NSP) operations via RESTCONF API.
Quick Overview¶
The collection includes:
Plugins¶
nokia.nsp.nspHTTPAPI Plugin - OAuth2 client credentials authentication and communication with NSP
Modules¶
nokia.nsp.versionModule - Retrieve Nokia NSP system version informationnokia.nsp.actionModule - Execute YANG actions on Nokia NSP RESTCONF resourcesnokia.nsp.rpcModule - Execute global YANG RPC operations on Nokia NSPnokia.nsp.restModule - Execute REST API calls against Nokia NSPnokia.nsp.uploadModule - Upload files to Nokia NSPnokia.nsp.downloadModule - Download files from Nokia NSPnokia.nsp.wfmModule - Manage Nokia NSP Workflow Manager workflowsnokia.nsp.ibnModule - Manage Nokia NSP Intent Manager intent-types and intents
Key Features¶
- ✅ Secure Authentication - Automatic Bearer token management with client credentials
- ✅ RESTCONF API - Support for NSP REST and RESTCONF API operations
- ✅ Error Handling - Comprehensive error handling and HTTP status management
- ✅ Ansible Native - Integration with Ansible HTTPAPI framework
- ✅ Well Documented - Full docstrings and comprehensive guides
Getting Started¶
New to the collection? Here are some instructions to kickstart your automation journey:
- Installation - Install the collection and dependencies
- Quick Start - Run your first playbook
- Developer Guide - Write playbooks against NSP (tutorial and best practices)
- Examples - Working use-cases (day0, NSP setup, CI/CD)
Support¶
- Issues: GitHub Issues
- Install: Ansible Galaxy
Collection Version: 0.1.0 | License: BSD 3-Clause | Python: 3.11+ | Ansible: 2.14+