1. Administering Oracle Access Management
  2. Using the OAM Snapshot Tool
  3. Introduction to the OAM Snapshot Tool

44 Introduction to the OAM Snapshot Tool

This section provides an overview of the OAM Snapshot Tool.

Snapshot refers to the OAM system backup comprising policies, configurations, certificates, and database schemas.

OAM Snapshot Tool refers to a set of customizable scripts: createSnapShot.sh and applySnapshot.sh that provides the ability to perform backup and restore operations of the entire OAM Domain configurations.

The scripts are available as part of the OAM 12c PS4 Bundle Patch 2 (12.2.1.4.200327) installation and located at $MW_HOME/idm/oam/server/upgrade/script directory.

Note:

Out-of-the-box, the scripts have default values for domain paths, DB paths, and so on. Before you run the scripts, ensure you review and update the paths based on your customized requirement. For more information, see Customizing the Paths for the OAM Snapshot Tool

The OAM Snapshot tool can be used, for example, to create another identical OAM system on a separate infrastructure, upgrade from the existing older version of OAM (12c PS3) to a newer version of OAM (12c PS4) without service disruptions, migrate OAM domain and database schemas to a different infrastructure, and so on. For details, see Using the OAM Snapshot Tool

Also see Doc ID 2663163.1 at https://support.oracle.com for additional details about the Snapshot tool.

Operation Types Supported by the OAM Snapshot Tool

The OAM Snapshot Tool supports the following operations:

Note:

The operation type is specified within the <backup/restore>.properties file, which is provided as an input to the customizable scripts.

Backup
  • This operation enables you take a backup (snapshot) of the OAM Domain.
  • Operation type is specified using the parameter OPERATION=BACKUP in the backup.properties file.
  • You can run createSnapshot.sh <path>/backup.properties to create a backup of the OAM Domain.
  • See Backing Up an OAM Deployment for detailed instructions.
Restore
  • This operation enables you to restore the OAM Domain on a new infrastructure using the backup (snapshot) created.
  • Operation type is specified using the parameter OPERATION=RESTORE in the restore.properties file.
  • You can run applySnapshot.sh <path>/restore.properties to restore the OAM domain on the new infrastructure.
  • See Rebuilding an OAM Deployment - Domain Only
Migrate
  • This operation enables you to take a backup of OAM Domain and Database Schemas from the source infrastructure and restore them on the target infrastructure.
  • The operation type is specified using the parameter OPERATION=MIGRATE in the backup.properties file (on the source infrastructure) and OPERATION=MIGRATE in the restore.properties file (on the target infrastructure).
  • You can run createSnapshot.sh <path>/backup.properties on the source infrastructre. This internally calls the following scripts in sequence:
    • moveToDB.sh
    • datapump_exp.sh

    In addition to the OAM Domain backup, the scripts create the database *.dmp files on the source infrastructure. These database *.dmp files must be manually copied from the source DATA_PUMP_DIR to the target DATA_PUMP_DIR.

  • You can run applySnapshot.sh <path>/restore.properties on the target infrastructre. This internally calls the following scripts in sequence:
    • datapump_imp.sh
    • extract_from_db.sh
  • See Migrating OAM Domain and Database Schemas for detailed instructions.