Operations
Operations define parameters and options for executing ELS in one of the
various modes. Paths are for the local system.
Named configurations may be executed:
- Using the Run button
- Added as a Task in a Job
- With a command line copy or shortcut using the Generate button
The publisher and subscriber for execution come from, respectively:
- The currently loaded libraries in the ELS Navigator Browser.
- From the defined Task Origins in a Job.
- As parameters in the command line -p|-P and -s|-S.
Operational Modes
ELS may be executed in one of the following modes and as a task in a Job. (* = Advanced).
- Local publish : Back-up with all storage connected to the local system.
- Remote publish : Back-up using two systems over a LAN or Internet.
- Subscriber listener : The subscribe-side for remote publish.
- Hint status server : Track manual changes between remote back-up systems.
- Publisher terminal* : Manual terminal for a remote publisher listener.
- Publisher listener* : The publisher-side for a publisher terminal.
- Subscriber terminal* : Manual terminal for a remote subscriber listener.
- Hint server force quit : Force a remote Hint Status Server to quit.
- Subscriber force quit : Force a remote subscriber listener to quit.
For remote operations both computers use copies of the each other's JSON library files.
Generate Button
The Generate button creates a command line for executing the currently-selected
operation using the current Publisher, Subscriber, Hint Keys and Hint Tracking as
arguments, if appropriate and available. If not available those arguments will be missing from the
generated command. Edit and copy (Ctrl-C) as desired, or select the Shortcut button to create a
desktop shortcut.
Options
Listed alphabetically. The single-letter and long variations are shown. Which options
appear depends on the selected mode.
- Authorize password
-a | --authorize [password] : Used with listeners to define the password a user would type interactively to gain
access to higher-level commands when using a terminal mode.
- Authentication keys
-A | --auth-keys [file] : Used to authenticate both workstations and publishers instead of requiring a specific
system defined by -p|-P and -s|S.
- Blacklist
-B | --blacklist [file] : List of one-line IP addresses to filter and block incoming connections. The blacklist
supports # style comments and blank lines. Each IP address is an IPv4 dotted address, e.g. 127.0.0.1, on separate lines.
- Decimal scale
-z | --decimal-scale : Format numeric (B, KB, MB, GB, TB) values with a 1000 decimal scale instead of a 1024 binary scale.
- Dry-run
-D | --dry-run : Do everything except the actual action.
- Duplicates
-u | --duplicates : Report publisher duplicate items during back-up operations.
- Cross-check
-x | --cross-check : If -u is enabled cross-check all libraries for an item instead of just within that item's library.
- Empty directories
-E | --empty-directories : Report empty directories. Otherwise only a total number is reported in the statistics.
- Exclude
-L | --exclude [library] : List of libraries to be excluded from processing. May be repeated.
- Export text
-e | --export-text [output file] : Export publisher collection as text to file.
- Export items
-i | --export-items [output file] : Export publisher collection as JSON to file.
- Hint keys & Hint keys only
-k | --keys [key file] : Process Hints between publisher and subscriber.
-K | --keys-only [keys file] : Process Hints on the publisher only then end.
- Hint Tracker & Hint Server
-h | --hints [JSON file] : Enable local Hint Tracking. The JSON defines the location of the hint datastore.
-H | ----hint-server [JSON file] : Run ELS in Hint Server mode for remote Hint Tracking.
- Ignored
-N | --ignored [output file] : Report ignored files as specified in the JSON file.
- Include
-l | --library [library] : List of libraries to be included during processing. May be repeated.
- Keep going
-g | --listener-keep-going : For a Publisher the "keep going" option skips sending the quit command to
the subscriber when the backup operation is complete. For a subscriber it skips ending with a fault on an
unexpected disconnect (EOL) and ignores quit commands. To stop a subscriber in this mode use the
-G | --listener-quit option.
- Mismatches
-m | --mismatches [output file] : Report mismatches which is a list of differences during back-up operations.
- Navigator
-n | --navigator : Run the ELS Navigator desktop application.
- No back-fill
-b | --no-back-fill : Disables attempting to "back fill" original media sources with new files, e.g. a new TV episode.
- Overwrite
-o | --overwrite : Overwrite any existing files, do not resume a partial remote file transfer.
- Preserve dates
-y | --preserve-dates : Retain original file dates.
- Quit Status Server
-G | --listener-quit that only sends the quit command to a remote subscriber, then exits.
- Targets
-t | --targets [file] : Specifying a targets file that describes libraries, their sources,
and the minimum free space for the library - is optional. It was the original
way to define where new content would go and will continue to be supported.
If targets are not specified ELS looks for "locations" defined in the library JSON
file. Locations describe minimum free space per storage location.
If those are not found the list of sources for the library in the library file
is used with a default minimum free space of 10GB. In all cases the order of
the definitions controls the order for searching where to place new content
for that library.
- Validate
-v | --validate : Validate a publisher library or collection file.
- What's New & What's New all
-w | --whatsnew [output file] : What's New output text file as a summary.
-W | --whatsnew-all [output file] : What's New output text file with all new items.
- Whitelist
-I | --ip-whitelist [file] : List of one-line IP addresses to filter and allow incoming connections. The whitelist
supports # style comments and blank lines. Each IP address is an IPv4 dotted address, e.g. 127.0.0.1, on separate lines.