NCM Script for doing backup on multi devices

I have been looking a lot on the thwack forum etc, but are not able to find a script that can do this for me.

I need a script that can do the following command for me

copy running-config tiptomytftpserver/.../nameofthedevice (Tftp server is not SW)

I have serval devices and instead of doing this on single device, I want to this on all at once.

I can login to a device and do the command.

Can this be done??

Hope someone can help me

Find more posts tagged with

ncm 7.4.1

config backup

ncm scripts

Accepted answers

christopher.a.thornton

Sure. When you upload the file I assume you want to save it as something different than the running-config or startup-config correct? The below will have you specify the source file name, destination file name, TFTP Server, and directory where the configs are.

.CHANGE_TEMPLATE_DESCRIPTION

Copy config to TFTP Server.

.PLATFORM_DESCRIPTION

Created for Cisco IOS devices.

.PARAMETER_LABEL @ContextNode

NCM Node

.PARAMETER_DESCRIPTION @ContextNode

The node the template will operate on. All templates require this by default. The target node is selected during the first part of the wizard so it will not be available for selection when defining values of variables.

.PARAMETER_LABEL @TFTP

TFTP Server:

.PARAMETER_DESCRIPTION @TFTP

The IP Address or hostname of your TFTP Server.

.PARAMETER_LABEL @DIRECTORY

Config Dir:

.PARAMETER_DESCRIPTION @DIRECTORY

The root directory under the TFTP server where all configs are stored.

.PARAMETER_LABEL @SOURCE

Source File Name:

.PARAMETER_DESCRIPTION @SOURCE

Enter the name of the file on the TFTP Server.

.PARAMETER_LABEL @DESTINATION

Destination File Name:

.PARAMETER_DESCRIPTION @DESTINATION

Enter the name of the file on the network device.

script BaseChangeTemplate(

NCM.Nodes @ContextNode,

string @TFTP,

string @DIRECTORY,

string @SOURCE,

string @DESTINATION

)

{

string @sourcepath = 'tftp://'+ @TFTP + '/' + @DIRECTORY + '/' + @SOURCE

string @destinationpath = 'flash:' + @DESTINATION

string @path = @sourcepath + ' ' + @destinationpath

CLI

{

copy @path

@DESTINATION

}

All comments

rschroeder

You've picked an easy challenge--one that can be completed successfully with a new NCM scripted Job, or even with an NCM Compliance Report with remediation.

Let's do the simplest and start with your script deployed against multiple devices manually through NCM:

Start up NCM
Go to Configuration Management
Select the devices you want to run your script against
Click Execute Script

5. Key in the exact command in the Execute Script window--just as if you were at the command line on the device, and then click Execute in the lower right corner.

6. If you like your script, you can click the Save Script box; you'll be able to use it over and over.

7. Verify your script worked by going to the Transfer /Status window in NCM. Click on the "Show script results" on the far right for each device to see the outcome of your command.

If you want to do this over and over on an automated and scheduled basis, go to NCM's Configs / Jobs view and Create New Job doing the same steps.

Easy!

Remember that NCM is designed to automatically do backups, and on a scheduled basis. You've probably got NCM backing up everything on a nightly basis, and generating a daily Config Change Report. That means your config files are already on your NCM server--and you probably have a job (or your should set one up) to archive those configs off of your NCM server.

You can browse to those files and manipulate and copy them or move them in your server environment, as needed.

Swift Packets!

Rick Schroeder

osberg

Hi Rick,

Yes but I cannot just write nameofthedevice I need to specify the name on every line I put in if I need to this on serval devices??

I mean here I cannot chose 10 devices and put in the line in the script: copy running-config tftp://iptomytftpserver/config/nameofthedevice

rschroeder

Osberg, are you concerned that you'll have over-written configs if you don't define a unique name? If so, would it be acceptable to use NCM to automatically copy the configs to NCM's drive space? They'll each be in a unique folder that is named for each device.

It's thinking out of the box by using this slightly different process, but you'll end up with the files you want, each in a unique folder named for their devices.

christopher.a.thornton

I have a few questions for you really quick, but I have an idea that may work via a compliance check.

What type of devices are these (Cisco, Juniper, etc)?

Do you already have the folder structure in place and do the folder names exactly match the hostname of the device?

jkrenzien

You could use a config change template. The one below should be close to working, though you may have to put the command into a string using simple string manipulations. Using a template could allow you do choose the transfer type, file to be copied, destination, and just about anything else you can set as a variable or a node custom property. Please verify this template before using as I am currently unable to test it myself, but it was built off a template baseline file I have.

.CHANGE_TEMPLATE_DESCRIPTION

Copy config to TFTP.

.PLATFORM_DESCRIPTION

Created for Cisco IOS devices.

.PARAMETER_LABEL @ContextNode

NCM Node

.PARAMETER_DESCRIPTION @ContextNode

.PARAMETER_LABEL @TFTP

TFTP server address

.PARAMETER_DESCRIPTION @TFTP

Describe this variable and add any input guidelines here.

script BaseChangeTemplate(

NCM.Nodes @ContextNode,

string @TFTP,

)

{

CLI

{

copy running-config tftp://@TFTP/DesiredDirectory/@ContextNode

}

christopher.a.thornton

Actually the method that jkrenzien posted is a better way of doing it.

osberg

jkrenzien I see your point here, but I am running into some issues here.

when I try to do it i am getting this error:

Error:Variable @TFTP/@DIRECTORY/@ContextNode could not be matched. Possible causes of this are:

1) It has not been declared.

2) You are referencing an entity property which does not exist.

3) You are missing a closing bracket in a prior native block.

Here is the script I am using

.CHANGE_TEMPLATE_DESCRIPTION

Copy config to TFTP.

.PLATFORM_DESCRIPTION

Created for Cisco IOS devices.

.PARAMETER_LABEL @ContextNode

NCM Node

.PARAMETER_DESCRIPTION @ContextNode

.PARAMETER_LABEL @TFTP

TFTP Server:

.PARAMETER DESCRIPTION @DIRECTORY

Config Dir:

.PARAMETER_DESCRIPTION @TFTP

Describe this variable and add any input guidelines here.

script BaseChangeTemplate(

NCM.Nodes @ContextNode,

string @TFTP,

string @DIRECTORY

)

{

CLI

{

copy running-config tftp://@TFTP/@DIRECTORY/@ContextNode

}

I am trying to put the directory in also just in case we want to use another dir here.

But what are I am doing wrong here??

GoldTipu

Try this below.

script BaseChangeTemplate(

NCM.Nodes @ContextNode,

string @TFTP,

string @DIRECTORY

)

{

string @path = 'tftp://'+ @TFTP + '/' + @DIRECTORY + '/' + @ContextNode.NodeCaption

CLI

{

copy running-config @path

}

osberg

We are getting there

This is the output: copy running-config tftp://10.5.0.251/config/DKF27C3560G-Tek01

But the switch dont execute the commands, so the file is not coming up on the tftp server.

when I do it on the switch I need to press enter 3 times, as you can see here

DKF27C3560G-Tek01#copy running-config tftp://10.5.0.251/config/DKF27C3560G-Tek01

Address or name of remote host [10.5.0.251]?

Destination filename [config/DKF27C3560G-Tek01]?

How can we fix this??

osberg

I am also trying to make some modification to the script so that I can run a backup of my ASA firewall.

When I login to the device the command to bakcup the devices is like this : write net 10.5.0.251:/ASA/PL340ASA

My scripts is like this, but not working:

script BaseChangeTemplate(

NCM.Nodes @ContextNode,

string @TFTP,

string @DIRECTORY

)

{

string @path = @TFTP + ':/' + @DIRECTORY + '/' + @filename

string @filename = @ContextNode.NodeCaption

CLI

{

write net @path

@TFTP

@filename

}

What are I doing wrong here??

david.ola

This is really great. You are wonderful

christopher.a.thornton

Most programming language will run sequentially so it could be that you are using @filename before you actually declare what @filename is. Can you try and put the string@filename = @ContextNode.NodeCaption before the string @path = @TFTP + ':/' + @DIRECTORY + '/' + @filename. That may alleviate the issue that you are having. If that does not work get the output from the upload to give me a better idea of what is going on.

osberg

The scripts work ok more or less... If you look here, you can see that I is trying to do something more that it dont like

write net 10.5.0.251:/ASA/PL340ASA-VPN

10.5.0.251

PL340ASA-VPN

it should only use the top line and the extra....

write net 10.5.0.251:/ASA/PL340ASA-VPN

Building configuration...

INFO: Default tftp-server not set, using highest security interface

Cryptochecksum: d68e36fd cf6e0bad 62e2ac89 7acd6428

[OK]

10.5.0.251

ERROR: % Invalid input detected at '^' marker.

PL340ASA-VPN

ERROR: % Invalid input detected at '^' marker.

christopher.a.thornton

Ah ok I see what it's doing now. Take out the @TFTP and @filename in the CLI portion and that will remove the lines that it is adding in while running. Give that a shot and see if that works for you.