Cisco Crosswork Network Controller 7.2.x Administration Guide

PDF

Cisco Crosswork Network Controller 7.2.x Administration Guide

Back up data using external NSO

Updated: August 14, 2026

Want to summarize with AI?

Log in

Create a backup of Crosswork data to a remote SCP server and optionally include the external NSO CDB for recovery purposes.

Create a backup of your Crosswork data, optionally including the NSO CDB, to a remote SCP server.

Backing up Crosswork and NSO data ensures you can recover configurations in case of system issues. NSO backups can be automated, but restoring the NSO CDB is a manual process. For restore instructions, see Restore data using an external NSO.

Before you begin

Ensure that you:

  • Install a compatible version of NSO in system default mode.

  • Install the latest version of the Crosswork Network Controller Transport SDN function pack using the NSO deployment manager window. For more information, see Install Cisco NSO Function Pack Bundles from Crosswork UI in the Cisco Crosswork Network Controller 7.2.x Installation Guide.

    • If you did not install the Transport SDN Function Pack using the NSO deployment manager window and instead installed it manually, you must manually copy the ncs_backup.sh script into the /var/opt/ncs/scripts folder. Otherwise, the backup operation will fail.

      1. Get the NCS run directory using the command: vi $NCS_DIR/../installdirs

        Example: NCS_RUN_DIR="/var/opt/ncs"

      2. Copy the scripts to the NCS run directory.

        
$ cd tsdn-<RELEASE-VERSION>-nso-<NSO-VERSION>/
$ sudo cp ncs_backup.sh <NCS_RUN_DIR>/scripts/
$ sudo cp ncs_restore.sh <NCS_RUN_DIR>/scripts/

        Example:

        $ sudo cp ncs_backup.sh /var/opt/ncs/scripts/
$ sudo cp ncs_restore.sh /var/opt/ncs/scripts/

  • Collect the hostname or IP address, port number, and file path for your SCP server.

  • Ensure you have SCP server credentials with read and write access to the backup folder.

  • Configure SSH as the connectivity protocol in the NSO provider, with an appropriate credential profile.

  • Ensure the user associated with the credential profile has sudo permissions and full access to /var/opt/ncs/backups/ on the NSO server.

  • See general backup guidelines in Back up data for additional requirements.

Note

If any prerequisite is not met, the backup job may fail.

Procedure

1.

Configure the SCP backup server.

  1. Go to Administration > Backup and Restore.

  2. Select Destination and enter the required backup server details.

  3. Click Save to confirm the configuration.
2.

Create a backup job for Crosswork and external NSO data.

  1. In Administration > Backup and Restore, select Actions > Backup.

  2. Enter a job name in the Job Name field.

  3. (Optional) Select Force to allow backup if there are application or microservice issues.

  4. Ensure Backup NSO is checked.

  5. Complete remaining fields as needed. To change the upload destination, edit the Destination settings.

  6. Click Start Backup to begin the operation.
3.

Monitor the backup job.

  1. View the job in the Backup Restore Job Sets table. Click on the job set to see status and details in the Job Details panel.

  2. If an upload to the SCP server fails, click Upload backup in the Job Details panel to retry. To change the destination, edit Destination settings before retrying.

A backup of Crosswork and (optionally) NSO data is created and stored on the SCP server. The job status and any errors are displayed in the Job Details panel.

What to do next