...
| Option | Description |
|---|---|
| bufferSize | Sets the buffer size (in bytes) to use when streaming data from the source to the target (supported plugins only). Defaults to 128K |
| dbConnectString | We do not use this parameter. Enables the MySQL database engine and specifies the JDBC connect string to connect to the database (i.e. "jdbc:mysql://localhost:3306/ecs_sync?user=foo&password=bar"). A database will make repeat runs and incrementals more efficient. With this database type, you can use the mysql client to interrogate the details of all objects in the sync. |
| dbEncPassword | This parameter is only used with the MySQL option, which we do not use. Specifies the encrypted password for the MySQL database. |
| dbEnhancedDetailsEnabled | May not work. Specifies whether the DB should included enhanced details, like source/target MD5 checksum, retention durations, etc. Note this will cause the DB to consume more storage and may add some latency to each copy operation. |
| dbFile | We do recommend this option. Enables the Sqlite database engine and specifies the file to hold the status database. A database will make repeat runs and incrementals more efficient. With this database type, you can use the sqlite3 client to interrogate the details of all objects in the sync. Be certain to replace the name with an absolute path to your home directory so that ecs-sync can consistently find it. One potential problem - if a transfers has errors, the system might not retry them. A recourse is to delete the db file, but of course you will lose your history. |
| dbTable | Specifies the DB table name to use. When using MySQL be sure to provide a unique table name or risk corrupting a previously used table. Default table is "objects". |
| deleteSource | Supported source plugins will delete each source object once it is successfully synced (does not include directories). Use this option with care! Be sure log levels are appropriate to capture transferred (source deleted) objects. |
| estimationEnabled | By default, the source plugin will query the source storage to crawl and estimate the total amount of data to be transferred. Use this option to disable estimation (i.e. for performance improvement). |
| forceSync | Force the write of each object, regardless of its state in the target storage. |
| ignoreInvalidAcls | If syncing ACL information when syncing objects, ignore any invalid entries (i.e. permissions or identities that don't exist in the target system). |
| logLevel | Sets the verbosity of logging (silent|quiet|verbose|debug). Default is quiet. |
| monitorPerformance | Enables performance monitoring for reads and writes on any plugin that supports it. |
| perfReportSeconds | Not tested. Report upload and download rates for the source and target plugins every <x> seconds to INFO logging. Default is off (0). |
| recursive | Hierarchical storage will sync recursively. |
| rememberFailed | Tracks all failed objects and displays a summary of failures when finished |
| retryAttempts | Specifies how many times each object should be retried after an error. Default is 2 retries (total of 3 attempts). |
| sourceListFile | Path to a file that supplies the list of source objects to sync. This file must be in CSV format, with one object per line and the absolute identifier (full path or key) is the first value in each line. This entire line is available to each plugin as a raw string. |
| sourceListFileRawValues | Whether to treat the lines in the sourceListFile as raw values (do not do any parsing to remove comments, escapes, or trim white space). Default is false. |
| syncAcl | Sync ACL information when syncing objects (in supported plugins). |
| syncData | Sync object data. |
| syncMetadata | Sync metadata. |
| syncRetentionExpiration | Sync retention/expiration information when syncing objects (in supported plugins). The target plugin will *attempt* to replicate retention/expiration for each object. Works only on plugins that support retention/expiration. If the target is an Atmos cloud, the target policy must enable retention/expiration immediately for this to work. |
| threadCount | Specifies the number of objects to sync simultaneously. Default is 16. |
| timingWindow | Sets the window for timing statistics. Every {timingWindow} objects that are synced, timing statistics are logged and reset. Default is 10,000 objects. |
| timingsEnabled | Enables operation timings on all plug-ins that support it. |
| verify | After a successful object transfer, the object will be read back from the target system and its MD5 checksum will be compared with that of the source object (generated during transfer). This only compares object data (metadata is not compared) and does not include directories. |
| verifyOnly | Similar to verify except that the object transfer is skipped and only read operations are performed (no data is written). |
...