GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
zelta-policy(8) System Manager’s Manual zelta-policy(8)

zelta policy - Execute a list of zelta backup operations from a configuration file.

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

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 example, 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.

In the zelta policy configuration file, you may override zelta backup’s default parameters as defined in zelta-backup(8). The following parameters are specific zelta policy:

–backup-root=dataset
The default target dataset for replication jobs. For example, if given backup_root of pool/Backups and a source dataset endpoint ofhost01:tank01/vm/myOS, the target dataset will be pool/Backups/myOS.
–prefix=num-elements
Construct a target name using backup_root plus the indicated number of source elements. If given a prefix of 1 in the previous example, the target will be pool/Backups/vm/myOS.
–host_prefix
Construct a target name using backup_root plus the source hostname. If enabled with the above example, the target will be pool/Backups/host01/vm/myOS.
–push_to:hostname
Change the default target endpoint from localhost to the indicated hostname.
–retry=num-retries
If replication fails, retry the indicated number of times. Note that the retry attempts are deferred until after all replciation jobs are attempted.
–threads=num-threads
Run the indicated number of concurrent backup jobs for each site.

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, equivalent to the paramemters of zelta backup.

For detailed documentation of the zelta policy configuraiton see zelta.conf.example.

/usr/local/etc/zelta/zelta.conf
The default configuration file locaiton.
/usr/local/etc/zelta/zelta.env
The default environment override file location.

For detailed documentation of the zelta environment variables see zelta.env.example.

The directory where zelta.conf and zelta.env will be loaded from.

cron(8), ssh(1), zelta(8), zelta-backup(8), zfs(8)

Daniel J. Bell bellta@belltower.it

https://zelta.space

Search for    or go to Top of page |  Section 8 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.