Add Template

• Click on the (+) icon at the top right corner to add a Configuration Template.

• NCCM supports nine different types of Templates, and each type is used for specific requirements. They are:

  • Command Execution

  • Configuration Merge

  • Configuration Replace

  • Configuration Rollback

  • OS Image Upgrade

  • Network Task Automation

  • NETCONF Merge

  • NETCONF Replace

  • Network Diagnosis

  • HTTP REST-API Configuration

  • Golden Template

Command Execution

Command Execution is used to execute a series of commands (one by one) on devices, similar to the user executing commands through the Putty application for configuration changes. This template type should be used to change a small set of configurations that do not roll back to previous ones.

Click "Command Execution" and click "OK" to proceed further.

• Input the Template Name

  • The template Name should be unique.

• Select the Template Group using the dropdown menu.

• Select Vendor using the dropdown menu.

  • This is mandatory since Template commands are specific to vendor devices.

• Select the OS Type

  • This is mandatory since Template commands are specific to vendor device OS types. If commands are executable on all vendor devices, then input as ALL TYPE.

• Input the Model details.

• Input the Series details.

• Approval Required Checkbox is mandatory, and the user cannot uncheck it. (This is a compliance requirement).

• Input the Template Description.

Click the "Template Configuration" panel.

• Select the Configuration Type or Store using the dropdown menu.

  • Supported Types are Startup, Running, and Candidate.

  • This value does not impact the operation but acts as a label for the configuration type that must be changed.

• Click or to load configuration

  • Users can load configurations from existing downloaded versions or the configuration commands from a text file.

  • After loading the configuration commands, the user has to make device-specific changes and create variables to be filled by NCCM during device execution.

Click the "Access Control" panel

• Select the visibility

Note: If the visibility is “Private,” the User and User group dropdown will be enabled, and the selected user and administrator will only be able to manage this template.

• Select the User(s).

• Select the User group(s).

• Click "Save" to save the template with a given input.

• Click "Cancel" to abort the Template creation.

Example for Command Execution:

<command prompt=”#”>conf t</command>
<command prompt=”#”>hostname {{Rumtime.xxxx}} </command>

Configuration Merge

Configuration Merge uploads or merges a command block into a Device. This type should be used to create or merge a configuration block into a device.

Click "Configuration Merge" and click "OK" to proceed further.

• Input the “Configurations to Merge” by directly typing or ‘Loading from Snapshot’ or a file.

• Input the “CLI Commands to Merge.” The CLI Commands will merge the new Configurations into Device Configuration.

Example Commands to Merge:

<command prompt="\]\?">copy tftp: running-config</command>
<command prompt="\]\?">{{Global.managementIP}}</command>
<command prompt="\]\?">{{Job.uploadfilename}}</command>
<command previous_match="confirm\]" prompt="#"    
timeout="300">yes</command>
<command    action="exit" prompt="">exit</command>

Note: NCCM will auto-fill the “Configurations to merge commands” into the Job object upload filename variable. The rest of the inputs are similar to “Add Command Execution.”

Configuration Replace

Configuration Replace is used to replace a full configuration into a device. This should replace default or configuration discrepancies with backed-up configuration versions.

Click "Configuration Replace" and click "OK" to proceed further.

• Input the “Configurations to Replace” by directly typing or Loading from Snapshot or a file.

• Input the “CLI Commands to Replace”. The CLI Commands will replace the new full Configurations with Device Configuration.

Example Commands to Replace:

<command    prompt="[\],#]"    timeout="300">configure    replace    
tftp://{{Global.managementIP}}/{{Job.uploadfilename}}</command>
<command    previous    match="confirm\]"    prompt="#"    
timeout="300">y</command>
<command    action="exit"    prompt="">exit</command>

Note: NCCM will auto-fill the “Configurations to Replace commands” into the Job object upload filename variable.

The rest of the inputs are similar to “Add Command Execution.”

Configuration Rollback

Configuration Rollback template will Roll the device configuration back to its previous configuration version.

Click "Configuration Rollback" and click "OK" to proceed further

• Input the “Configurations to Replace” by loading either from Snapshot or from a file.

• Input the “CLI Commands to Rollback.” The CLI Commands will roll the Device Configuration back to the uploading Configuration version.

Example Commands to Rollback:

          <command    prompt="[\],#]" timeout="300">configure replace    
           tftp://{{Global.managementIP}}/{{Job.uploadfilename}}</command>
          <command    previous_match="confirm\]" prompt="#"    
           timeout="300">y</command>
          <command    action="exit"    prompt="">exit</command>

Note: NCCM will auto-fill the “Configurations to Rollback commands” into the Job object upload filename variable.

• Users can also Input the following TAGS in “CLI Commands to Rollback” rather than filling in the actual Configuration.

BASELINE-STARTUP-CONFIGURATION

NCCM will roll back the Baseline Startup configuration of the corresponding device.

PREVIOUS-STARTUP-CONFIGURATION

NCCM will roll back the previous startup configuration of the corresponding device.

BASELINE-RUNNING-CONFIGURATION

NCCM will roll back the baseline running configuration of the corresponding device.

PREVIOUS-RUNNING-CONFIGURATION

NCCM will roll back the previous running configuration for the corresponding device.

Note: Tags will be used while Replacing Configurations on multiple devices simultaneously. The rest of the inputs are similar to “Add Command Execution.”

Note: Before creating a “Roll Back upload job” or “Auto creation of Rollback Job” from Upload Job Task Result, Configuration Replace templates should be created in NCCM for each vendor & OS Type, and the Template should follow naming standards.

The name of the Replace Template should be

• “Configuration Rollback To Base - <Vendor><OS type>”

• “Configuration Rollback To Previous - <Vendor><OS type>”

Example for CISCO IOS

Configuration Rollback to Base - Cisco-IOS

Configuration Rollback to Previous - Cisco-IOS

Example for CISCO NXOS

Configuration Rollback to Base – Cisco - NXOS

Configuration Rollback to Previous – Cisco - NXOS

Example for CISCO, any OS type

Configuration Rollback to Base – Cisco - ANY Type

Configuration Rollback to Previous – Cisco - ANY Type

OS image Upgrade

OS Image upgrade is used to upgrade the OS Image or OS Patch update into the device.

Click "OS Image Upgrade" and "OK" to proceed.

• Input the CLI commands for OS Upgrade specific to Device OS.

Example for Cisco IOS Upgrade:

# Make Terminal Len 0

<command    prompt="#"    timeout="60">term    len    0</command>

#Copy the Image to Flash

<command    prompt="]\?"    timeout="60">copy    tftp    flash0:</command>

#Input the TFTP Server IP

<command    prompt="]\?"    timeout="60">{{Global.managementIP}}</command>

#Input the Source OS Image

<command    prompt="]\?"    timeout="60">{{Runtime.osimagename}}</command>

#Destination OS Image as Enter

<command     prompt="[#,     confirm]"     timeout="600"    
error_pattern="Error">CRLF</command>

#Overwrite the OLD OS

<command     prompt="[#, confirm]" timeout="600" previous_match="confirm"    
error_pattern="Error">y</command>

#For Erase Confirmation due to size

<command     prompt="[#,     confirm]"     timeout="600"     previous_match="confirm"    
error_pattern="Error">{{Runtime.erase_flash_when_low_memory}}</command>

#For Erase Double Confirmation due to size

<command     prompt="#"     timeout="600"     previous_match="confirm"    
error_pattern="Error">{{Runtime.erase_flash_when_low_memory}}</command>

#File Copied or not check

<command     prompt="#"     timeout="60"     error_pattern="Error"     >dir    
flash0:{{Runtime.osimagename}}</command>

#Do boot sequence

<command    prompt="#"    timeout="60">conf    t</command>

#no boot system

<command    prompt="#"    timeout="60">no    boot    system</command>

#Boot from new OS Image

<command     prompt="#"     timeout="60">boot     system    
flash0:{{Runtime.osimagename}}</command>

#Change Register to config-register 0x2102

<command    prompt="#"    timeout="60">config-register    0x2102</command>

#Exit out of Conf t

<command    prompt="#"    timeout="60">exit</command>

#Copy Running to Start

<command    prompt="[#,]\?]"    timeout="60">copy    run    start</command>

#Confirmation

<command    prompt="#"    timeout="60"    previous_match="config">CRLF</command>

#Reload

<command    prompt="]"    timeout="60">reload</command>

#Send No for Saving System Configuration

<command    prompt="]"    timeout="120"    previous_match="yes">no</command>

#Reload Confirmation

<command     prompt="[]"     action="exit"     timeout="30"    
previous_match="confirm">y</command>

Note:

1. NCCM supports md5 checksum and Activation Key for Cisco IOS Upgrade in command template variable substitution and check constraint check.

2. For other vendors and Cisco's other OS Types, the OS Upgrade template should be built per vendor command standard.

3. Before creating an “OS Image Roll Back Upload Job” automatically from the OS Upload Job Task Result, OS Upgrade templates should be created in NCCM for each vendor & OS Type, and Templates should follow naming standards. The name of the Template should be

“OS Image Upgrade - <Vendor> <OS type>”

Example for CISCO IOS

OS Image Upgrade - Cisco-IOS

Example for CISCO NXOS

OS Image Upgrade - Cisco-NXOS

The rest of the inputs are similar to “Add Command Execution”.

Network Task Automation

Network Task Automation is similar to a Command Execution Template, which executes a series of commands individually.

This template should be used for Network Automation tasks like Health Checks, Trace Routes, Backing up important data, and finding device service configurations like “SNMP Status, BGP Status, SSH Status, and TFTP reachability” regularly.

Click "Network Task Automation" and "OK" to proceed.

The rest of the inputs are similar to “Add Command Execution.”

Example:

If we must check important application servers' availability from the core router daily, write the below command in the template.

<command    prompt=”#”    timeout=30>ping    192.168.50.235</command>

NETCONF Merge

NETCONF merge is used to merge the given configurations into existing device configurations (Applicable only for NETCONF protocol-supporting devices).

Click "NETCONF Merge" and click the "OK" button to proceed.

• Input the Netconf Merge Commands in NetCONF XML protocol format. The rest of the inputs are similar to “Add Command Execution.”

NETCONF Replace

Replace full configuration with existing device configuration (Applicable only for NETCONF protocol-supporting devices).

Click "NETCONF REPLACE" and click "OK" to proceed further.

• Input the Netconf Replace Commands in NetCONF XML protocol format.

The rest of the inputs are similar to “Add Command Execution.”

Network Diagnosis

This is similar to the Command Execution Template, which executes a series of commands individually. This template should only be used for network diagnosis tasks like a health check and traceroute and for finding device service configurations like “SNMP Status, BGP Status, SSH Status” on an ad-hoc basis.

Click "Network Diagnosis" and click "OK" to proceed further.

• Input the Commands for Diagnosis.

The rest of the inputs are similar to “Add Command Execution.”

Note: Service engineers will use the Network Diagnosis Template in the “Network Diagnosis feature.”

HTTP REST-API Configuration

This option performs Network and service configurations through HTTP (REST) API. Executing a configuration change takes HTTP(S) URL, Headers, Forms, or RAW JSON content.

Click "HTTP REST-API Configuration" and "OK" to proceed.

• Input the Template Name

  • The template Name must be unique.

• Select the Template Group using the dropdown menu.

• Select Vendor using the dropdown menu.

  • This is mandatory since Template commands are specific to vendor devices.

• Select the OS Type

  • This is mandatory since Template commands are specific to vendor device OS types. If commands are executable on all vendor devices, input them as ALL TYPE.

• Input the Model details.

• Input the Series details.

• Approval Required Checkbox is mandatory, and the user cannot uncheck it. (This is a compliance requirement).

• Input the Template Description.

Click the "Template Configuration" panel.

• Select the Configuration Type or Store using the dropdown menu.

  • Supported Types are Startup, Running, and Candidate.

  • This value does not impact the operation but acts as a label for the configuration type that must be changed.

  • Select Method (POST. GET, PUT, DELETE, PATCH) and provide the URL.

  • Input Parameters and Headers in the respective text boxes.

  • Select Body type and RAW type using the dropdown menu.

  • Input Body (commands), Success code, Pattern, and Configuration Trigger in the respective text boxes.

Click the "Access Control" panel.

• Select the visibility

Note: If the visibility is “Private,” the User and User group dropdown will be enabled, and the selected user and administrator will only be able to manage this template.

• Select the User(s).

• Select the User group(s).

• Click to save the template with a given input.

Golden Template

This feature will identify the missing and additional configurations across the devices based on a standard template defined by the organization.

Note: This is just a placeholder to save the Golden Template commands and not to be used to execute.

Click "Golden Template" and click "OK" to proceed further.

• Input the Template Name

  • Template Name must be unique.

• Select the Template Group using the dropdown menu.

• Select Vendor using the dropdown menu.

  • This is mandatory since Template commands are specific to vendor devices.

• Select the OS Type

  • This is mandatory since Template commands are specific to vendor device OS types. If commands are executable on all vendor devices, input them as ALL TYPE.

• Input the Model details.

• Input the Series details.

• Approval Required Checkbox is mandatory, and the user cannot uncheck it. (This is a compliance requirement).

• Input the Template Description.

Click the "Template Configuration" panel

• Select the Configuration Type or Store using the dropdown menu.

  • Supported Types are Startup, Running, Candidate, and all. and Candidate or all..

  • This value does not impact the operation but acts as a label for the configuration type that must be changed.

• Click to load the configuration

  • The user can load configurations from the existing downloaded version or load the configuration commands from a text file.

  • After loading the configuration commands, the user has to make device-specific changes and create variables to be filled by NCCM during device execution.

Click the "Access Control" panel

• Select the visibility

Note: If the visibility is “Private,” the User and User group dropdown will be enabled, and the selected user and administrator will only be able to manage this template.

• Select the User(s).

• Select the User group(s).

• Click "Save" to save the template with the given input.