Sanoid

`services.sanoid.datasets`

Datasets to snapshot. Type: attribute set of (dataset/template options)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.datasets.<name>.autoprune`

Whether to automatically prune old snapshots. Type: null or boolean

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.datasets.<name>.autosnap`

Whether to automatically take snapshots. Type: null or boolean

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.datasets.<name>.daily`

Number of daily snapshots. Type: null or (unsigned integer, meaning >=0)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.datasets.<name>.hourly`

Number of hourly snapshots. Type: null or (unsigned integer, meaning >=0)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.datasets.<name>.monthly`

Number of monthly snapshots. Type: null or (unsigned integer, meaning >=0)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.datasets.<name>.processChildrenOnly`

Whether to only snapshot child datasets if recursing. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.datasets.<name>.process_children_only`

Whether to only snapshot child datasets if recursing. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.datasets.<name>.recursive`

Whether to recursively snapshot dataset children. You can also set this to "zfs" to handle datasets recursively in an atomic way without the possibility to override settings for child datasets.

Type: boolean or value "zfs" (singular enum)

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.datasets.<name>.useTemplate`

Names of the templates to use for this dataset. Type: list of configured template name

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.datasets.<name>.use_template`

Names of the templates to use for this dataset. Type: list of configured template name

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.datasets.<name>.yearly`

Number of yearly snapshots. Type: null or (unsigned integer, meaning >=0)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.enable`

Whether to enable Sanoid ZFS snapshotting service. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.extraArgs`

Extra arguments to pass to sanoid. See https://github.com/jimsalterjrs/sanoid/#sanoid-command-line-options for allowed options.

Type: list of string

Default

[ ]

Example

["--verbose""--readonly""--debug"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.interval`

Run sanoid at this interval. The default is to run hourly.

The format is described in {manpage}systemd.time(7).

Type: string

Default

"hourly"

Example

"daily"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.package`

The sanoid package to use. Type: package

Default

pkgs.sanoid

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.settings`

Free-form settings written directly to the config file. See https://github.com/jimsalterjrs/sanoid/blob/master/sanoid.defaults.conf for allowed values.

Type: attribute set of dataset/template options

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.templates`

Templates for datasets. Type: attribute set of (dataset/template options)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.templates.<name>.autoprune`

Whether to automatically prune old snapshots. Type: null or boolean

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.templates.<name>.autosnap`

Whether to automatically take snapshots. Type: null or boolean

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.templates.<name>.daily`

Number of daily snapshots. Type: null or (unsigned integer, meaning >=0)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.templates.<name>.hourly`

Number of hourly snapshots. Type: null or (unsigned integer, meaning >=0)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.templates.<name>.monthly`

Number of monthly snapshots. Type: null or (unsigned integer, meaning >=0)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix

`services.sanoid.templates.<name>.yearly`

Number of yearly snapshots. Type: null or (unsigned integer, meaning >=0)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/backup/sanoid.nix