NCM Template

This article covers how NCM templates control the way Cloudmon logs into a device and pulls its configuration. Use it to understand Global vs. Custom templates, and to build or edit a Custom template correctly the first time.

Overview

NCM templates define how Cloudmon connects to, authenticates with, and issues backup or upload commands to network devices. Each template describes a device's login sequence, connection protocol, and the exact commands used to retrieve or push configuration files.

Templates fall into two categories: Global templates maintained by Cloudmon, and Custom templates maintained by your organisation.

Tip: A common approach is to clone a Global template and customise it, rather than building a Custom one from scratch.

Global vs. Custom Templates

Creating a New Custom Template

Step 1: Navigate to NCM Templates

Go to Network → NCM → Templates. Check both the Global and Custom lists for an existing template before creating a new one, to avoid duplicate work.

Step 2: Click Add Template

Click Add. This opens the Add NCM Template panel.

Step 3: Enter Basic Information

Step 4: Configure SysObjectID Matches 

Expand this section to automatically bind the template to devices reporting a matching SNMP SysObjectID.

• Enter the OID.
• Click the + icon to add multiple OIDs if the template should cover several device models.
• Devices matching this OID are automatically assigned this template during discovery, removing the need for manual selection.

Step 5: Configure Advanced Login Settings (Optional)

Expand Advanced Login Settings to customise how Cloudmon logs into a device before running any backup or upload commands. Once any field in this section is completed, the section is marked "configured" in the template list.

When to use this: Configure Advanced Login Settings when a device has a non-standard login banner, requires an extra keystroke to reach a command prompt, or needs a specific enable sequence before configuration commands will work.

Step 6: Define Protocols / Command Set

This is the core of the template. It controls how Cloudmon connects to the device and what commands it runs.

Each protocol tab can be removed individually with the delete icon if not needed. Use + Add protocol at the bottom of the form to attach additional connection methods to the same template.

• Exclude Criteria: Define conditions under which this template should not apply (for example specific firmware versions or model subtypes), to prevent incorrect auto-matching.
• View Source: Opens a raw code view of the full command set, for advanced editing or copying between templates.

Step 7: Add a Section (Command Block)

Click + Add section to insert a command block. Available section types typically include:

• Backup › Running Configuration
• Backup › Startup Configuration
• Upload › Running Configuration
• Upload › Startup Configuration

Each section represents one operation, for example pulling the running configuration versus pushing a configuration file to the device.

Multiple sections can be added to a single protocol tab, for example both a Backup and an Upload section. Use the trash icon to delete a section.

Step 8: Save the Template

Review all fields for accuracy, then click Save to create the template, or Reset to clear the form and start over.

Best Practices

• Check the Global list first. Many common vendors and models already have a ready-made template.
• Clone a similar Global or Custom template instead of building from scratch when possible.
• Always populate SysObjectID Matches where possible, to enable automatic template assignment during discovery.
• Use View Source to copy command sets between similar templates quickly.
• Enable Read From Response only on sections meant to capture configuration data, such as Backup sections, not on upload or push commands.
• Keep the Description field detailed when multiple team members manage templates, to avoid duplicate or conflicting Custom templates.

Troubleshooting