H17869 VCSA and PCS File-Based Backup Restore 4.5
H17869 VCSA and PCS File-Based Backup Restore 4.5
Abstract
This document describes the procedures for the file-based
backup and restore of VxRail vCenter Server Appliance
(vCSA) and Platform Services Controller (PSC) in VxRail v4.5.
July 2019
H17869
Use, copying, and distribution of any software described in this publication requires an applicable software license.
Copyright © 2017-2019 Dell Inc. or its subsidiaries. All Rights Reserved. Dell, EMC, Dell EMC and other trademarks are trademarks
of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective owners. [7/29/2019]
Intended Audience
This document is intended for customers and Dell EMC service providers who are authorized to work on a VxRail
cluster and VxRail administrators.
Backup Overview
The file-based backup feature requires no quiescing or downtime of the selected appliance because the backup can
be performed while the appliance is running. Furthermore, it does not require any agents; the backup can be started
directly from the VAMI accessed using the FQDN or the IP address of the appliance at port 5480. From there, a
wizard guides you through the backup process. You first select the protocol that you have already configured.
VMware supports FTP, FTPS, HTTP, HTTPS and SCP protocols. You then specify the location where the backup will
live and enter the username and password of the backup location. Optionally, you can encrypt the backup by using
the AES 256, in which case you will be prompted for a password. This encryption password is not stored, and if lost,
there is no way to recover the backup files. Therefore, this password must be stored in a safe location. By default,
only the configuration and inventory data are backed up, but you can choose whether to include the historical and
performance data in the backup. In the event of a disaster, the backup is used to recover the appliance.
If the validation passes, you will move to the next step in the Backup Appliance wizard where you select the
files you want to backup. By default, the inventory and configuration data of the vCSA are backed up. There is
also the option of backing up the historical and performance data of the vCSA. Keep in mind that selecting this
option could increase the backup time of the vCSA. The PSC will not have this option because all historical
and performance data is kept in the vCSA database. You can optionally provide a description for your backup
in the next screen. Click Next to proceed.
The following figure from a PSC backup workflow shows that unlike vCSA, the PSC does not have the option
of backing up the historical and performance data.
The backup files are then streamed to the backup target using the selected protocol. The backup process will
produce a set of files for the designated appliance.
When the backup workflow completes successfully, the files become visible at the backup target. The backup
workflow is nearly identical for vCSA and PSC. The following illustration shows the files at the backup target for
both types of appliances.
Overview
You can perform a file-based restore of an appliance that has previously been backed up using the Virtual Appliance
Management Interface (VAMI). You can perform such a restore operation using the vCSA-UI installer. You can mount
the ISO of the vCSA from which you deployed and click the Restore button right from the installer. You must use the
specific vCSA installer ISO, matching the vCSA version which was backed up (e.g., VMware-VCSA-all-6.5.0-
7515524.iso). The Installer will then do a two-stage deployment: Stage 1 deploys the appliance, and Stage 2
configures and restores from the backup selected.
Restore Procedure
Primary Node Configuration Prior to Restore Operation
Before starting the restore operation, some prerequisite steps must be performed. In particular, the file-based restore
operation requires a vSphere Standard Switch (vSwitch) or an ephemeral portgroup. By default, VxRail 4.5 with vCSA
and PSC does not use a vSphere Standard Switch (VSS). You must create a temporary VSS on the primary node and
take vmnic1 out of the default Distributed Virtual Switch (DVS) before performing the restore operation. Generally, we
can regard the first node as the primary-node. Even when VxRail vCSA and PSC are unavailable, the primary-node
can still be accessed through its management IP because DVS configuration still works for the nodes.
Perform the following steps to prepare the system for the actual restore operation:
In the sample command output, {DVS name is VMware HCIA Distributed Switch} and {vmnic1 DVPort ID is 7}.
Having acquired the vmnic1 DVPort ID, run these commands to remove the vmnic1 from the DVS and to
confirm that it was successfully removed:
After confirming that the vmnic1 was removed from the DVS, run these commands to create a temporary VSS
and a portgroup with the vmnic1:
esxcli network vswitch standard add –v tempswitch
esxcli network vswitch standard uplink add –u vmnic1 –v tempswitch
esxcli network vswitch standard portgroup add –p tempportgroup –v tempswitch
In the vCSA installer, navigate to the vcsa-ui-installer directory, and then to the subdirectory for your operating
system, and run the installer.
• For Windows OS, go to the win32 subdirectory, and run the installer.exe file.
• For Linux OS, go to the lin64 subdirectory, and run the installer file.
• For Mac OS, go to the mac subdirectory, and run the Installer.app file.
Restoring the appliance from backup is a two-stage process. The first stage is deploying a new appliance to the
target ESXi host (i.e., the primary-node). The second stage transfers data from the backup to the deployed
appliance. Click Next to proceed with Stage 1.
Accept the End User License Agreement (EULA) and click Next.
Review your backup information and click Next to proceed with the restore.
Depending on the backup metadata, available deployment sizes are listed. If there are choices, select one. For
PSC, typically, there is no choice. Click Next to continue.
In the Configure network settings step, configure the network settings for the appliance VM. Select the
tempportgroup created earlier. Note that the file-based restore procedure is for failed VxRail VCSA or PSC only.
Do not make changes to the IP address, subnet mask, gateway and DNS in this step. If the IP address is
changed, you will have to fix the VxRail Manager configuration after the restore. Refer to Change the Internal
vCSA Virtual Machine IP Address or Change the Internal PSC Virtual Machine IP Address procedures in SolVe.
The appliance deployment is initiated. Observe the progress of the deployment process until it successfully
completes. The completion of the deployment marks the end of the Stage 1 of the restore process. Click
Continue to proceed to Stage 2.
When the Stage 1 completes, the installer prompts for the Stage 2, which will copy the data from the backup
location to this appliance and then complete the setup. In the Introduction step, click Next to proceed with Stage
2.
In the Backup details step, enter the credentials to retrieve the backup details. If the backup was performed with
encryption, enter the encryption password here also. Click Next.
Once started, the restore operation cannot be paused or stopped. When presented with a warning message to that
effect, click OK to start the restore operation.
Just before the end of the restore operation, a warning is presented. This warning is for the vCSA service and it
does not impact the PSC restore process. Click Close.
In the vCSA installer, navigate to the vcsa-ui-installer directory, and then to the subdirectory for your operating
system, and run the installer.
• For Windows OS, go to the win32 subdirectory, and run the installer.exe file.
• For Linux OS, go to the lin64 subdirectory, and run the installer file.
• For Mac OS, go to the mac subdirectory, and run the Installer.app file.
The vCenter Server Appliance Installer launches. The Installer allows you to restore a vCSA or a PSC. Click
Restore to initiate the restore from a previously created appliance backup.
21 | File-Based Backup and Restore of VCSA and PCS
Accept the End User License Agreement (EULA) and click Next.
Review your backup information and click Next to proceed with the restore.
In the Appliance deployment target step, specify the appliance deployment target settings. The target is the
ESXi host on which the appliance will be deployed. In this example, the primary ESXi node configured earlier with
the temporary VSS was set as the deployment target. Click Next.
In the Set up target appliance VM step, specify the settings for the target appliance VM to be deployed. In this
example, we named the VM VCSA_VM_restored. Using the password of the old VCSA for the target VCSA is
recommended. Click Next.
In the Select datastore step, select the VSAN datastore as the storage location for the VCSA VM. Click Next.
Review your settings, and then click Finish to start the appliance deployment.
The appliance deployment is initiated. Observe the progress of the deployment process until it successfully
completes. The completion of the deployment marks the end of the Stage 1 of the restore process. Click
Continue to proceed to Stage 2.
When the Stage 1 completes, the installer prompts for the Stage 2, which will copy the data from the backup
location to this appliance and then complete the setup. In the Introduction step, click Next to proceed with Stage
2.
In the Backup details step, enter the credentials to retrieve the backup details. If the backup was performed with
encryption, enter the encryption password here also. Click Next.
Once started, the restore operation cannot be paused or stopped. When presented with a warning message to that
effect, click OK to start the restore operation.
Run a post-recovery script to complete the restore process (this is only for vCSA, not applicable to PSC). Log into
the bash shell of the newly restored vCSA via Putty or via the VM console on the vSphere Web Client, and run this
command:
/usr/bin/vcenter-restore
Right-click-VM > All Virtual Infrastructure Actions > Remove from Inventory, or
Right-click-VM > All Virtual Infrastructure Actions > More uncategorized Actions > Remove from Inventory
For Source network, click Specific network, then Browse and select tempportgroup.
Monitor the progress of the migration in the Recent Tasks pane until it completes.
In the preceding sample command output, {DVS name is VMware HCIA Distributed Switch} and {the free DVport ID is
7}.
Having acquired the free DVport ID, run the following commands to delete the tempswitch VSS on the primary-
node and to move the vmnic1 back to the DVS:
esxcli network vswitch standard portgroup remove –p tempportgroup –v tempswitch
esxcli network vswitch standard uplink remove –u vmnic1 –v tempswitch
esxcli network vswitch standard remove –v tempswitch
esxcfg-vswitch –P vmnic1 –V 7 “VMware HCIA Distributed Switch”
Log into VMware vSphere Appliance Management Interface (VAMI) of PSC at port 5480.
Click the Summary tab on the Navigator pane and then click Reboot on the Summary pane.
Managed Object Reference IDs (morefid) for the newly deployed vCSA and PSC VMs are displayed in the VALUE
column on the row: childEntity. In this example, {morefid for vCSA is 163}, and {morefid for PSC is 162}. Next,
follow each link (vm-163 and vm-162) separately to obtain the UUID and the name of each VM. First click on the
link for vCSA.
On the page displayed, the VM-name is in the VALUE column on the row: name. To obtain the UUID, click the
config link in the VALUE column on the row: config on the same page.
Go back and click on the link for PSC to obtain its UUID and VM-name.
vCSA and PSC information obtained in this step will be used to update the VxRail Manager database in the next step.
In the database shell, run this query to collect the current information for old vCSA and PSC.
select * from virtual_machine;
Update the database table with the information obtained in the previous step for the new vCSA and PSC.
Run this query to verify the database is updated with the new data.
select * from virtual_machine;
Elevate to root account and restart the VxRail Manager’s vmware-marvin and runjars services.
sudo –i
Conclusion
The file-based backup and restore operation provides a simple and reliable way to rebuild the vCSA and PSC, which
are the two of VxRail’s core system VMs. Image level backup and restore operations can be arduous, time-
consuming, and restored images might not be reliable. Moreover, fundamental VxRail features and functionality such
as cluster shutdown, upgrade, hardware replacement, etc. are not impacted by this type of restore operation. VxRail
4.5 takes advantage of this native data protection feature provided by vSphere 6.5.
© 2019 Dell Inc. or its subsidiaries. All Rights Reserved. Dell, EMC and other trademarks are
trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective
owners.