Submit a ticketCall us

Training ClassSign up for Network Performance Monitor (NPM) and Scalability instructor-led classes

Attend our instructor-led classes, provided by SolarWinds® Academy, to discuss the more advanced monitoring mechanisms available in NPM as well as how to tune your equipment to optimize its polling capabilities. NPM classes offered:
NPM Custom Monitoring and Polling
Orion Platform Scalability

Reserve your seat.

Home > Success Center > Network Configuration Manager (NCM) > NCM - Knowledgebase Articles > NCM Device Command Templates

NCM Device Command Templates

Updated December 31, 2018

Overview

This article provides an overview of device command templates and how to implement them in your NCM deployment.

Environment

  • NCM any version

    Different versions may implement different methodologies, as described in this article.

Detail

Most devices use separate commands to execute the same actions. A device command template provides NCM with a map to identify which commands should be used for each device type. You can create or modify your device command templates to add support for your devices.

Locate a device command template

Technically, SolarWinds Technical Support does not edit device command templates. However, you can write or edit a device command template.

If a specific template is not available, you can:

How NCM selects a device command template

NCM polls the device system object identifier (OID) using SNMP.

The device command templates are stored with the device model, and incorporate a partial or full or partial System OID in the filename, as show below.

system-oids.png

NCM 7.3.2 and older

If you are running NCM 7.3.2 and older, you can locate the System OID in the Device Details tab, as shown below.

The System OID for NCM 7.0 through NCM 7.3 may be in both the Orion Web Console and the currently-removed Win32 client. 

device-details2.png

NCM 7.4 and higher

If you are running NCM 7.4 or higher, you can locate the System OID under Node Details in the Node Details Summary page of the Orion Web Console. 

To access the Node Details Summary page, click Settings > Manage Nodes and then click a node.

node-details.png

In this example, the device System OID is 1.3.6.1.4.1.9.1.516. None of the device command templates match this OID exactly. However, the default Cisco IOS device command template uses a partial System OID, which is 1.3.6.1.4.1.9. This System OID will match the device System OID the closest, and will be used as the device command template.

Access a device template

See the section below that matches your NCM version.

NCM 7.7 and later

To access device templates follow steps below (NCM 7.7 and later):

  1. Log in to the Orion Web Console.
  2. Click Settings > All Settings.
  3. Under Node & Group Management, click Manage Device Templates.
  4. Click Generic and select Edit using the XML editor.

NCM 7.4 to NCM 7.6

To access device templates follow steps below (NCM 7.4 to NCM 7.6):

  1. Log in to the Orion Web Console
  2. Go to Settings > NCM Settings.
  3. In the Advanced section, go to Device Templates.

NCM 7.3.2 and lower

To access device templates follow steps below (NCM 7.3.2 and older):

  1. Log in to the Orion Platform server.
  2. Navigate to:
    C:\Program Files (x86)\SolarWinds\Orion\NCM\DeviceTypes\

Example actions and commands

Below are some example actions and commands you may see in a device command template. The NCM Administrator Guide provides additional details about the available variables.

Action
XML Name
Example command
(The XML name can be used as a macro in other commands)
Disable pagination RESET

terminal width 0

terminal length 0

Reboot the device Reboot reload noconfirm
Change to configuration mode EnterConfigMode config terminal
Exit from config mode ExitConfigMode quit
Specify the startup configuration Startup startup
Specify the running configuration Running running
Display a configuration on the terminal / telnet session DownloadConfig

show run

show start

show ${ConfigType}

Upload a configuration via telnet / ssh UploadConfig ${EnterConfigMode}${CRLF}${ConfigText}${CRLF}${ExitConfigMode}.
Download a configuration using TFTP DownloadConfigIndirect

copy ${TransferProtocol}://${StorageAddress}/${StorageFilename} $ConfigType} ${CRLF}

Erase a config EraseConfig write erase
Save a config to memory SaveConfig  

Example device template

Below is an example of a device template for a standard Cisco IOS device. 

<Configuration-Management Device="Cisco Devices" SystemOID=" 1.3.6.1.4.1.9">
<Commands>
<Command Name="RESET" Value="terminal width 0${CRLF}terminal length 0"/>
<Command Name="Reboot" Value="reload${CRLF}y${CRLF}y"/>
<Command Name="EnterConfigMode" Value="config terminal"/>
<Command Name="ExitConfigMode" Value="end"/>
<Command Name="Startup" Value="startup"/>
<Command Name="Running" Value="running"/>
<Command Name="DownloadConfig" Value="Show ${ConfigType}"/>
<Command Name="UploadConfig" Value="${EnterConfigMode}${CRLF}${ConfigText}${CRLF}${ExitConfigMode}"/>
<Command Name="DownloadConfigIndirect" Value="copy ${ConfigType} ${TransferProtocol}://${StorageAddress}/${StorageFilename}${CRLF}${CRLF}${CRLF}"/>
<Command Name="UploadConfigIndirect" Value="copy ${TransferProtocol}://${StorageAddress}/${StorageFilename} ${ConfigType}${CRLF}${CRLF}"/>
<Command Name="DownloadConfigIndirectSCP" Value="copy ${ConfigType} ${TransferProtocol}://${SCPServerUserName}@${SCPStorageAddress}/${StorageFilename}${CRLF}${CRLF}${CRLF}${CRLF}${SCPServerPassword}"/>
<Command Name="UploadConfigIndirectSCP" Value="copy ${TransferProtocol}://${SCPServerUserName}@${SCPStorageAddress}/${StorageFilename} ${ConfigType}${CRLF}${CRLF}${SCPServerPassword}"/>
<Command Name="EraseConfig" Value="write erase${CRLF}Y"/>
<Command Name="SaveConfig" Value="write memory"/>
<Command Name="Version" Value="show version"/>
</Commands>
</Configuration-Management>

Device communication process

The following maps describes the device communication process. 

device-communication-process2.png

 

connect-and-transfer2.png

 

 

Last modified

Tags

Classifications

Public