Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
zelta-policy(8) 	     System Manager's Manual		 zelta-policy(8)

NAME
     zelta policy - execute a list of zelta backup operations from a policy con-
     figuration

SYNOPSIS
     zelta policy [backup-override-options] [site|host|dataset] ...

DESCRIPTION
     zelta  policy  reads from a simple YAML-style configuration file containing
     parameters for zelta backup.  Running zelta policy without parameters  will
     iterate through the entire configuration file.  Override options for either
     zelta policy or zelta backup can be provided on the command line, for exam-
     ple,  adding  --json  will  cause	that parameter to be passed to all zelta
     backup calls.  Subsequent undashed parameters will  be  matched  against  a
     user-defined  site  name,	host  name, or dataset, and the backup processes
     will be limited to that group or item.

   Options
     In the zelta policy configuration file, you may override zelta backup's de-
     fault parameters as defined in zelta-backup(8).  For the complete	list  of
     Zelta  configuration  options, see zelta-options(7).  The following parame-
     ters are specific zelta policy:

     --retry
	    Retry failed syncs the indicated number of times.

     --jobs
	    Run the indicated number of policy jobs concurrently, one  for  each
	    Site in the configuration.

     --backup-root
	    The   relative   target  path  for	the  target  job.   For  example
	    `bkhost:tank/Backups' would place backups below that dataset (if not
	    overridden).

     --host-prefix
	    Include the source hostname as a parent of the  synced  target,  for
	    example, `tank/Backups/source.host/backup-dataset'.

     --ds-prefix
	    Similar  to  `zfs recv -d' and `-e', include the indicated number of
	    parent labels for the target's synced name.  See `zelta help backup'
	    for more detail.

   Backup Job Parameters
     Without additional parameters, zelta policy will run a zelta backup job for
     each dataset in the configuration file.  Providing  one  of  the  following
     will limit the backup job.

     site  Run	a backup job only for the site listed.	A site is a user defined
     top-level parameter in the configuration file representing a list of one or
     more hosts.

     host Run a backup job only for the host listed.  Hosts must  be  accessible
     via SSH private-key authentication or localhost.

     dataset  Run a backup job only for the dataset listed.  Note this parameter
     can match the source or target dataset, e.g., requesting  zroot  would  run
     the replication for any matching dataset on any host.

     host:dataset  Specify  a source or backup dataset endpoint name, equivalent
     to the paramemters of zelta backup.

     dataset_pattern Specify the final source or target dataset label.	For  ex-
     ample, vm would run all backup jobs with datasets ending in /vm.

FILES
     For   detailed   documentation   of  the  zelta  policy  configuration  see
     zelta.conf.example.

     /usr/local/etc/zelta/zelta.conf
	    The default configuration file location.

ENVIRONMENT
     For detailed documentation of the zelta  environment  variables  see  zelta
     help options.

SEE ALSO
     zelta(8),	    zelta-clone(8),	 zelta-backup(8),      zelta-options(7),
     zelta-match(8),   zelta-revert(8),   zelta-rotate(8),    ssh(1),	 zfs(8),
     zfs-list(8)

AUTHORS
     Daniel J. Bell <bellhyve@zelta.space>

WWW
     https://zelta.space

								 zelta-policy(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=zelta-policy&sektion=8&manpath=FreeBSD+Ports+15.1.quarterly>

home | help