Use the SoS tool to create backup files of various components' configurations in your Cloud Foundation environment. This Python tool resides in each SDDC Manager virtual machine in your environment.

Before you begin

When running the backup command to create the backup files for all racks in the installation in a single command run, you must have the root account credentials for the SDDC Manager instance that currently has the SDDC Manager VIP. When you want to get these backup files created for all racks in a single command run, you can run the tool in that SDDC Manager instance, logging in using the root account credentials for that VM. In the managment domain on each rack, the SDDC Manager instance is the one whose virtual machine name starts with vrm. See Credentials for Logging In To the SDDC Manager (vrm) Virtual Machine.

About this task

The SoS tool makes backup files of these components' configurations:

  • ESXi hosts

  • Switches (management, ToR, spine)

  • The three infrastructure (ISVM) virtual machines' Zookeeper server instances and Cassandra distributed database

  • SDDC Manager instances (the virtual machines in each rack with names starting with vrm)

  • The SDDC Manager instances' HMS software components

The backup files are written by default to the /var/tmp directory in the filesystems of your environment's SDDC Manager instances:

  • When you run the ./sos --backup command in the SDDC Manager instance that is currently assigned the SDDC Manager VIP, the SoS tool makes an API call to all of the SDDC Manager instances on your environment's other racks to initiate the backup process for the component configurations on those racks. Each rack's backup configuration files are written to the /var/tmp directory in the filesystem of each rack's SDDC Manager instance. You then log in to each SDDC Manager instance and change directories to the /var/tmp directory to find the output files for that rack.

  • When you run the ./sos --backup command in an SDDC Manager instance that is not currently assigned the VIP, the tool creates the backup files only for that rack's components. The output files are written to the /var/tmp directory in that SDDC Manager instance's filesystem.

After the output file are created, you can copy the files to another location to have them available for future replacement and restoration situations.

For a description of the SDDC Manager VIP and how to determine which instance it is currently assigned to, see About the Primary Rack and the SDDC Manager Virtual IP Address.

Procedure

  1. Using the root account, connect and log in, for example by SSH, to the SDDC Manager instance in which you want to run the backup command.
  2. Change to the /opt/vmware/evosddc-support directory.
  3. Type the command to collect the configurations and save the backup files to the /var/tmp directory.
    ./sos --backup

    The tool displays Welcome to SoS(Supportability and Serviceability) utility!, and messages about the tool's progress, for example:

    rack-1-vrm-1:/opt/vmware/evosddc-support # ./sos --backup
    Welcome to SoS(Supportability and Serviceability) utility!
    Backup: /var/tmp/backup-2016-11-08-15-01-48-3650
    Log file: /var/tmp/backup-2016-11-08-15-01-48-3650/sos.log
    Progress : 0%
    

Results

The tool collects the configurations from the components and writes the output to the /var/tmp directory in the SDDC Manager instance in which the SoS tool was invoked . Inside that directory, the tool writes the output into a directory whose name reflects the timestamp when the SoS tool initiated the process. If the tool was invoked in the SDDC Manager instance that has the SDDC Manager VIP, the tool also writes backup configurations into the other SDDC Manager instances' /var/tmp directories.

Note:

Each rack's backup files are written into the subdirectory named rack-1 in the /var/tmp/backup-timestamp directory that is created in that rack's SDDC Manager instance.

/var/tmp
  backup-timestamp
    sos.log
    rack-1
      esx
        configBundle-hostname.domain.tgz #One per host
      switch
        ToR-or-spine-switch-ip-address-manufacturername-running-config.gz #File named according to the switch's IP address and manufacturer
        cumulus-192.168.100.1.tgz #Management switch configuration file
      zk #This directory appears for the rack where the ISVM VMs are deployed
        isvm-ip-address #Three directories in the zk directory, each named using the IP address of an ISVM VM, such as 192.168.100.43
          cassandra-db-backup.tgz
          zk-db-backup.tgz
      vrm.properties
         hms_ib_inventory.json
         vrm.properties
         vrm.properties.vRack
         vrm-security.keystore
      hms.tar.gz
      vrm-timestamp.tgz

What to do next

Copy the backup files to a location where you can conveniently retrieve them for future configuration restoration situations.