NOTE. OPTIMUMCACHE IS NO LONGER SUPPORTED.

 

OptimumCache is controlled using occtl command line utility.

 

usage:

occtl.py

[-h] [--move-ploop param [param ...]] [--check] [--verbose]

[--init-ploop [param [param ...]]] [--resize-ploop New Size]

[--disable-ploop] [--enable-ploop] [--mount-ploop]

[--unmount-ploop] [--delete-ploop] [--unmark-all]

[--mark-dir Path [Path ...]] [--unmark-dir Path [Path ...]]

[--recursive]  [--add-skip-mask Regex]

[--remove-skip-mask Id|Tag] [--list-skip-mask] [--silent]

[--ignore-unmount-failure] [--no-lve-limits] [--foreground]

[--ploop-status] [--remount-cached-points] [--purge]

[--cancel-pending-jobs] [--report [Period]]

[--recommend-minmax-size]

 

Display numbers/percents of cached files:

 

optimumcache stat

 

or

 

optimumcache stat /home

 

To display statistic for specific mount. In depth display what is being held in cache:

 

optimumcache dump [--resolve-filenames] [mount]

 

The option '--resolve-filenames' is experimental and may not apply to all output cached entries.

 

Optional Arguments:

 

-h, --help

Show this help message and exit.

--move-ploop param [param ...]

Move cache from one ploop image to /path/to/new/image/location [New Size[KMGT]].

--check

Check marked files for errors. This task is scheduled as background job, unless --foreground is specified.

--verbose

List what is being checked.

--init-ploop [param [param ...]]

Create ploop image for the cache [/path/to/ploop/image [ploop_size] | ploop_size] - if only one parameter is given, it is considered to be ploop size. Size should be a NUMBER[KMGT].

--resize-ploop New Size

New Size NUMBER[KMGT].

--disable-ploop

Disable ploop.

--enable-ploop

Enable ploop.

--mount-ploop

Mount ploop image.

--unmount-ploop

Unmount ploop image.

--delete-ploop

Delete ploop image. Implies disable ploop, if was enabled.

--unmark-all

Unmark all marked directories.

--mark-dir Path [Path ...]

Mark directory for caching.This task is scheduled as background job, unless --foreground is specified.

--unmark-dir Path [Path ...]

Unmark directory for caching.

--recursive

Is used with mark/unmark dir.

--add-skip-mask Regex

Regexp to skip files/directories for caching.

--remove-skip-mask Id|Tag

Remove regexp to skip files/directories by id or tag.

--list-skip-mask

List regexp to skip files/directories.

--silent

Do not echo status to stdout/syslog.

--ignore-unmount-failure

Ignore cannot unmount ploop problem.

--no-lve-limits

Ignore default LVE limits for --mark-dir and --check commands. Also implies --foreground.

--foreground

Don't spawn --mark-dir and --check commands in background.

--ploop-status

Check if ploop is mounted.

--purge

Purge cache storage (takes some time).

--cancel-pending-jobs

Cancel --mark-dir and --check commands if were queued or are being run in background.

--report [Period]

Report statistics for Period (hourly|daily|weekly|monthly).