The node backup restores the appliance configuration, which allows the NSX Controller cluster to connect to it. You must restore a cluster backup before restoring a node backup. The node backup file that you choose should have the same timestamp as the cluster backup file.

About this task

Caution:

You must restore a cluster backup before you restore a node backup. When the node backup is restored, the controllers can now communicate with the NSX Manager, and they will update the realized network state to match the desired network state configured on the NSX Manager. If the cluster backup has not been restored, there is no desired network state configured and the current realized network state will be destroyed.

Prerequisites

Procedure

  1. Check the status of the NSX Manager is STABLE before restoring the backup.
    GET https://192.168.110.201/api/v1/cluster/status
    {
      "control_cluster_status" : {
        "status" : "NO_CONTROLLERS"
      },
      "mgmt_cluster_status" : {
        "online_nodes" : [ {
          "mgmt_cluster_listen_ip_address" : "192.168.110.201",
          "uuid" : "422E901F-B167-DA0A-951F-C0278CA8A4BA"
        } ],
        "status" : "STABLE"
      }
    }
    Note:

    The control cluster status is NO_CONTROLLERS because the control cluster will not connect to the NSX Manager until the node backup has been restored.

  2. Send a node backup restore API request, POST /api/v1/node/backups?action=restore, which copies the backup file from a remote location and restores it on the NSX Manager appliance. Specify the backup file and location information in the API request.
    Restore Request Fields:

    passphrase

    The passphrase specified when the backup was created. If you don't know this password, you cannot restore this backup.

    server

    The remote server where the backup files are stored.

    uri

    The backup file path on the remote server.

    ssh_fingerprint

    The SSH fingerprint of the remote server where the backup files are stored. See Find the SSH Fingerprint of a Remote Server.

    username

    The username used to log in to the remote server to copy the backup files.

    password

    The password used to log in to the remote server to copy the backup files.

    Example node backup restore request:

    POST https://192.168.110.201/api/v1/node/backups?action=restore
    
    {
        "restore_file": {
            "passphrase" : "7Taspa5anecR", 
            "file_store" : "remote", 
            "server" : "192.168.120.151", 
            "uri" : "/vol0/backups/backup-node-192.168.110.201-20160314.bak", 
            "protocol" : { 
                "name" : "scp", 
                "ssh_fingerprint" : "b508dfc65562e46e95707c25baf246f1", 
                "authentication_scheme" : { 
                    "scheme_name" : "password", 
                    "username" : "admin" , 
                    "password" : "4uhasWak" 
                } 
            } 
        } 
    }
    

What to do next

Download the backup and restore helper script.