Applies To:

Show Versions Show Versions

Manual Chapter: Managing UCS Archives
Manual Chapter
Table of Contents   |   << Previous Chapter   |   Next Chapter >>

Any time you create a system configuration, you also create an archive of the user configuration set (UCS). A UCS archive is a compressed file that contains all the configuration files that are typically required to restore a configuration on a system.
For BIG-IP® systems, you create a UCS archive from the configuration utility or the command line that consists of all of the information it uses to manage traffic, including:
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. This means that you always have a secure location to store device configuration archives for all your managed devices.
The advantage of scheduling rotating archives is that if Enterprise Manager recognizes that a managed devices 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 devices configuration changes. Thus, you do not unnecessarily save any duplicate configuration archives, and you always have one or more archives of recent configurations from which you can restore the configuration. In a rotating archive schedule, Enterprise Manager saves multiple archives and cycles out old archives as it creates new ones.
By default, Enterprise Manager stores up to 10 rotating device archives and 10 saved, or pinned, archives per device in its database. Enterprise Manager automatically rotates archives in a first in, first out manner. That is, once the database reaches the maximum number or archives, Enterprise Manager deletes the oldest archive in the rotating archive list. Conversely, you must manually delete pinned archives.
If you attempt to create a pinned archive that exceeds the limit, the system warns you that it cannot create a new pinned archive until you delete at least one from the current list, or increase the maximum limit.
If you want to maintain more device configuration for backup and restore flexibility, you can increase this maximum limit as needed, but the number of stored archives can affect the disk space on the Enterprise Manager device.
1.
On the Main tab, expand Enterprise Management and click Rotating Archives.
The Rotating Archive Schedule screen opens.
2.
On the menu bar, click Options.
The Rotating Archives Options screen opens.
3.
Change the maximum number of archives that Enterprise Manager saves in its database, in the Maximum Rotating Archives box or the Maximum Pinned Archives box.
4.
Click Save Changes.
Note: If you reduce the maximum number of rotating archives on a system where the number of archives exceeds the new value, the system deletes the oldest archives to reach the new limit. If you set a lower pinned archive limit, the system does not automatically delete pinned archives. You must delete pinned archives manually.
After you add devices to the device list, you can set up a rotating archive schedule. You can create a customized archive schedule for a specific device, or create several archive schedules and assign any number of devices to each schedule.
1.
On the Main tab, expand Enterprise Management and click Rotating Archives.
The Rotating Archives list screen opens.
2.
Above the table, click Create.
The New Scheduled Task screen opens.
3.
In the Name box, type a name for the rotating archive schedule.
This name appears in the Rotating Archives list.
4.
From the Configuration Check list, select the frequency that you want Enterprise Manager to check managed device configurations.
5.
Specify a day of the week, month, and time of day that you want Enterprise Manager to check for device configuration changes.
6.
From the Private Keys list, select whether you want to include or exclude private SSL keys in the rotating archive.
7.
From the Status list, select whether you want to enable or disable the rotating archive schedule after you create it.
8.
For the Devices or Device Groups setting, in the Available list, select a device or device group.
9.
Click the Move button (<<) to move the selected devices or device groups from the Available list to the Assigned list.
10.
When you finish adding devices or device groups to the Assigned list, click Finished.
The Configuration Archive list screen opens and the new rotating archive schedule appears in the list.
Now, whenever a device configuration in the Assigned list changes during the interval you specified, Enterprise Manager creates an archive of the device's configuration and adds it to the rotating archives table on the Device Archives screen.
After you create a rotating archive schedule and add devices or device groups, you can modify elements of the schedule, including the interval and its enabled state. You can then make these changes affect all the devices subscribed to that schedule. Additionally, you can manage individual device or device group memberships to a particular schedule.
1.
On the Main tab, expand Enterprise Management and click Rotating Archives.
The Rotating Archives list screen opens.
2.
In the list, click the name of a schedule.
The Scheduled Task Properties screen opens.
3.
To change the archive interval, 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.
4.
Specify a day of the week, month, and time of day that you want Enterprise Manager to check for changes to device configurations.
5.
To change whether to include private SSL keys in the rotating archive, in the Private Keys list select an option.
6.
To change the state of the rotating archive schedule, in the Status list select one of the following options:
Enabled: Activates the scheduled task to check for configuration changes and create archives at the specified interval for all devices in the Assigned list.
Disabled: De-activates the scheduled task and stops checking for configuration changes or creating archives for all devices in the Assigned list.
a)
In the Device Assignments table, for the Devices or Device Groups setting, in the Available list, select a device or device group.
b)
Click the Move button (<<) to move the selected devices or device groups from the Available to the Assigned list.
a)
In the Device Assignments table, for the Devices or Device Groups setting, in the Assigned list, select a device or device group.
b)
Click the Move button (>>) to move the selected devices or device groups from the Assigned to the Available list.
9.
Click Save Changes.
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 before implementing important changes such as a software upgrade or hotfix installation. This ensures that you can restore a saved configuration from any specific point in time.
In addition to saving archives for any individual device, you can use the device groups feature to pin an archive for each device in a device group.
1.
On the Main tab, 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 archives table (below the Rotating Archive Summary 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.
For Private Keys, choose an option to determine whether Enterprise Manager stores private key data in the UCS archive.
8.
Click Create.
Enterprise Manager creates a UCS archive of the current device and the archive appears in the archive table when the Device Archive screen opens.
1.
On the Main tab, 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.
5.
Click Pin Archive below the table.
The archive status changes to Pinned and it remains in table until you delete it.
Using steps similar to the preceding procedures, you can use the pinned archive feature with device groups as you would for an individual device. The difference between the steps involves first selecting a device group.
1.
On the Main tab, expand Enterprise Management, and click Device Groups.
The Device Groups list screen opens.
2.
Click the name of the device group for which you want to manage archives.
The Device Group properties screen opens.
3.
On the menu bar, click Archives.
The Device Groups Archives screen opens.
You can use Enterprise Manager to restore a UCS archive on any managed device. In the event of a system restore, this can save you time by not requiring that you log on to individual devices to restore a device archive, and use Enterprise Manager instead.
Warning: Restoring an archive to a managed device overwrites all current configuration information on the device.
1.
On the Main tab, expand Enterprise Management, and click Devices.
The Device list screen opens.
2.
Click the name of the device for which you want to restore an archive.
The Device Properties screen opens.
3.
On the menu bar, click Archives.
The Device Archives screen opens.
4.
Important: You can restore a device configuration only to the device from which the Enterprise Manager saved the configuration archive.
Once you set up a rotating archive schedule or create pinned archives, 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.
1.
On the Main tab, 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.
1.
On the Main tab, 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 the 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.
When you manage multiple versions of UCS archives, you may encounter situations where you need to compare the differences between device configuration archives. When you compare archives, Enterprise Manager highlights the differences between two archives so that you can easily identify configuration changes. Examining these changes can help you troubleshoot issues related to restoring archives or upgrading software.
You can use the Compare Device Configurations wizard to assist you in configuring an archive comparison task to compare either the current configuration to an archive, or two stored UCS archives.
1.
On the Main tab, expand Enterprise Management, and click Tasks.
The Task list screen opens.
2.
Above the Task List, click New Task.
The New Task screen opens.
3.
In the Configuration Archives section, select Compare Archive.
4.
Click Next.
The Compare Device Configurations screen opens, where you select a device and comparison type.
1.
For Device, select the managed device for which you want to compare device configurations.
2.
For Comparison, select an option depending on the type of comparison that you want to do:
Current configuration to an archive
Select this to compare the current configuration of the device you selected in the Device box to one of the archived configurations listed in the Configuration archives table.
Two configuration archives
Select this to compare two archived configurations.
If you are comparing the current configuration to an archive, in the Configuration Archives table, select the option button next to the archived configuration that you want to compare.
If you are comparing two archived configurations, in the Configuration Archives table, check the Select box next to two archives that you want to compare.
4.
Click Next to advance to the Task Review screen.
After you configure the options, you can review the options before starting the task, or change the task name on the Task Review screen.
2.
If you want to change the name of the task listed on the Task list screen, in the Task Name table, type a new name.
3.
To start the task, click Start Task.
The Task Properties screen opens.
The Task Properties screen provides a summary of the task, where you can view differences between configuration files. You can also view this screen by clicking a comparison task in the task list.
1.
On the Main tab, expand Enterprise Management, and click Tasks.
The Task list screen opens.
3.
In the Task Summary table, in the Comparison column, click the View link for the configuration files that you want to compare.
The Task Details screen opens, displaying a detailed comparison of the configuration files, with differences between the two highlighted.
Note: If File Not Found displays in the Comparison column, it indicates that the system did not detect the file at the specified location, or the file does not exist. Configuration files may vary by managed device, or licensed features. Check the path and file name if you did not expect this message.
You can use the Configuration Search feature to search all available configuration files on a managed device for specific elements. This can help you find and view particular objects or settings in any managed device in your network.
Tip: When you use the following procedure to search every managed devices configuration for a specific element, remember that you filter your options only after all matching objects are found. Thus, the search time may be lengthy if you are managing a large number of devices. To decrease the search time, you can limit it to only a specific device or set of configuration files. You do this by typing a character string in the Matching Objects filter box above the Matching Objects list before typing a word in the Keyword box. Then, when you click the Search button, the system looks at only the configuration files listed in the Matching Objects list.
1.
On the Main tab, expand Enterprise Management, and click Configurations.
The Search Configuration screen opens.
2.
In the Keyword box, type a term for which to search in each configuration file.
You can type any alphanumeric string of characters.
4.
Click Search.
The Matching Objects table changes to display configuration files that contain instances that match the string you typed in the Keyword box.
5.
In the Matching Objects filter box, type a string of characters and click the adjacent Filter button to filter the list of configuration files.
A list of configuration files that match the filter you applied appears in the Matching Objects list.
6.
To view the contents of a configuration file, in the Matching Objects list, click the name of the configuration file.
The configuration file text appears in the Object Text table.
An Enterprise Manager UCS archive contains the managed BIG-IP system UCS archive, as well as additional information about managed devices in an Enterprise Manager system, including:
These UCS archive files are mandatory to restore a configuration, therefore, it is important that you create and securely store UCS archives. To easily manage these files, you can configure Enterprise Manager to create UCS archives at scheduled intervals, with the option of storing any archive indefinitely.
Basic
A basic UCS archive contains configuration data specific to a device. To create a basic UCS archive, you 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 Maintaining rotating archives, for more information about rotating archive schedules.
Advanced
An advanced UCS archive includes the device configuration information as well as all imported data, including UCS information, software repository, and managed device UCS archives.
Important: Because creating an advanced UCS archive may involve a large amount of data, verify first that you have adequate disk space available on the Enterprise Manager system and that there are no tasks currently running.
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.
The em-backup script begins the process of archiving all configuration and imported data stored on the Enterprise Manager system.
3.
When the process completes, move the <archive_name>.ucs file to a remote system for safe storage.
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.
Basic
A basic UCS restoration re-establishes all Enterprise Manager configuration information for managed devices, including certificate information, device groups, and custom alerts.
Advanced
An advanced UCS restoration includes all of the basic Enterprise Manager configuration data in addition to imported data, such as managed device UCS archives.
Important: You can restore a device configuration only to the device from which the Enterprise Manager saved the configuration archive.
Using Enterprise Manager eliminates the need to log on to each managed device, individually. This centralized management saves you time when you are required to restore UCS archives on devices in your network
Warning: Restoring an archive to a managed device overwrites all current configuration information on the device.
1.
On the Main tab, expand Enterprise Management, and click Devices.
The Device list screen opens.
2.
Click the name of the device for which you want to restore an archive.
The Device Properties screen opens.
3.
On the menu bar, click Archives.
The Device Archives screen opens.
4.
To perform the following procedure, you must have root access to the command line. You can only perform the following procedure on an advanced device configuration file created using 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.
The em-restore script begins the process of restoring all configuration and imported data stored on the Enterprise Manager system.
4.
When the process completes, delete the <archive_name>.ucs file from the target system, and reboot 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)