topic Re: backup a device configuration automatically using Extreme Management Center by FTP in ExtremeCloud IQ- Site Engine Management Center

backup a device configuration automatically using Extreme Management Center by FTP

NachoCursos — Mon, 22 Mar 2021 17:31:00 GMT

Hello,How can I backup a device configuration automatically using Extreme Management Center via FTP?In other words, NetSight sends the configurations of the switches it has configured via FTP to a server.Thanks a lot.

Re: backup a device configuration automatically using Extreme Management Center by FTP

Tomasz — Mon, 22 Mar 2021 22:36:22 GMT

Hi,

I’d consider cron + some simple bash script running underneath XMC for doing this. Optionally, if you manage the XMC appliance itself, you can also schedule a task like that. Or, if you set an alarm reacting on a new log message saying that backups were taken, Ubuntu script could be executed as an alarm action.

Hope that helps,

Tomasz

Re: backup a device configuration automatically using Extreme Management Center by FTP

NachoCursos — Mon, 26 Apr 2021 13:16:10 GMT

Thank you very much, do you mean that I can do it through the XCM itself? how?

Re: backup a device configuration automatically using Extreme Management Center by FTP

Ed_McGuigan1 — Wed, 17 Nov 2021 22:06:33 GMT

It looks like there is the ability to set up some custom scripts for different device types in order to be able to download/upload both configuration and firmware.

If you right click on a device and then select the "Archive-->Inventory Settings" option you get a dialog as follows:

Here you can select the file transfer protocol:

You probably need to create a custom script that defines the commands that must be run on the device in order to initiate a download/upload. Here is a sample of some script for a Cisco device type:

-- Use these scripts to manage Cisco devices
name="Cisco Systems - TFTP"
desc="Cisco Systems 3750 SSH/TFTP Scripts"
protocol=TFTP
--
-----BEGIN SCRIPT "Configuration Upload"-----
enable
%ENABLEPSWD%
copy running-config tftp:
%TFTP_IP%
%RELATIVE_TARGET_FILE_PATH%
@receive 40
exit
-----END SCRIPT-----
-----BEGIN SUCCESS "Configuration Upload"-----
bytes copied
-----END SUCCESS-----
-----BEGIN SCRIPT "Configuration Download"-----
enable
%ENABLEPSWD%
copy %TFTP_URL% startup-config
startup-config
@receive 60
exit
-----END SCRIPT-----

I am looking at this right now and there are two things:

I don't know where these scripts are created or located ( guessing I may need to root around from the linux CLI )
I don't understand the syntax of the script

I will add more information if I get anywhere with this.

====

So it seems that the file location question is answered at the following URL - https://extremeportal.force.com/ExtrArticleDetail?an=000091050&q=What-directory-do-you-put-custom-device-type-scripts-Inventory-Manger

The actual file path is:
/usr/local/Extreme_Networks/NetSight/appdata/InventoryMgr/properties/devicefiles

In that directory you find a file "DeviceFamilyDefTemplate.txt" that describes the format of a device file ( in some detail ).
Note that there are no other files in the directory so I don't know where the files are for the existing devices ( like a Cisco router for example ). I copied and pasted the Cisco example from the web interface into a new file "myNewDeviceType" in the directory and replaced Cisco with Dell-EMC inside the file and then I got a new option showing up in the Web interface:

Re: backup a device configuration automatically using Extreme Management Center by FTP

Zdeněk_Pala — Thu, 18 Nov 2021 10:53:12 GMT

I believe GitHub is excellent resource for this discussion. There are working examples shared and also links to the documentation...

Re: backup a device configuration automatically using Extreme Management Center by FTP

Ed_McGuigan1 — Thu, 18 Nov 2021 20:36:54 GMT

Zdeněk Pala has been a great help here. There are quite a few sample scripts including the one that will do the job for me.

A couple of tidbits that might prevent confusion:

You cannot just use a copy command from a device to check that the transfer works.
XMC will not allow the file to be written under /tftpboot/configs/tmp so your attempt will fail.

The script that runs on XMC clearly takes care of making sure that the write is allowed before the transfer starts.
It also seems to process the file, placing it in the archives before deleting it.
Running "tcpdump -v port 69" in a console window for XMC can provide some debugging help as to what is happening.

Re: backup a device configuration automatically using Extreme Management Center by FTP

bar — Mon, 22 Nov 2021 16:16:50 GMT

I have the same problem.
I have an edited device file which uses tftp to copy a file. I can select it in the XMC gui and although I select TFTP as the file transfer method when I attempt to save the inventory settings I get the error "the selected script does not match the selected file transfer method"

Two things would very much help diagnosis:
is there any way I can see the output from the script as it is run?
is there any way I can see what the variables such as %RELATIVE_TARGET_FILE_PATH% are set to?

thanks.

Re: backup a device configuration automatically using Extreme Management Center by FTP

Zdeněk_Pala — Tue, 23 Nov 2021 00:19:17 GMT

The protocol defined in the script (e.g. TFTP) must match the protocol defined in the GUI. check screenshots in this thread.
There is a debug available => you will see all that is happening in the server log file.

Re: backup a device configuration automatically using Extreme Management Center by FTP

bar — Tue, 23 Nov 2021 14:29:33 GMT

Thanks Zdeněk Pala, the server diagnostics is very useful for this and many other things!

I'm still having problems with the error "the selected script does not match the selected file transfer method" though.
I must be missing something.

I think the script is only using tftp?:

-- Use these scripts to manage Dell Force 10 devices
name="Dell Force 10 - TFTP"
desc="Dell Force 10  TFTP Scripts"
protocol=TFTP
separator=UNIX_FILE_SEPARATOR
--
-----BEGIN SCRIPT "Configuration Upload"-----
enable
%ENABLEPSWD%
copy startup-config tftp://160.9.50.16/%RELATIVE_TARGET_FILE_PATH%
@key y
@receive 150
exit
-----END SCRIPT-----
-----BEGIN SUCCESS "Configuration Upload"-----
.*completed successfully
-----END SUCCESS-----
-----BEGIN SCRIPT "Configuration Download"-----
-----END SCRIPT-----
-----BEGIN SUCCESS "Configuration Download"-----
-----END SUCCESS-----

The File transfer method is set to TFTP, but I still get the error:

I have set the server logs to verbose for Inventory Manager and Inventory Manager Script, the script appears to run, but then it appears to run an unrelated script (Forti analyser script SCP)?:

....
2021-11-23 11:40:49,433 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyFileParser] ScriptTags
protocol=TFTP
name=Dell Force 10 - TFTP
separator=UNIX_FILE_SEPARATOR
desc=Dell Force 10 TFTP Scripts

2021-11-23 11:40:49,433 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyFileParser] -------Configuration Upload Script----------
enable
%ENABLEPSWD%
copy startup-config tftp://A.B.C.D/%RELATIVE_TARGET_FILE_PATH%
@key y
@receive 150
exit

2021-11-23 11:40:49,433 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyFileParser] -------End Script----------
2021-11-23 11:40:49,433 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyDefUtil] uses_tftp, ftp, scp, sftp: false : false : false : false
2021-11-23 11:40:49,433 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyFileParser] ScriptTags
protocol=TFTP
name=Dell Force 10 - TFTP
separator=UNIX_FILE_SEPARATOR
desc=Dell Force 10 TFTP Scripts

2021-11-23 11:40:49,433 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyFileParser] -------Configuration Download Script----------

2021-11-23 11:40:49,433 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyFileParser] -------End Script----------
2021-11-23 11:40:49,434 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyDefUtil] uses_tftp, ftp, scp, sftp: false : false : false : false
2021-11-23 11:40:49,434 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyFileParser] *** protocol is
2021-11-23 11:40:49,434 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyDefUtil] file loaded DellForce10.txt. Device Family File name is Dell Force 10 - TFTP
2021-11-23 11:40:49,434 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyFileParser] ScriptTags
name=Forti analyser Script scp
timed_reset_delay_format=HH:mm
separator=UNIX_FILE_SEPARATOR
desc=SSH/SCP Scripts

2021-11-23 11:40:49,434 DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyFileParser] -------Configuration Upload Script----------
execute backup all-s scp %RELATIVE_TARGET_FILE_PATH% A.B.C.D ####set up XMC user for scp?????
@receive 10
end

config vdom
....

I am really struggling to understand what is going on.

thanks,

Re: backup a device configuration automatically using Extreme Management Center by FTP

bar — Tue, 23 Nov 2021 15:40:21 GMT

I seem to have succeeded now in getting a device config. I'm not really sure how!

I tried to save the device "File transfer mode" as each different protocol, each time getting the same message.
Then when I went back to the original protocol (TFTP) it accepted it, and is now saving correctly.

As far as I can see the template file looks the same.
In the diagnostics I was getting the line:
DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyDefUtil] uses_tftp, ftp, scp, sftp: false : false : false : false
I am now getting:
DEBUG [com.ets.netsight.inv.scheduler.DeviceFamilyDefUtil] uses_tftp, ftp, scp, sftp: true : false : false : false

So not sure how this has changed.

Re: backup a device configuration automatically using Extreme Management Center by FTP

Zdeněk_Pala — Tue, 23 Nov 2021 15:49:15 GMT

Right-click on the device and "Rediscover" could help. the Rediscover action is being performed periodically...
Good luck.