Manage the Configuration Archive

Depending on your user privilege level, or privileges set for the User Group to which you belong, you can manage the configuration archive.

A configuration can exist on every node of a device cluster. When a configuration file is pulled from a device by a node, the file is sent to all cluster nodes. See Security Manager in the Oracle Communications Session Element Manager if you need to change your privileges to allow you to manage the configuration archive.

Note:

When R226 compliance is set as enabled upon installation, the OCSDM hides LI and SIPREC attributes, however, they still exist in the datadoc.

Add a Backup Schedule

Use this task to schedule automatic configuration backup for a device or a device group to run once, daily, weekly, or monthly automatically. You can also configure a backup to run on demand. The following actions occur when you create a backup:

A new directory is created for each device using its device name in the AcmePacket/ConfigBackups directory.
An entry is added to the database for the configuration file.
The set purge policy is applied.

On the Configuration Manager slider, select Configure archive, Schedules.
In the Schedules pane, click Add schedule.

In the Add Schedules tab, complete the following fields:

Schedule drop-down list

Select from the following options to set the type configuration backups for devices:

Schedule—Select to schedule a date and time and make the configuration backup available on an on-demand basis.
On Demand—Select to make the configuration backup available on an on-demand basis.

Note:
The parameters described below are unavailable if you choose this option.

Frequency drop-down list

Select from the following options to set the frequency of configuration backups for devices:

None—Select to not repeat a scheduled backup.
Daily—Select to perform daily backups.
Weekly—Select to perform weekly backups.
Monthly—Select to perform monthly backups.

Start date drop-down list

Select a start date using the calendar icon.

Start time drop-down list

Select a start time in a 24-hour cycle.

Click the Devices tab.
Click Add.
In the Select Device dialog, choose the device or device group in the Managed devices pane for which you want to schedule a backup, and click Add to move it to the Targeted devices pane.
Click OK.
The targeted device for scheduled configuration backups appears in the Devices table.
Click Apply to complete the backup schedule for the device.

Restore a Configuration Backup

The purge policy or existing configuration backups are not affected when a backup is restored for a device.

On the Configuration Manager slider, select Configure archive, Archive configuration.
Select a backed up configuration from the table, and click Restore.
In the confirmation dialog, click Yes to restore the backed-up configuration.

View a Backup Schedule

On the Configuration Manager slider, select Configure archive, Schedules.

In the Schedules pane, Session Element Manager displays the following columns:

Parent Group

The parent network function (NF) group that is provided by the user or Oracle Communications Session Element Manager plugin.

Source

The name of the NF target device(s) or device group that needs to be archived.

Frequency

The scheduled backup frequency.

First scheduled

The first time the schedule is started.

Last run time

The last time a scheduled backup was done.

Platform version

The current hardware version. If it is a device group, the value is N/A.

Software version

The current software version. If it is a device group, the value is N/A.

Rename a Configuration

You can rename any backed up configuration file to make its name more meaningful. The actual file name on the system does not change and continues to adhere to the set file naming policy. This configuration name only appears within the context of Oracle Communications Session Element Manager.

On the Configuration Manager slider, select Configure archive, Archive configuration.
In the Archive configurations pane, select the configuration you want to rename, and click Rename.
In the Name field, enter a new name for the configuration.
Click OK.
The alias name for the configuration appears in the list of archive configurations instead of its actual configuration file name.

Manage Purge Policies

You can select a purge policy for devices or device groups. You can customize the purge policy to define the number of backup configurations to store per device, to configure the purge schedule for devices or device groups, and to purge them immediately.

Create a Configuration Purge Policy

A purge policy must be selected and configured to have Oracle Communications Session Element Manager automatically delete configurations. You can also manage backed up configurations manually.

The Oracle Communications Session Element Manager plugin service provides the archive configuration name prefix for the archive configuration file name. The archived configuration files are kept in the Oracle Communications Session Delivery Manager server folder name ConfigBackups under the AcmePacket directory. The archived configuration file for each device uses the device IP address in the directory path.

On the Configuration Manager slider, select Configure archive, Administration.

In the Purge policy tab, complete the following fields:

Configuration archive purge policy section

Choose one of the following options to purge configurations:

Policy 1—Total Number of back-up configurations to allowed to be stored per device.
Policy 2—Back-up configurations for devices are purged on a daily, weekly or monthly basis.

Policy 1 section

Enter a numerical value between 0 - 999999999.

Policy 2 section

Enter values for the following fields:

Deleting daily backup older than days—Enter a numerical value between 0 - 999999999. The default is 4 days.
Deleting weekly backup older than weeks—Enter a numerical value between 0 - 99999999. The default is 4 weeks.
Deleting monthly backup older than months—Enter a numerical value between 0 - 999999999. The default is 4 months.

Click Apply.

Purge Configurations On-Demand

You can select the purge policy you set earlier or target all backed up configurations on a device or group. You can select multiple devices or multiple groups to purge at one time.

On the Configuration Manager slider, select Configure archive, Administration.

Click the Operation tab and complete the following fields:

Configuration archive purge policy section

Choose the scope of the purge:

Purge all archived configuration—Choose to purge all files and configurations associated with selected device(s) or device group(s).
Purge per policy—Choose to purge selected devices according to set purge policy.

Select the NF folder or device that you want to purge from the Managed devices table, and click Add.
The NF folder or device appears in the Targeted devices table.
Repeat the previous step to select more NF folders or devices that you want to purge.
Click Purge.

Search the Archive for a Configuration

Use this task to search for a configuration in the configure archive for an existing configuration backup.

The following search criteria can be used:

Standard wild card * and ? characters are supported.
- * matches 0 or more characters.
- ? matches 1 character.
Search filters containing wild card characters must be enclosed in double quotes: “fo*”.
Search filters containing no wild card characters result in an exact match.
Wild card characters cannot be used outside of double quotation marks in combination with an exact match search.

“A*1” is a valid search filter.

“A*”* is not a valid search filter.

Expand the Configuration Manager slider, and click to expand the Configure archive folder in the navigation pane.
Iin the navigation pane, click Archive configuration.
In the Archive configurations pane, click Search.

In the Configuration archive search dialog, complete any of the following fields:

Configuration name field

The user-defined name for the device configuration.

Source field

The source IP address of the device.

Hardware version field

The hardware version of a device.

Software version field

The software version of a device.

Start backup date field

Click the calendar icon to select the start date range for when a configuration was backed up to the configuration archive.

End backup date field

Click the calendar icon to select the end date range for when a configuration was backed up to the configuration archive.

In the Success dialog, click OK.
The newly-added physical interface appears in the Physical interface table.