Submit a ticketCall us

Don’t fall victim to a ransomware attack
Backups are helpful, but sometimes that’s not enough to protect your business against ransomware. At our live webcast we will discuss how to protect against ransomware attacks with SolarWinds® Patch Manager and how to leverage log data to detect ransomware. Register now for our live webcast.

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

NCM Device Command Templates

Updated March 15th, 2016

Overview

Different devices use different command to execute the same actions. A device command template essentially provides a map for NCM to tell which commands should be used for each device type.

Environment

  • NCM any version (Different Versions may have different methodology as outlined below)

Detail

Does Support edit Device Command Templates?

Technically no; however, best effort can be provided with writing or editing a device command templates. If there is no specific template:

  • Check on the Content Exchange on Thwack for existing device command templates, as it may have been created already
  • Utilize the Template Builder utility, or refer to the Admin guide for details on how to manually create a device command template.
  • You can also log a feature request for the new template for that device to be created.
    Note: This may require you to provide a significant amount of information (i.e. sysObjectID, relevant commands, etc.) and the request does not guarantee that template will be created.

 

How does NCM tell which Device Command Template should be used?

NCM polls the device System OID via SNMP.

 

The Device Command Templates are stored with the Device Model, and either a partial or full SystemOID in the filename:

image2013-8-12 15-0-15.png

 

To choose a device command template, NCM must find the closest matching Device Command Template, using the SystemOID.Example Before NCM 7.4:

 

:

image2013-8-12 15-2-25.png

For NCM 7.4 and above the System OID can be found in the Node details in Orion. (NCM 7.0-NCM 7.3 may be in both the Web and the currently removed Win 32 client above)

 

This device's System OID is 1.3.6.1.4.1.9.1.516. From the list above, none of the device command templates match this OID exactly. However, the 'default' Cisco IOS device command template uses a partial SystemOID: 1.3.6.1.4.1.9. so this will match the device System OID the closest, and will be used as the device command template.

What Information do you see in a Device Command Template?

To access device templates follow steps below (NCM 7.4 and newer):

  1. Login to the Orion Web Console
  2. Go to Settings
  3. Go to NCM Settings
  4. Go to Device Templates (in Advanced section)

 

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

  1. Login to the Orion server
  2. Go to below (default) folder:

    C:\Program Files (x86)\SolarWinds\Orion\NCM\DeviceTypes\

 

Below are some example actions and commands you may see in a device command template. The NCM Admin Guide covers the available variables more thoroughly.

 

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 Command Template - Standard Cisco IOS Device Command Template
 
<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

image2013-8-12 14-4-52.pngimage2013-8-12 14-5-31.png

 

 

Last modified
11:18, 24 Mar 2017

Tags

Classifications

Public