Run Snapshot Policy from Command Line

This page provides details into the command line options for running snapshot policies for CopyStorm in headless mode. This feature was introduced as part of the 10.65.1 GA release of CopyStorm. For more information regarding running snapshot policies, see here.

Overview

The command line functionality mirrors the same options and functionality as seen in the CopyStorm application using the "Run Snapshot Rules Now" option including:

  • Start and end date ranges for records to snapshot

  • Number of concurrent searches (number of objects snapshot in parallel)

  • Search batch size

  • Snapshot per batch

Command Line Switches

Command Line Switch
Explanation
Required
Default

snapshot

The name of the snapshot to run

Yes

N/A

snapshotThreads

The number of objects to snapshot in parallel

No

10

snapshotSearchBatchSize

The read batch size from the database for candidate records

No

1000

snapshotWriteBatchSize

The write batch size to the database for found candidate records

No

1000

snapshotScanRecordsFrom

The date to start scanning records from (i.e. 2020-01-01)

No

Empty

snapshotScanRecordsThru

The date to end scanning records from (i.e. 2025-01-01)

No

Empty

Example Usage

This example is for Windows installations of CopyStorm. For Linux/Mac installations, change CopyStorm.bat to CopyStorm.sh

./CopyStorm.bat -snapshot "Default Point In Time" "/path/to/config.copyStorm" -snapshotThreads 5 -snapshotSearchBatchSize 5000 -snapshotWriteBatchSize 5000 -snapshotScanRecordsFrom "2020-01-01" -snapshotScanRecordsThru "2025-01-01"

Last updated

Was this helpful?