Step 1

Capture a configuration database backup in the online mode.

1. Use this command to generate a config-db backup on demand:

   request nms configuration-db backup path <path_and_filename>

   The following example demonstrates how to back up the configuration database in the online mode.

   Device:~# request nms configuration-db backup path VM12_Leader_Online
                   Starting backup of configuration-db
                   config-db backup logs are available in /var/log/nms/neo4j-backup.log file
                   Successfully saved backup to /opt/data/backup/VM12_Leader_Online.tar.gz
                   sha256sum: 5c1b0db8518b29c99af856eca0e47f42b262ade13520fbebec7bb9224cebace6
                   Removing the temp staging dir :/opt/data/backup/staging
                   

Step 2

(Optional) View Backup Metadata Information

1. Extract the Contents of the Backup File:

   Use the following command to extract the contents of the .tar.gz file:

   tar -zxf VM12_Leader_Offline.tar.gz

2. View the Metadata Information:

   View the contents of the neo4j_backup_info.json file:

   vi neo4j_backup_info.json

    Note

   • The neo4j_backup_info.json file contains critical information (metadata) about the backup. Review this information carefully before proceeding with the restore process. The metadata includes details such as the backup ID, start time, end time, database version, and system information.

Step 1

From the SD-WAN Manager menu, choose Administration > Cluster Management .

Step 2

Click ... adjacent to the Cisco SD-WAN Manager server to configure and click Edit.

Step 3

In the Edit Manager dialog box, perform the following actions:

 Note

You cannot change the persona of a server. Therefore, the Node Persona options are disabled.

1. From the vManage IP Address drop-down list, choose an out-of-band static IP address to assign to the server.

2. In the Username field, enter the user name for logging in to the server.

3. In the Password field, enter the password for logging in to the server.

4. (Optional) From SD-WAN Manager 20.18.1, to enable Enable SD-AVC navigate to Administrator > Settings > SD-AVC and toggle the SD-AVC button, if you want Cisco Software-Defined Application Visibility and Control (SD-AVC) to run on the server.

   Cisco SD-AVC is a component of Cisco Application Visibility and Control (AVC). It can be enabled on one SD-WAN Manager server. The server on which it is enabled must have the Compute+Data or the Compute persona. Cisco SD-AVC cannot be enabled on a server that has the Data persona.

5. Click Add.

6. To confirm, click OK.

   The dialog box indicates that the services will restart, and that the existing metadata and other information that is not required when the server joins the cluster will be deleted from the server.

   When you click OK , the system starts the server add operation. The Cluster Management window displays the tasks that the system performs as it adds the server.

   As part of this operation, the system checks the compatibility of the server that you are adding. This check ensures that the server has sufficient disk space, and that the persona that you specified matches the persona of the node.

   After the server is added, the system performs a cluster sync operation, which rebalances the services in the cluster. Then the SD-WAN Manager servers in the cluster restart.

Step 1

From the SD-WAN Manager menu, choose Administration > Cluster Management.

Step 2

Click Add Manager .

The Add Manager dialog box opens.

 Note

If the Edit Manager dialog box opens, configure an out-of-band IP address for the server, as described in Configure the Cluster IP Address of a Cisco Catalyst SD-WAN Manager Server, and then repeat this procedure for adding a server.

Step 3

In the Add Manager dialog box, perform the following actions:

1. Click the Node Persona option ( Compute+Data , Compute , or Data ) that corresponds to the persona that has been configured for the server.

   You can determine the persona of a server by logging in to the server and looking at the persona display on the Administration > Cluster Management window. If you choose an incorrect persona, a message displays the persona that you must choose.

2. From the Manager IP Address drop-down list, choose the IP address of the server to be added to the cluster.

3. In the Username field, enter the user name for logging in to the server.

4. In the Password field, enter the password for logging in to the server.

5. (Optional) Enable Enable SD-AVC if you want Cisco Software-Defined Application Visibility and Control (SD-AVC) to run on the server.

6. Click Add .

7. To confirm, click OK .

   The dialog box indicates that the services will restart, and that the existing metadata and other information that is not required when the server joins the cluster will be deleted from the server.

   When you click OK , the system starts the server add operation. The Cluster Management window displays the tasks that the system performs as it adds the server.

   As part of this operation, the system checks the compatibility of the server that you are adding. This check ensures that the server has sufficient disk space, and that the persona that you specified matches the persona of the node.

   After the server is added, the system performs a cluster sync operation, which rebalances the services in the cluster. Then the SD-WAN Manager servers in the cluster restart.

Step 1

From the SD-WAN Manager menu, choose Administration > Cluster Management and click Service Configuration .

Step 2

Click the hostname of the SD-WAN Manager server.

Step 3

Click Cluster Management in the breadcrumb in the title bar to return to the Cluster Management window.

Step 1

From the SD-WAN Manager menu, choose Administration > Cluster Management and click Service Configuration .

Step 2

Click ... adjacent to the SD-WAN Manager server to edit, and click Edit .

Step 3

Select an IP address to edit.

Step 4

Enter the username and password, and edit parameters for the selected Cisco SD-WAN Manager server.

Step 5

Click Update .

Reset the user name and password for the configuration database on all the Cisco SD-WAN Manager servers using one of the following commands:

                
                  request nms configuration-db update-admin-user
                 
              

When prompted, enter your current username and password, and your new username and password.

When you run one of these commands, SD-WAN Manager restarts the application server.

 Note

• If you do not know the default credentials of the configuration database, contact your Cisco support representative to retrieve the credentials.
• You cannot use a previous username.
• Passwords can include only a mix of characters A to Z (upper or lowercase), digits 0 to 9, and special characters @, #, and *.

 Note

After a configuration database admin user update, if you are unable to view a specific SD-WAN Manager instance, use the request nms application-server restart command to restart the application server on that Cisco SD-WAN Manager instance again.

 Note

When using the request nms configuration-db update-admin-user command to update the admin user credentials, provide the same inputs (old username, password and the new username, password) across all the nodes in the SD-WAN Manager cluster. You must execute the request nms configuration-db update-admin-user command one node at a time. We recommend that you do not push the CLI to all the nodes at the same time because the NMS services will restart for the new configuration to take effect.

Step 1

On each Cisco SD-WAN Manager device, stop all the NMS services:

request nms all stop
          

Step 2

Verify that all the services have stopped. It is normal for the request nms all stop command to display a message about failing to stop a service if it takes too long. Use the following command to verify that everything is stopped before proceeding further:

request nms all status
          

Step 3

Start the Statistics database on each device that is configured to run it. Wait for the service to start each time before proceeding to the next SD-WAN Manager device.

request nms statistics-db start
          

Step 4

Verify that the service is started before proceeding to start it on the next SD-WAN Manager. After the service starts, perform step 3 to start the Statistics database on the next SD-WAN Manager device. After all the SD-WAN Manager devices have the Statistics database running, proceed to the next step.

request nms statistics-db status
          

Step 5

Start the Configuration database on each device that is configured to run it. Wait for the service to start each time before proceeding to the next SD-WAN Manager device.

request nms configuration-db start
          

Step 6

For releases earlier than Cisco vManage Release 20.3.1 , verify that the service has started before proceeding to start it on the next SD-WAN Manager device. Go to vshell and tail a log file to look for a message that the database is online. After confirming, go to step 5 to start the Configuration database on the next SD-WAN Manager device. After all the SD-WAN Manager devices have the Configuration database running, proceed to the next step.

tail -f -n 100 /var/log/nms/vmanage-neo4j-out.log
          

Step 7

Start the Coordination server on each device. Wait for the service to start each time before proceeding to the next SD-WAN Manager device.

request nms coordination-server start
          

Step 8

Verify that the service is started before proceeding to start it on the next SD-WAN Manager device. After verifying, go to step 7 to start the Coordination server on the next SD-WAN Manager device. After the Coordination server runs on all the SD-WAN Manager devices, proceed to the next step.

request nms coordination-server status
          

Step 9

Start the Messaging server on each device. Wait for the service to start each time before proceeding to the next SD-WAN Manager device.

request nms messaging-server start
          

Step 10

Verify that the service has started before proceeding to start the service on the next SD-WAN Manager device. After verifying, go to step 9 to start the Messaging server on the next SD-WAN Manager device. After the Messaging server runs on all the SD-WAN Manager devices, proceed to the next step.

request nms messaging-server status
          

Step 11

Start the Application server on each device. Wait for the service to start each time before proceeding to the next SD-WAN Manager device.

request nms application-server start
          

Step 12

For Cisco vManage Release 20.3.1 and later releases, start the server-proxy service on each SD-WAN Manager device:

request nms server-proxy start

Step 13

Restart the NMS cloud services on each device. Wait for the services to start each time before proceeding to the next Cisco SD-WAN Manager device.

request nms cloud-agent status

request nms cloud-agent-v2 status

Step 1

Take snapshots of all the SD-WAN Manager servers. Take a backup of the configuration database and save it in a location outside of the SD-WAN Manager server using the following command:

            request nms configuration-db backup path <path_and_filename>
          

Step 2

For upgrades from Cisco vManage Release 20.3.1 or later, copy the current image to each SD-WAN Manager server in the cluster and install the image on each SD-WAN Manager server by using the following command. Do not activate the image at this time.

request software install path 

 Note

The copy to SD-WAN Manager can be done using SCP using CLI using the VPN 512 interface.

Step 3

For upgrades from Cisco vManage Release 20.3.1 or later, activate the current image on each SD-WAN Manager server using the following command. All servers reboot simultaneously.

request software activate version 
          

Step 4

You must upgrade the configuration database when upgrading a cluster.

For more information about compatible upgrade path for configuration-DB upgrade, see Cisco Catalyst SD-WAN Upgrade Matrix.

 Note

• Starting from Cisco vManage Release 20.1.1, before upgrading the configuration database, ensure that you verify the database size. We recommend that the database size is less than or equal to 5 GB. To verify the database size, use the following diagnostic command:

  request nms configuration-db diagnostics

• When you upgrade the configuration database, ensure that you have activated the current image on each SD-WAN Manager server in the cluster as described in the previous step. In addition, ensure that all services except the application server and configuration-db services are running on these servers by entering the request nms all status command on each server.

Step 5

Enter your login credentials, if prompted. Login credentials are prompted in releases earlier than Cisco vManage Release 20.3.1 if all the SD-WAN Manager servers establish control connection with each other. After a successful upgrade, all the configuration database services are UP across the cluster, and the application server is started.

Step 1

From the Cisco SD-WAN Manager , choose Administration > Cluster Management and click Service Configuration.

Step 2

Click … adjacent to the Cisco SD-WAN Manager instance that you want to remove and click Remove .

Step 3

Enter the username and password to confirm the removal of the device from the network.

Step 4

Click Remove.