renameSnapshot
Renames a snapshot that you uploaded or a created in an environment.
If this command is executed to rename a snapshot that is in the process of being generated or archived, you will receive one of these errors:
- File not found error or the Invalid File error if the snapshot is being generated
- Archive process is in progress. Unable to Rename or Delete error if the snapshot is being archived
Do not rename the maintenance snapshot in an environment. To maintain a backup of the maintenance
snapshot, you should download Artifact Snapshot
from the
environment to a local computer and then rename it as needed. See Overview of the Maintenance Snapshot in
Getting Started Guide for Administrators.
Applies to
Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Account Reconciliation, Profitability and Cost Management, Enterprise Profitability and Cost Management,Oracle Fusion Cloud Enterprise Data Management, Sales Planning, and Strategic Workforce Planning.Required Roles
- Service Administrator
- Any predefined role and the Migrations - Administer application role
Usage
epmautomate renameSnapshot SNAPSHOT_NAME NEW_SNAPSHOT_NAME
where:
-
SNAPSHOT_NAME
is the name of an existing snapshot. This value should not contain special characters such as space, \ (backslash), / (slash), * (asterisk), ? (question mark), " (quotation mark), < (less than), and > (greater than). -
NEW_SNAPSHOT_NAME
is the unique name you want to assign to the snapshot.
Example
epmautomate renameSnapshot "Example Snapshot" Example_Snapshot_18_09_25