zfsa-job-add(1)

Schedule a scrub or trim of a pool

ZFS Assistant 0.7.0

NAME

zfsa-job-add - Schedule a scrub or trim of a pool

SYNOPSIS

zfsa job add [GLOBAL OPTIONS] [--schedule] [--oncalendar] [--cron] [-h|--help] <KIND> <POOL>

DESCRIPTION

Schedule a scrub or trim of a pool.

The job's id is the kind and the pool, such as scrub-tank. Schedules use the computer's local time. --oncalendar and --cron work only with the scheduler they belong to; zfsa schedule show says which one is in use.

OPTIONS

--schedule <SCHEDULE>

A schedule such as "monthly first sun 03:00", "weekly sat 04:00" or "every 15m"

--oncalendar <EXPRESSION>

A raw systemd OnCalendar expression (works with the systemd scheduler only)

--cron <EXPRESSION>

A raw cron expression of five fields (works with cron only)

-h, --help

Print help (see a summary with '-h')

<KIND>

Scrub or trim

Possible values:

  • scrub: A scrub

  • trim: A trim

<POOL>

The pool

EXAMPLES

Scrub tank on the first Sunday of every month at 03:00:

zfsa job add scrub tank --schedule "monthly first sun 03:00"

Trim tank weekly, at the default time:

zfsa job add trim tank

SEE ALSO

zfsa(1) for the global options, authorization, confirmations and exit status, zfsa-job(1).