Applies To:

Show Versions Show Versions

Manual Chapter: Enterprise Manager Administrator Guide: Managing Device Configuration Archives
Manual Chapter
Table of Contents   |   << Previous Chapter   |   Next Chapter >>


6

Managing Device Configuration Archives


Working with device archives

When you initially configure a BIG-IP system, you can elect to store the system's configuration information in a user configuration set (UCS) archive. A UCS archive is a compressed file that contains all the configuration files that are typically required to restore a configuration on a system. These files are useful in recovering information vital to the traffic management functions of a BIG-IP system. A UCS archive consists of:

  • All BIG-IP system configuration files
  • BIG-IP system product licenses
  • User accounts and password information
  • DNS zone files and NameSurfer configuration
  • SSL certificates and keys

On a BIG-IP system, you can create UCS archives using the BIG-IP Configuration utility or from the command line. On the Enterprise Manager system, you can configure Enterprise Manager to create UCS archives on regularly scheduled intervals with the option of storing any archive indefinitely.

You must store these archives in a secure location because UCS archives contain critical system files, user account information, passwords, and SSL private keys used by SSL proxies configured on a BIG-IP system.

Enterprise Manager provides a secure location for multiple configurations. When you use Enterprise Manager to manage your device configurations, you can automatically back up device configurations at intervals you control to ensure that you have a working configuration to use if you need to restore the system.

Enterprise Manager is initially set to store up to 10 rotating device archives and 10 saved, or pinned, archives per device in its database. If you want to change these default values, see Changing the device archive options, on page 3-11 .

Managing Enterprise Manager device archives

In addition to managing device configuration archives for a BIG-IP system, Enterprise Manager can manage UCS archives for itself or other Enterprise Manager systems.

An Enterprise Manager UCS archive contains all of the same information that a BIG-IP system UCS archive does, but it also contains additional information about managed devices in an Enterprise Manager system, including:

  • Device properties information
  • Device certificates
  • Custom alerts
  • Device groups
  • Certificate lists
  • History information such as the task list and alert history list
  • Rotating archive schedules

Enterprise Manager UCS archives contain all the essential managed device information stored in the Enterprise Manager database. However, they do not archive imported information such as software or hotfix images and managed device UCS archives.

Creating Enterprise Manager configuration archives

You have two main options for creating a UCS archive of an Enterprise Manager configuration: basic and advanced. A basic UCS archive for an Enterprise Manager system contains device configuration information, as noted in the previous section. An advanced UCS archive includes the basic information and all of the data that you imported to the Enterprise Manager system, such as software images and managed device configuration archives.

To create a basic UCS archive, you can add an Enterprise Manager device to a rotating archive schedule (in the same way that you do for any managed device) and store basic UCS archives on an Enterprise Manager system. See Managing rotating archives for more information on working with rotating archive schedules.

To create an advanced configuration archive of an Enterprise Manager system, you must use the em-backup script. This script backs up all the Enterprise Manager UCS information and additional data such as the software repository and managed device UCS archives.

Because this may involve a large amount of data, ensure that you have adequate disk space available on the Enterprise Manager system and that you move the archive file to a remote system when it completes.

To create an advanced Enterprise Manager backup

To perform a full backup, you must have root access to the command line. Before you run the em-backup script, ensure that no tasks are running on the Enterprise Manager system.

  1. Log in as root at the command line.
  2. At the command prompt, type the following command, where <archive_name> is the path and file name for the archive file, and press Enter.
  3. em-backup <archive_name>.ucs

    The em-backup script begins the process of archiving all configuration and imported data stored on the Enterprise Manager system.

  4. When the process completes, move the <archive_name>.ucs file to a remote system.
Note

The em-backup script may take several minutes to complete depending on how many software images or UCS archives are stored on the Enterprise Manager system.

Restoring Enterprise Manager configuration archives

If you need to restore a configuration to an Enterprise Manager system, you have basic and advanced options. A basic restoration can re-establish all Enterprise Manager configuration information regarding managed devices, including certificate information, device groups, and custom alerts. An advanced restoration includes all of the basic data in addition to imported data such as software images and managed device UCS archives.

You can perform a basic restoration from the Device Archive Properties screen. See Restoring device archives for information on restoring UCS archives from an Enterprise Manager system.

If you want to perform an advanced restoration, you can use the em-restore script. If you want to use the em-restore script, you must have an advanced device configuration file created using the em-backup script. If you use the em-restore script, this restores all configuration settings and all of the data you imported into Enterprise Manager such as software images and UCS archives of managed devices.

To restore a full Enterprise Manager backup

To perform a full restoration, you must have root access to the command line. Before you run the em-restore script, ensure that you have a valid advanced UCS archive created by the em-backup script.

  1. Log in as root at the command line of the Enterprise Manager system that you want to restore.
  2. Copy the advanced Enterprise Manager UCS archive that you created with the em-backup script to the Enterprise Manager system that you want to restore.
  3. At the command prompt, type the following command, where <archive_name> is the path and file name for the archive file, and press Enter.
  4. em-restore <archive_name>.ucs

    The em-restore script begins the process of restoring all configuration and imported data stored on the Enterprise Manager system.

  5. When the process completes, delete the <archive_name>.ucs file from the target system, and reboot the device.

Managing rotating archives

Enterprise Manager can create and store UCS archives for managed devices on demand, or at regularly scheduled intervals using rotating archives. Rotating archives are UCS archives created at a regular interval according to a schedule that you set in Enterprise Manager.

The advantage of scheduling rotating archives is that you can set Enterprise Manager to create archives on a regular interval so that after Enterprise Manager recognizes that a managed device's configuration has changed, it schedules the creation of a UCS archive during the current rotating archive schedule. This way, you can have a recent backup configuration for a managed device, which provides added stability in case a configuration change results in a need for a system restore. For example, if you set up a daily rotating archive schedule, Enterprise Manager creates a UCS archive on each day that the managed device configuration changes. This ensures that you do not unnecessarily save any duplicate configuration archives, and that you always have one or more archives of recent configurations with which to restore. In a rotating archive schedule, Enterprise Manager saves multiple archives and cycles out old archives as it creates new ones.

After Enterprise Manager adds devices to the device list, you can set up a default rotating archive schedule for all managed devices. If you need to set up a custom schedule for any devices, you can do that individually for each device.

 

 

Figure 6.1 Adding a device to the default rotating archive schedule on the Rotating Archive Schedule screen

To configure a default rotating archive schedule

  1. On the Main tab of the navigation pane, expand Enterprise Management and click Devices.
    The Device List screen opens.
  2. On the menu bar, click Rotating Archive Schedule.
    The Rotating Archive Schedule screen opens.
  3. In the Default Rotating Archives Schedule table, in the Rotating Archives box, select Enabled.
    The table changes to show additional options.
  4. In the Configuration Check box, select how often you want Enterprise Manager to check managed device configurations.
    The table changes to provide options for the frequency you selected.
  5. Depending on the frequency you selected, you can specify a day of the week, month, and time of day that you want Enterprise Manager to check for changes to device configurations.
    The Rotating Archive Schedule Summary table details the rotating archive schedule of each managed device.

After you set up a default rotating archive schedule, then whenever a device configuration changes during the interval you specify, Enterprise Manager creates an archive of the device's configuration and adds it to the Rotating Archives table on the Device Archives screen.

To configure a custom rotating archive schedule

If you need to specify a different rotating archive schedule for a device, or need to apply a rotating archive schedule to one device, you can create a schedule for individual devices

  1. On the Main tab of the navigation pane, expand Enterprise Management, and click Devices.
    The Device List screen opens.
  2. Click the name of the device for which you want to create a custom rotating archive schedule.
    The Device Properties screen opens.
  3. On the menu bar, click Archives.
    The Device Archives screen opens.
  4. In the Rotating Archive Schedule table, in the Rotating Archives box, select Custom.
    The table changes to enable additional options.
  5. In the Configuration Check box, select how often you want Enterprise Manager to check the managed device's configuration.
    The table changes to provide options for the frequency you selected.
  6. Depending on the frequency you selected, you can specify a day of the week, month, and time of day that you want Enterprise Manager to check for changes to device configurations.
  7. After you set the details, click Save Changes.

When you check the status of rotating archives on the Rotating Archive Schedule screen, this device's schedule appears as Custom.

To exclude one or more devices from a default rotating archive schedule

When you create a default rotating archive schedule, all managed devices subscribe to this schedule unless you create a custom schedule for a device, or unless you disable rotating archives for a device.

  1. On the Main tab of the navigation pane, expand Enterprise Management and click Devices.
    The Device List screen opens.
  2. On the menu bar, click Rotating Archive Schedule.
    The Rotating Archive Schedule screen opens.
  3. In the Rotating Archive Summary table, check the Select box next to any device that you want to exclude from the default rotating archive schedule.
    The Rotating Archive Schedule screen opens.
  4. Below the table, click Disable Rotating Archives.
    The table changes to indicate which devices are disabled from the rotating archive schedule.

Tip


You can use this screen to both enable and disable the default rotating archive schedule for multiple devices.

Modifying or deleting configuration archives

Once you set up a rotating archive schedule or create pinned archive, you can modify the descriptions of archives, or delete archives if you need to. You can perform these actions from a device archives or archive properties screen.

To delete device configuration archives

  1. On the Main tab of the navigation pane, expand Enterprise Management, and click Devices.
    The Device List screen opens.
  2. Click the name of the device for which you want to delete configuration archives.
    The Device Properties screen opens.
  3. On the menu bar, click Archives.
    The Device Archives screen opens.
  4. In either the Rotating Archives or Pinned Archives table, check the Select box next to the name of the archive(s) that you want to delete.
  5. Below the appropriate table, click Delete.

To modify an archive description

  1. On the Main tab of the navigation pane, expand Enterprise Management, and click Devices.
    The Device List screen opens.
  2. Click the name of the device for which you want to modify the description of a UCS archive.
    The Device Properties screen opens.
  3. On the menu bar, click Archives.
    The Device Archives screen opens.
  4. In either the Rotating Archives or Pinned Archives table, click the name of the archive for which you want to modify the description.
    The Archive Properties screen opens.
  5. In the Description box, type the new description.
  6. Click Save Changes.

Saving device configuration archives

When you set up a rotating archive schedule, Enterprise Manager saves multiple archives, and cycles out old archives as it creates new ones. Although this ensures that you maintain a useful list of the most recent UCS archives for each of your managed devices, you may want to save certain archives.

Using Enterprise Manager, you can save pinned archives almost indefinitely. A pinned archive is a UCS archive (that you create or move from the rotating archive list) that is saved in the Enterprise Manager database until you remove it.

This feature is useful if you want to save device configurations after important changes such as before or after a software upgrade or hotfix installation. This ensures that you can restore a saved configuration from any specific point in time.

To create a new pinned archive

You can create a new UCS archive from a device's Rotating Archive Schedule screen.

  1. On the Main tab of the navigation pane, expand Enterprise Management, and click Devices.
    The Device List screen opens.
  2. Click the name of the device for which you want to create a new pinned archive.
    The Device Properties screen opens.
  3. On the menu bar, click Archives.
    The Device Archives screen opens.
  4. Above the Pinned Archives table, click Create.
    The New Archive screen opens.
  5. In the File Name box, type the file name of the new archive that you want to create.
  6. In the Description box, type a note that you want to appear in the Pinned Archives table next to the archive file name.
  7. Click Create.
    Enterprise Manager creates a UCS archive of the current device and the archive appears in the Pinned Archives table when the Rotating Archive Schedule screen opens.

To pin an existing configuration archive

You can save a UCS archive from a device's Rotating Archive Schedule screen.

  1. On the Main tab of the navigation pane, expand Enterprise Management, and click Devices.
    The Device List screen opens.
  2. Click the name of the device for which you want to pin an archive from the rotating archive list.
    The Device Properties screen opens.
  3. On the menu bar, click Archives.
    The Device Archives screen opens.
  4. In the Rotating Archives table, check the box to the left of an archive name to select it.
  5. Click Pin Archive below the table.
    The selected archive moves to the Pinned Archive table where it is saved until you delete it.

Restoring device archives

You can use Enterprise Manager to restore a UCS archive on any managed device. In the event of a system restore, you can save time by not logging on to an individual device console to restore a device archive, and use Enterprise Manager instead.

Important

You can only restore a device configuration to the device that Enterprise Manager saved the configuration archive from.

To restore a device archive

  1. On the Main tab of the navigation pane, expand Enterprise Management, and click Devices.
    The Device List screen opens.
  2. Click the name of the device for which you want to restore a UCS archive.
    The Device Properties screen opens.
  3. On the menu bar, click Archives.
    The Rotating Archive Schedule screen opens.
  4. In either the Rotating Archives or Pinned Archives table, click the name of the archive that you want to restore.
    The Archive Properties screen opens.
  5. To restore the archive to the source location on the managed device, click Restore.
Warning

Restoring an archive to a managed device overwrites all current configuration information on the device.



Table of Contents   |   << Previous Chapter   |   Next Chapter >>

Was this resource helpful in solving your issue?




NOTE: Please do not provide personal information.



Incorrect answer. Please try again: Please enter the words to the right: Please enter the numbers you hear:

Additional Comments (optional)