BMC Mainframe documentation is now on docs.bmc.com

We are pleased to announce that technical documentation for BMC Mainframe products is available on docs.bmc.com. Now you can save favorites, watch pages for changes, search, and comment on every page. Check out the announcement.

We've been recognized

Docs.bmc.com has been recognized for providing a great online experience for doc like BMC Cloud Lifecycle Management 4.6. Check out 5 Real-life Examples of Beautiful Technical Documentation.

 
 

Backing up and restoring the appliance

The appliance backup feature enables you to backup the appliance. You can restore the backed up data when required. The backup can be made to the local file system, or to a remote destination over ssh or via a Windows share, so little local disk space is required. You can choose to be notified by email of the completion and result (success or failure) of a backup or a restore task.

Appliance shutdown and restart

The appliance is shutdown for the backup or the restore and restarted when the backup or the restore is complete.

Backing up or restoring the system when a baseline run is in progress results in critical baseline alerts

Baseline is run periodically by the BMC Atrium Discovery system. Should baseline be running when a backup or restore is started critical baseline alerts may be reported. The backup or restore is unaffected by these alerts. The automatic baseline check schedule can be modified using the tw_cron_update.

The following items are backed up where present:

  • Appliance Configuration
  • CMDB Sync Configuration
  • Consolidation Configuration
  • Cron Jobs
  • Custom Device Definitions
  • Custom JDBC Drivers
  • Custom Startup Scripts
  • Custom OS Data
  • Custom Reports
  • Custom Taxonomy
  • Customer Data
  • Datastore Data
  • Datastore Transaction Logs
  • Export Adapters
  • Export Exporters
  • Export Mappings
  • HTTPS Configuration
  • Installed Device Definitions
  • LDAP Configuration
  • Vault (optional)

Destination system time must not be earlier than source

You must ensure that the current system time on the destination appliance is no earlier than that of the appliance on which the backup was created. If the modification times on the files contained in the backup are later than the system time when they are restored, the backup will hang. To recover at this point you must kill the backup process, correct the time, run tw_restore --fix-interrupted then repeat the restore using the tw_restore command line utility.

Backing up and CMDB synchronization

The backup contains the CMDB synchronization configuration. When a host has significantly changed so that its key has also changed, problems can be caused if a backup is restored before the changed host is rediscovered. In this case, on the next CMDB synchronization, duplicate hosts will be created in the CMDB representing the changed host, and the CIs representing the original hosts will never be deleted. To ensure that no duplicate hosts are created, you can delete and then recreate the BMC.ADDM dataset.

The backup contains the LDAP configuration. If the destination appliance cannot access the LDAP server, you must ensure that a local (non-LDAP) user belonging to the system and public groups is activated and successfully tested on the source appliance before making a backup.

If you choose to exclude the credential vault when backing up an appliance in which CMDB synchronization has been configured, the CMDB Sync page on the restored appliance displays the "This appliance has not been set up for synchronization with the Atrium CMDB" message. Once the Setup form is complete, filter and blackout window settings are restored.

The appliance backup feature replaces the appliance snapshot that was available in previous releases. On upgraded appliances only, if snapshots are still held in the filesystem, a banner and Remove Snapshots button is provided so you can remove the snapshots and release disk space.

To create a backup of the appliance

  1. From the Appliance section of the Administration tab, click Backup & Restore.
    The Appliance Backup page is displayed. This has a panel in which you can configure the backup destination, and details of the size and contents of the backup.
    Shows the create backup tab of the appliance backup page.






  2. Enter the details for the backup destination. The fields that can be completed are displayed or hidden depending on the backup type selection. Required fields are indicated with a red asterisk.

    Field Name

    Details

    Backup Type

    Select the destination type from the drop down list. This can be one of the following:
    Local: The backup is written to the $TIDEWAY/var/backup directory. No other configuration is required. Only one local backup can be stored.
    SSH: The backup is written to a remote server over ssh.
    Windows Share: The backup is written to a Windows share.
    (info) You cannot create a backup on a Windows share from a FIPS enabled appliance. The mount operation fails and an error message written to syslog.

    Notes

    A free text area in which you can write notes about the backup.

    Directory

    The directory into which to write the backup on the remote SSH server. Backups are written into a subdirectory called YYYY-MM-DD_hhmmss_addm_backup inside the specified directory. (SSH only).

    Path

    The share name and directory name into which to write the backup on a Windows share. Backups are written into a subdirectory called YYYY-MM-DD_hhmmss_addm_backup inside the specified directory. Path syntax is \\sharename\directoryname, where sharename is the name of the Windows share, and directoryname is the name of the directory into which to write the backup. (Windows share only).

    Host

    The hostname or IP address of the remote server onto which to write the backup (SSH).

    Port

    The port to which to connect (SSH).

    Username

    The username to use to connect to the remote server (SSH and Windows share). To specify the domain for Windows shares, use the following syntax: --remote-user=user@domain

    Password

    The corresponding password (SSH and Windows share).

    Verify backup

    Select Verify backup to verify (md5) that the files in the backup archive are the same as those on the appliance. Shown only after successfully testing the connection for SSH and Windows share backups.

    Exclude vault

    Select Exclude vault to exclude the credential vault from the backup. Appliance UI users are always backed up and restored, regardless of this setting. So, for example, after a restore the password in effect for the system user will be the one from the source appliance. Shown only after successfully testing the connection for SSH and Windows share backups.

    Email when complete

    Select Email when complete and enter an email address if you want an email to be sent automatically when the backup task is completed. Shown only after successfully testing the connection for SSH and Windows share backups.

    Test Connection

    Click Test Connection to ensure that the remote host can be contacted and that the credentials are valid. Shown only for SSH and Windows share backups.

  3. Click Shutdown & Backup to start the backup operation.
    You are requested for confirmation.
  4. Click No to return to the Appliance Backup page. Click Yes to continue and backup the appliance.
    All services are shut down before the backup occurs and a progress screen is displayed.

To restore a backup to the appliance

FIPS enabled appliance

You should not attempt to restore a backup to a FIPS enabled appliance. Rather, you should restore a backup onto the appliance and then enable FIPS. If you restore to a FIPS enabled appliance, the services cannot restart and the progress screen shows an omniORB.CORBA.INITIALIZE error.

  1. Make sure that the time setting on the destination appliance is not earlier than the source appliance. Failing to do so results in a failed restore, and a time consuming process to repair the restore. See this warning for more information.
  2. From the Appliance section of the Administration tab, click Backup & Restore.
    The Appliance Backup page is displayed.
  3. Click the Restore Backup tab.
    The Restore Backup tab has a panel in which you can choose the source of the backup, and provides details of the size and contents of the existing local backup.
    Shows the restore backup tab of the appliance backup page.







  4. Enter the details for the backup source. The fields that can be completed are displayed or hidden depending on the backup type selection. Required fields are indicated with a red asterisk.

    Field Name

    Details

    Backup Type

    Select the destination type from the drop down list. This can be one of the following:
    Local: The backup is read from the $TIDEWAY/var/backup directory. No other configuration is required.
    SSH: The backup is read from a remote server over ssh.
    Windows Share: The backup is read from a Windows share.

    Directory

    The directory from which to read the backup on the remote server (SSH). Backups are written into a subdirectory called YYYY-MM-DD_hhmmss_addm_backup inside the specified directory. Ensure you specify the subdirectory name too. (SSH only).

    Path

    The share name and directory name from which to read the backup on the remote server (Windows share). Backups are written into a subdirectory called YYYY-MM-DD_hhmmss_addm_backup inside the specified directory. Path syntax is \\sharename\directoryname, where sharename is the name of the Windows share, and directoryname is the name of the directory containing the backup. (Windows share only).

    Host

    The hostname of the remote server from which to read the backup (SSH).

    Port

    The port to which to connect (SSH).

    Username

    The username to use to connect to the remote server (SSH and Windows share). To specify the domain for Windows shares, use the following syntax: --remote-user=user@domain

    Password

    The corresponding password (SSH and Windows share).

    Preserve Identity

    Select the check box to preserve the appliance's identity rather than take on the identity from the restored backup. This consists of:
    • Appliance identity
    HTTPS configuration
    Consolidation configuration
    Clear the check box to use the identity from the backup.

    Email when complete

    Select the check box and enter an email address if you want an email to be sent automatically when restoring the backup is complete.

    Test Connection

    When you enter valid connection information, the Test Connection button is enabled. Click this to test the connection to the remote backup server. When the test is successful, and a backup is present, the Remote Backup Details pane displays information on the remote backup.

  5. Click Shutdown & Restore to start the restore operation.
    You are requested for confirmation.
  6. Click No to return to the Appliance Backup page. Click Yes to continue and restore the appliance.
    All services are shut down before the restore occurs and a progress screen is displayed.

Device package error on restore

Network device definitions are automatically installed with a TKU. The source and destination appliance must have the same version network device definitions. If you see the following error when restoring, it is important to update the package as described in the error message.

An error was reported while installing the device package. 
Please correct the error and install the device package manually by 
running (as root):
  tw_device_inport --force -U --oldpackage <rpm file>

The device package is located in the $TIDEWAY/data/installed/tpl directory.

  • No labels

© Copyright 2016 BMC Software, Inc. © Copyright 2016 BladeLogic, Inc.