Knowledge Base

The VMware Knowledge Base provides support solutions, error messages and troubleshooting guides
 
Search the VMware Knowledge Base (KB)   View by Article ID
 

Backing up and restoring the vCenter Single Sign-On (SSO) 5.1 configuration (2034928)

Purpose

This article provides an overview of backing up and restoring the vCenter Single Sign-On (SSO) 5.1.0 configuration.

For more information, see the vSphere 5.1 documentation.

For information on backing up vCenter Server 5.5 using Single Sign-On 5.5, see Backing up and restoring the vCenter Single Sign-On 5.5 configuration (2057353).

Resolution

If your vCenter Single Sign-On single node or primary node instance is corrupted, you can restore a backup to ensure continued vSphere access for vCenter Server and vCenter Server components.

Back up the vCenter Single Sign-On configuration in these circumstances:
  • After you install, update, or change the location of a vCenter Single Sign-On instance.
  • When the node.pkg file is modified. The node.pkg file is modified when you take either of these actions:
    • Change vCenter Single Sign-On database information, such as the database host name or port.
    • Change the vCenter Single Sign-On password that was created for the administrator user admin@System-Domain when vCenter Single Sign-On was originally installed. This original password is required when you restore a vCenter Single Sign-On backup.

      Note: For a complete backup, you must also back up the vCenter Single Sign-On database. For more information, see the documentation for the database type you are using.

  • Before the vCenter Server virtual machine is restored from a snapshot.
  • Before the vCenter Server virtual machine is installed from a backup of the database from a prior vCenter Server instance.

Backing up the vCenter Single Sign-On 5.1 configuration

To back up the vCenter Single Sign-On configuration:
  1. From the Windows user interface:

    • Go to Programs > VMware.
    • Right-click Generate vCenter Single Sign-On backup bundle and click Run as administrator.

  2. From the command prompt:

    • Right-click the Command Prompt icon or menu item and select Run as administrator.
    • Change directory to C:\Program Files\VMware\Infrastructure\SSOServer\scripts.

      If you installed vCenter Single Sign-On in a location other than the default, change to the path where it was installed.

    • Type cscript sso-backup.wsf /z and press Enter.

      Notes:
    • The vCenter Single Sign-On configuration is backed up to a file named Single Sign On.zip on the desktop of the host machine. To save the .zip file in a different location, edit the C:\Program Files\VMware\Infrastructure\SSOServer\scripts\sso-backup script and change this line from:

      savedir=appshell.Namespace(DESKTOP).Self.Path

      To:

      savedir= path_to_file

    • When executing the script, you may see this message:

      Error
      zipping support bundle: Object variable not set.

      This error is benign and can be ignored.


Restoring the vCenter Single Sign-On 5.1 configuration

To restore a vCenter Single Sign-On single node or primary node instance that has become corrupt:

Prerequisites
  • Prepare a host machine for the restored vCenter Single Sign-On instance. The host machine can be a physical machine or a virtual machine. It must satisfy the hardware requirements for vCenter Single Sign-On. For more information, see the Hardware Requirements for vCenter Server, vCenter Single Sign-On, vSphere Client, and vSphere Web Client section of the vSphere Upgrade guide.

    Note: If the host machine is the one previously running vCenter Single Sign-On, you must remove this instance prior to preforming the upgrade.

  • Verify that the vCenter Single Sign-On database is accessible from the host machine.
  • Verify that you have the original administrator password for the vCenter Single Sign-On instance that you are restoring.
  • Verify that you have the account name and password for the RSA SSPI service and vCenter Single Sign-On service of the vCenter Single Sign-On instance that you are restoring.
  • Download the vCenter Server installer from the VMware Download Center to the new host machine.
Procedure
  1. Copy the backup file Single Sign On.zip to the new host machine in the directory C:\Temp\SSO Recovery.
  2. Rename the new host with the same Fully Qualified Domain Name (FQDN) as the vCenter Single Sign-On server that you created the backup from.
  3. If the vCenter Single Sign-On instance that you created the backup from was in a workgroup, and was installed using its IPv4 address, make sure that the new host machine has the same static IP address.

    Note: DHCP is not supported.

  4. Verify that the DNS of the new host is forward and reverse resolvable.
  5. On the vCenter Single Sign-On host machine, in the VMware vCenter Server installation directory, double-click the autorun.exe file to start the installer.
  6. Select vCenter Single Sign-On and click Install.
  7. Follow the prompts in the installation wizard to choose the installer language, and agree to the end user patent and license agreements.
  8. Select Recover installed instance of vCenter Single Sign-On from a backup.
  9. Browse to and select the Single Sign On.zip file.
  10. Enter the original administrator password for the old vCenter Single Sign-On instance.

    Note: You must use the password that was created for the admin@System-Domain user when vCenter Single Sign-On was originally installed, even if you have changed that password.

  11. Make sure that the RSA SSPI service is logged on to the same account as in the vCenter Single Sign-On instance that you created the backup from.
  12. Follow the wizard prompts to complete the vCenter Single Sign-On restoration.

    Notes:
    • If there are any vCenter Single Sign-On high availability backup nodes associated with the primary node that you restored, make sure that the RSA SSPI service logs on to the same account in the primary node and all high availability backup nodes.
    • From the vSphere Web Client, log in to the vCenter Server instances that are registered to the vCenter Single Sign-On instance to verify that you have working access to them.

See Also

Update History

03/19/2013 - Added option to save backup to a different location.

Request a Product Feature

To request a new product feature or to provide feedback on a VMware product, please visit the Request a Product Feature page.

Feedback

  • 11 Ratings

Did this article help you?
This article resolved my issue.
This article did not resolve my issue.
This article helped but additional information was required to resolve my issue.
What can we do to improve this information? (4000 or fewer characters)
  • 11 Ratings
Actions
KB: