CS Manual Version 3.7

Copyright: 2024 © NetModule AG

Modification date: 06.12.2024

Legal: Legal Aspects

Overview

Installation	Operation	Maintenance
Installation	User Management	Support & Troubleshooting
First steps	Device Management	Platform Status
Network architecture	Dashboard	Platform Updates
Network Management	Variables & Bulk Editor	Update & Backup
Certificate Management	Artifacts
	Jobs
	Remote Access
	Child Device Access
	User Traffic

Content

• 1. Introduction
  • 1.1. Key Features
  • 1.2. System Architecture
  • 1.3. Web interface Connectivity Suite
• 2. Installation
  • 2.1. System requirements
    • 2.1.1. Server Hardware
    • 2.1.2. Server Software
  • 2.2. Devices Compatible with Connectivity Suite
  • 2.3. DNS prerequisites
    • 2.3.1. Domain name / FQDN
    • 2.3.2. Devices CNAMEs (Subdomains)
    • 2.3.3. DNS Example (with Proxy Records support)
  • 2.4. Firewall
    • 2.4.1. Incoming Ports
    • 2.4.2. Outgoing Ports
  • 2.5. Network Address Blocks
  • 2.6. Installing the Connectivity Suite
    • 2.6.1. Downloading the cs-cmd
    • 2.6.2. Running the cs-cmd Installation Assistant
• 3. First steps
  • 3.1. License
    • 3.1.1. License Management
  • 3.2. First Login
  • 3.3. Adding a Network
  • 3.4. Adding a Provisioning Configuration
  • 3.5. Installating a Provisioning Configuration
  • 3.6. Move Device from Provisioning to Network
• 4. Network Management
  • 4.1. Add a Network
• 5. Certificate Management
  • 5.1. Certificate Lifetimes
  • 5.2. Certificate Renewal
  • 5.3. Individual Settings
    • 5.3.1. Custom Lifetime & Renewal Settings
    • 5.3.2. Custom Certificate Deployment Schedule
• 6. Device Management
  • 6.1. Device Inventory & Status
    • 6.1.1. Connection Status
    • 6.1.2. Device Details Page
    • 6.1.3. Device Details Tab
  • 6.2. Device Configuration Handling
    • 6.2.1. Variables
    • 6.2.2. Copy Device configurations
    • 6.2.3. Restore configuration
    • 6.2.4. Manual configuration updates
    • 6.2.5. Install provisioning configuration on a device
    • 6.2.6. Provisioning via the Web Manager
  • 6.3. Compare configurations
    • 6.3.1. Compare two configurations of the same device or type
    • 6.3.2. Compare any two configurations
  • 6.4. Generic Device actions
    • 6.4.1. Deploy a Configuration
    • 6.4.2. Deploy a Snippet
    • 6.4.3. Deploy Software
    • 6.4.4. Reboot a Device
    • 6.4.5. Move Network
    • 6.4.6. Delete a Device
    • 6.4.7. Add a generic Device
  • 6.5. Router specific actions
    • 6.5.1. Router Provisioning
    • 6.5.2. Router replacement
  • 6.6. Switch specific actions
    • 6.6.1. Supported switch firmware releases
    • 6.6.2. Switch provisioning
  • 6.7. WLAN Access Point specific actions
    • 6.7.1. Firmware releases
    • 6.7.2. Provisioning
• 7. Dashboard
  • 7.1. Tiles
    • 7.1.1. Devices in Networks tile
    • 7.1.2. Devices in Provisioning tile
    • 7.1.3. Device Models tile
    • 7.1.4. VPN Networks tile
    • 7.1.5. Jobs tile
    • 7.1.6. Software tile
    • 7.1.7. Notifications & Warnings tile
• 8. Variables & Bulk Editor
  • 8.1. System & Custom Variables
    • 8.1.1. Custom Variables
  • 8.2. Bulk Import
  • 8.3. Device List Export
  • 8.4. Deployments using Variables
• 9. Artifacts
  • 9.1. Snippets
    • 9.1.1. Add Snippets
    • 9.1.2. Deploying Snippets
  • 9.2. Template Device Configurations
    • 9.2.1. Add Template Device Configuration
    • 9.2.2. Deploying Template Device Configurations
  • 9.3. License File Management
    • 9.3.1. Deploy Licenses
  • 9.4. Scripts
    • 9.4.1. Add a new Script
    • 9.4.2. Import existing Scripts
    • 9.4.3. Editing Scripts
    • 9.4.4. Deployment of Scripts
  • 9.5. Software/Firmware
    • 9.5.1. Add Software / Firmware
    • 9.5.2. Deploying Software
    • 9.5.3. Update Notifications for Devices
  • 9.6. Provisioning Configurations
    • 9.6.1. Supported NM router firmware releases
• 10. Jobs
  • 10.1. Job Details
  • 10.2. Job schedules
    • 10.2.1. Fire and forget
    • 10.2.2. Scheduled
  • 10.3. Job States
  • 10.4. Task States
  • 10.5. System Jobs
• 11. Remote Access
  • 11.1. Device access via Web Proxy
    • 11.1.1. Default Option (basic)
    • 11.1.2. Proxy Records Option (advanced)
    • 11.1.3. Enable Proxy Records
    • 11.1.4. Configure Proxy Records
  • 11.2. Device access via OpenVPN client
    • 11.2.1. Installing OpenVPN Client
    • 11.2.2. OpenVPN access
  • 11.3. Child Device Remote Access
  • 11.4. Automatic adaption of NAT rules
    • 11.4.1. Use in Provisioning configurations
    • 11.4.2. Moving the device from a network to another network
• 12. Network architecture
  • 12.1. System architecture IP overview
  • 12.2. Setting the number of VPN Networks
    • 12.2.1. VPN Subnet Pools
    • 12.2.2. Configure the VPN Subnet Pools
    • 12.2.3. Setting the number of Child Devices
• 13. Child Device Access
  • 13.1. Overview
  • 13.2. Network Address Translation (NAT)
    • 13.2.1. NAT Example Use Case
    • 13.2.2. Router Settings for NAT
  • 13.3. Custom Routes
    • 13.3.1. Configuration
• 14. User Traffic
  • 14.1. Enabling User Traffic
  • 14.2. Traffic from the company network to routers and end devices
  • 14.3. Traffic from routers and end devices to company network
    • 14.3.1. Routing
    • 14.3.2. Masquerading
  • 14.4. NAT Rules
  • 14.5. Disabling User Traffic
• 15. User Management
  • 15.1. Platform Admin
  • 15.2. Network Admin
  • 15.3. Network user
  • 15.4. User rights table
  • 15.5. Assigning user rights
  • 15.6. Password Policy
  • 15.7. Brute Force Protection
  • 15.8. Enabling Two-Factor Authentication (2FA)
    • 15.8.1. Enforcing 2FA for all users
    • 15.8.2. Enforcing 2FA for individual users
• 16. Customizations
  • 16.1. Additional Docker Containers
    • 16.1.1. NTP Server
    • 16.1.2. Grafana
    • 16.1.3. Start or update instance with extra services
  • 16.2. Customising the Connectivity Suite API / Proxy settings
  • 16.3. Triggering scripts on VPN servers
• 17. Support & Troubleshooting
  • 17.1. Support
    • 17.1.1. Belden Support
    • 17.1.2. Logs
    • 17.1.3. Network
    • 17.1.4. Data Maintenance
  • 17.2. Troubleshooting
    • 17.2.1. Troubleshoot a Device
    • 17.2.2. Renew an expired device certificate
    • 17.2.3. Troubleshoot the Connectivity Suite
    • 17.2.4. inotify limit reached
    • 17.2.5. Browser settings Connectivity Suite SSL Certificate
    • 17.2.6. Docker log rotation
• 18. Platform Status
  • 18.1. Network
    • 18.1.1. Platform
    • 18.1.2. Core
    • 18.1.3. Network Details Overview
  • 18.2. Certificates
    • 18.2.1. Overview
    • 18.2.2. Certificate Details
• 19. Platform Updates
• 20. Update & Backup
  • 20.1. Update v3.a.b > v3.x.y
  • 20.2. Upgrade v2.6 > v3.x
    • 20.2.1. Migration Notes
• 21. Appendix
  • 21.1. Abbreviations
  • 21.2. Glossary
  • 21.3. Legal Aspects

NetModule AG

Maulbeerstrasse 10

3011 Bern

Switzerland

info@netmodule.com

Tel +41 31 985 25 10

Fax +41 31 985 25 11

https://www.netmodule.com