Submit a ticketCall us

AnnouncementsCome see SolarWinds at VMUG Frankfurt

SolarWinds is delighted to attend the upcoming VMUG which will take place at Kap Europa in Frankfurt on June 19th, 2018.

See event details.

Home > Success Center > Network Configuration Manager (NCM) > F5 Big-IP .ucs binary configuration file backup

F5 Big-IP .ucs binary configuration file backup

Table of contents
Created by Ivan Zlatkov, last modified by Mariusz Handke on Jul 27, 2017

Views: 4,881 Votes: 2 Revisions: 17


This article describes the issue in backing up binary files in NCM as it is not supported. The Execute Script is used to initiate a backup to SCP server.

Note: NCM is unable to manage the files and it would only be used to initiate the file transfer to your SCP server.


NCM version 7.1 through NCM 7.4.x



NCM 7.5 and later has the ability to download binary files to a directory with a Template.


  1. Go to the Web Console and click CONFIGS.
  2. Click Configuration Management and choose Execute Script (you can also accomplish this by executing through scheduled job)
  3. Go to the Web Console and click CONFIGS. 
  4. Create a job. (Should be a Job specifically for "Execute Command Script")


In either case the script should be something similar to the following:

  • create a copy of UCS files as a file named DEVICE_DATE.ucs locally on device
  • use SCP to upload this file to the SFTP root on the NCM Server or SCP Server (depends on NCM configuration)


tmsh save /sys ucs ${SysName}_${Date}.ucs
scp /var/local/ucs/${SysName}_${Date}.ucs NSEuser@10.1.x.x:${SysName}_${Date}.ucs

Note: To copy content without line numbers, hover over the text and click the view source button (View Source). This opens a new window where you can select and copy text without any formatting or line numbering.



Since we are using a Delay command in the script, we need to ensure the timeouts set in NCM to make sure NCM will not drop connection before the desired delay has expired. Also the Protocol settings must be set to the same or greater as the delay (default delay in NCM for the Connection timeout is 45 seconds) 


From the Web Console:

Settings>NCM settings>Protocol Settings


Set the Telnet/SSH Connection Timeout to match or exceed the seconds for the Delay in the script.  In this case, it is 120 seconds




Last modified