Software image management and upgrade

Click theConfigure SFTP Server in the SWIMU app.

On the SFTP Servers configuration screen, click Add.

Enter the information:

Click Check Connectivity Status.

Click Save.

Select the target SFTP server and click Edit to modify SFTP server details.

1. Modify the details.

2. Click Check Connectivity Status.

3. Click Save.

Select the target SFTP server and click Delete to delete an SFTP server.

Create a nodes group

1. Click Backup, Restore and Group Management > Manage Groups > Create Group

2. Enter the Group Name and Description and click Save.

3. Select the nodes from the Nodes table.

4. Click Manage Groupsand click + next to the group name to add the nodes.

Select a node and use options Upload to Node or create On-Demand Backup or Manage Groups and Remove from Groups by clicking each one of them.

1. For scheduling the On-Demand Backup jobs. Click On-Demand Backup after selecting the nodes.

   This will schedule the on-demand jobs in the Backup -Jobs scheduler.

2. Click Remove from Groups after selecting the nodes that you want to remove from the group.

Click Jobs to view the job summary and scheduler panel.

1. Click Schedule Backup to schedule backup jobs.

   Enter the Job Name, SFTP Server, Groups, Start Date Time, Recurrence, and Description and click Schedule.

   Note

   Recurrence option allows you to repeat the job scheduling based on Hourly/Daily/Weekly/Monthly intervals. The scheduling can be done using the current time + five minutes after the first occurrence.

2. Click Edit to edit the schedule of the existing scheduled backup jobs.

3. Click Delete to delete the selected job from the backup scheduled job list.

4. Click Refresh to refresh the job scheduler table.

   Note

   You can track the status of each scheduled job in back up job list using the Status column in the table. The Status can be Not Started or In progress or Completed or Failed.

• If a backup or restore job fails, review the error message in the Jobs section.

• Ensure that the SFTP server is properly configured and accessible.

• Verify that the node is online and reachable.

Perform an On-demand backup.

1. Navigate to Backup and Restore > CONC Database Backup and Restore.

   

2. Click On-demand backup and confirm by clicking OK.

   Note

   You can perform up to 10 On-demand backups per day.

Download the database

1. Navigate to Backup and Restore > CONC Database Backup and Restore.

2. Select the backup you want to download from the table.

3. Click Download.

   Note

   Cisco Optical Network Controller does not allow manual deletion of backups. Backups older than the retention period are automatically deleted.

4. Enter a prefix string to be part of the downloaded file name and click OK.

   This prefix allows you to easily identify a backup file.

5. Access Cisco Optical Network Controller VM CLI using SSH.

6. Go to the path /data/local-path-provisioner/pvc-*conc-database-backup* to view the downloaded file.

Restore the database

1. Navigate to Backup and Restore > CONC Database Backup and Restore.

2. Select the backup you want to restore from the table.

3. Click Restore and confirm the operation.

Edit the backup configuration

1. Click Edit configuration.

2. Choose your Preferred Backup Time (UTC) and Recurrence preferences.

3. Choose Backup file retention time (weeks) and set Password to secure backup files.

   Cisco Optical Network Controller does not allow manual deletion of backups. Backups older than the retention period are automatically deleted.

4. Enable the check box if you want to Copy the backup files to SFTP server and enter the SFTP Server details.

   • SFTP Server Name: A descriptive name for the SFTP server.

   • IP Address: The IP address of the SFTP server.

   • Username: The username for accessing the SFTP server.

   • Password: The password for the specified username.

   • Remote Path: The directory path on the SFTP server where software images and backups will be stored.

   • Disk memory space utilisation threshold for file overwrite(%): The percentage of memory threshold allowed for each SFTP server. The minimum threshold value is 50. Anything exceeding the threshold will be cleaned up.

5. Click Apply.

Upload a downloaded backup file bundle to another Cisco Optical Network Controller instance.

tar -zvxf <downloaded_file_name>

printf "user_password" | od -A n -t x1 | tr -d ' \n' | awk '{printf "%-64s", $0}' | sed 's/ /0/g'

openssl enc -d -aes-256-ecb -in <encrypted_backup_file_name.tar.gz> -out <decrypted_backup_file_name.tar.gz> -K <key>

sedo backup upload <decrypted_backup_file_name.tar.gz>

1. Extract the downloaded backup bundle using the following command.

   Note

   This step is not required if your backup file is copied from the external SFTP server.

   This command extracts all the required delta and full backup files.

2. Run the following command to generate the decryption key using your password.

   Replace user_password with your actual password in the command.

   This command generates a 64-character key required for decryption.

3. Decrypt the backup file using the generated key using the following command.

   Replace the placeholders with actual file names and key.

   This command generates the decrypted backup file.

4. Upload the decrypted backup file to the Cisco Optical Network Controller server using the following sedo command.

Upload ISO Images to the Local SFTP Server.

sedo object-store list onc-sw-iso

sedo object-store put <file> <destination> [flags]

sedo object-store bucket delete onc-sw-iso/<file-name>

1. Verify File Availability: To check if a file is available on the local SFTP server, use the following command:

2. Upload an ISO Image: To upload an ISO image to the local SFTP server, use the following command:

   • <file>: The path to the ISO image file on your local system.

   • <destination>: The destination path on the SFTP server, including the bucket name and desired file name.

   Example: sedo object-store put <image-name.giso> onc-sw-iso/<image-name.giso>

3. Delete a File: To delete a file from the local SFTP server, use the following command:

   • <file-name>: The name of the file to delete.

   Example: sedo object-store bucket delete onc-sw-iso/test.iso

Create Image Distribution Groups.

1. Navigate to the Upgrade Orchestrator tab and select Node Software Upgrade > Software Image Distribution Groups

   

2. Click Actions and select Expand all to expand nodes in the table to view the subtended devices under the node.

3. Click Manage Groups and select New Group.

   You can also Mange groups from the topology view in the Upgrade Orchestrator.

4. Enter a Group Name and Description.

5. Select the nodes to include in the group and click Manage Groups.

6. Click the + icon next to a group name to add the nodes to the group.

7. Select a node and click Remove from groups to remove the node from the group it is a member of.

Create an Image Distribution Job.

1. Navigate to the Upgrade Orchestrator tab and select Node Software Upgrade > Image Distribution Jobs

2. Click Distribute Image.

3. Select the nodes or groups you want to distribute the images to.

   

   Table 5. Select node(s) or group(s) options

   UI options	Actions
   Copy only to COSM radio button	Copies the image to Cisco Optical Site Manager only Note COSM NCS 1000 Series: Image is copied to hosting device(s) automatically. COSM NCS 2000 Series: Image is copied to the COSM only.
   Copy to COSM and device(s) under node radio button	Copies images to Cisco Optical Site Manager and sub-tended devices.
   Group(s) or Node(s) search bar	Displays the list of node groups
   Back	Goes back to the Orchestrator Upgrade tab.
   Next	Moves to the next step.

4. Select an SFTP server from the drop-down list or give the details of the SFTP server.

5. Select the ISO image file to distribute.

6. Schedule the job to start immediately or later.

7. Click Schedule and choose a later time or schedule the job to run immediately.

8. Click the status for a device in the status column to view detailed status.

9. Select a job and click Stop to stop the job in the nodes in which the job has not started.

   The job continues on the nodes on which it was in progress.

10. Select a job and click Edit to make changes to the job.

    A job that is in progress cannot be edited.

11. Select a job and click Delete to delete a job that has completed or failed.

If a job status is PARTIAL, it means the job succeeded for some of the nodes, but failed for other nodes in the group of devices that the job was initiated for.

If a job fails, fix the issues in the failure status and click Re-Run.

Create Software Activation Groups.

1. Navigate to the Upgrade Orchestrator tab and select Node Software Upgrade > Software Activation Groups

   

   You can also Mange groups from the topology view in the Upgrade Orchestrator.

2. Click Actions and select Expand all to expand nodes in the table to view the individual devices.

3. Click Manage Groups and select New Group.

4. Enter a Group Name and Description.

5. Select the nodes or individual devices to include in the group and click Manage Groups.

6. Click the + icon next to a group name to add the nodes to the group.

7. Select a node and click Remove from groups to remove the node from the group it is a member of.

(Optional) Copy a group to Software Activation Groups from Software Image Distribution Groups.

1. Click Software Image Distribution Groups > Manage Groups

2. Click the copy button next to a group name.

3. Click Software Activation Groups > Manage Groups

4. Click Paste at the top right corner.

Create a Software Activation Job.

1. Navigate to the Upgrade Orchestrator tab and select Node Software Upgrade > Software Activation Jobs

2. Click Activate Software.

3. Select the target devices or groups.

   Table 6. Select Groups or Nodes or Devices options

   UI options	Actions
   Activate only COSM radio button	Activates only Cisco Optical Site Manager Note COSM NCS 1000 Series: This activation job automatically performs an upgrade of hosting device(s) as well. COSM NCS 2000 Series: Only COSM is activated.
   Activate both COSM and Device(s) radio button	Activates both Cisco Optical Site Manager and the selected subtended device(s). The activation job upgrades Cisco Optical Site Manager and selected subtended device(s). Note COSM NCS 1000 Series: The NCS 1000 hosting device(s) will be auto-selected if you have not selected the hosting device(s). COSM NCS 2000 Series: Activation of both Cisco Optical Site Manager and device(s) works based on the selected subtended device(s).
   Activate only Device(s)	Activates only the selected subtended device(s). The activation job upgrades the subtended device(s) software version. Note COSM NCS 1000 Series: The NCS 1000 hosting device(s) will be auto-selected if you have not selected the hosting device(s). COSM NCS 2000 Series: Activation of device(s) works based on the selected subtended device(s). If COSM is not upgraded to the same, this option first upgrades the COSM and then proceed with the subtended device(s).
   Group(s) or Node(s) or Device(s) search bar	Displays the list of nodes, devices and groups
   Back	Goes back to the Orchestrator Upgrade tab.
   Next	Moves to the next step.

   

   Note

   After you click Next, based on the selection of the radio button related to activation target, an Information message appears explaining the goal of the job.

   

   

   

4. Choose the software package from the drop-down.

5. Schedule the job to start immediately or later.

6. Click Schedule and choose a later time or schedule the job to run immediately.

7. Click the status for a device in the status column to view detailed status.

   Expand the jobs displayed in a hierarchical manner to find the device activation status for every node and respective subtended devices.

8. Select a job and click Stop to stop the job in the nodes in which the job has not started.

   The job continues on the nodes on which it was in progress.

9. Select a job and click Edit to make changes to the job.

   A job that is in progress cannot be edited.

10. Select a job and click Delete to delete a job that has completed or failed.

    Note

    The software activation jobs table has an additional column Type to inform about the Activation Type.

    

If a job status is PARTIAL, it means the job succeeded for some of the nodes, but failed for other nodes in the group of devices that the job was initiated for.

If a job fails, click Troubleshoot in the failure status to cross launch the site manager.

For NCS 2000 devices, the diagnostics page of site manager is launched. Use the logs to troubleshoot the failure.

For NCS 1000 devices, the devices tab is launched. Use the CLI to troubleshoot the failure.

Note

After troubleshooting the failure, click Re-Run.