config

package

Go to main page

Versions in this module

v1

v1.2.0

Feb 15, 2026

v1.1.0

Nov 25, 2025

Changes in this version

type PositiveDurationOrManual

+ func (self *PositiveDurationOrManual) Duration() time.Duration

v1.0.0

Sep 1, 2025

v0

v0.9.11

Jul 21, 2025

v0.9.10

May 1, 2025

Changes in this version

type SnapshottingPeriodic

+ WrittenThreshold uint64

v0.9.9

Apr 13, 2025

v0.9.8

Mar 12, 2025

v0.9.7

Feb 27, 2025

v0.9.6

Feb 7, 2025

Changes in this version

type MonitorCount

+ SkipDatasets []DatasetFilter

type MonitorCreation

+ SkipDatasets []DatasetFilter

v0.9.5

Jan 27, 2025

Changes in this version

type SnapshottingPeriodic

+ Concurrency uint

v0.9.4

Jan 8, 2025

Changes in this version

type PassiveJob

+ Pruning PruningLocal

type Replication

+ Prefix string

type SourceJob

+ Replication Replication

v0.9.3

Dec 12, 2024

Changes in this version

type Config

+ IncludeJobs string

type Option

+ func WithoutIncludes() Option

v0.9.2

Nov 21, 2024

Changes in this version

type PruningLocal

+ Concurrency uint

type PruningSenderReceiver

+ Concurrency uint

type SendOptions

+ ListPlaceholders bool

v0.9.1

Nov 14, 2024

Changes in this version

type RecvOptions

+ Concurrency uint64

type SendOptions

+ Concurrency uint64

v0.9.0

Nov 8, 2024

Changes in this version

+ type AuthKey struct

+ Key string

+ Name string

type Config

+ IncludeKeys string

+ Keys []AuthKey

+ type Connect struct

+ ClientIdentity string

+ ListenerName string

+ Server string

+ Type string

type Listen

+ Zfs bool

+ type Option func(self *Config)

+ func WithSkipKeys() Option

type PassiveJob

+ ClientKeys []string

v0.8.10

Oct 27, 2024

Changes in this version

type ActiveJob

+ Hooks JobHooks

+ type DatasetFilter struct

+ Exclude bool

+ Pattern string

+ Recursive bool

+ Shell bool

type HookCommand

+ Args []string

+ Datasets []DatasetFilter

+ Env map[string]string

+ ErrIsFatal bool

+ func (self *HookCommand) UnmarshalYAML(value *yaml.Node) error

+ type JobHooks struct

+ Post *HookCommand

+ Pre *HookCommand

type PushJob

+ Datasets []DatasetFilter

type SnapJob

+ Datasets []DatasetFilter

type SourceJob

+ Datasets []DatasetFilter

v0.8.9

Oct 20, 2024

v0.8.8

Oct 18, 2024

Changes in this version

+ const RetentionGridKeepCountAll

+ var ConfigFileDefaultLocations = []string

+ func Validator() *validator.Validate

+ type ActiveJob struct

+ ConflictResolution ConflictResolution

+ Connect ConnectEnum

+ Cron string

+ Interval PositiveDurationOrManual

+ MonitorSnapshots MonitorSnapshots

+ Name string

+ Pruning PruningSenderReceiver

+ Replication Replication

+ Type string

+ func (self *ActiveJob) CronSpec() string

+ type BandwidthLimit struct

+ BucketCapacity datasizeunit.Bits

+ Max datasizeunit.Bits

+ type Config struct

+ Global Global

+ Jobs []JobEnum

+ Listen []Listen

+ func New() *Config

+ func ParseConfig(path string) (i *Config, err error)

+ func ParseConfigBytes(bytes []byte) (*Config, error)

+ func (c *Config) Job(name string) (*JobEnum, error)

+ type ConflictResolution struct

+ InitialReplication string

+ type ConnectCommon struct

+ Type string

+ type ConnectEnum struct

+ Ret any

+ func (t *ConnectEnum) UnmarshalYAML(value *yaml.Node) (err error)

+ type Duration struct

+ func (d *Duration) UnmarshalYAML(value *yaml.Node) error

+ func (d Duration) Duration() time.Duration

+ type FileLoggingOutlet struct

+ FileName string

+ type FilesystemsFilter map[string]bool

+ type Global struct

+ Control GlobalControl

+ Logging LoggingOutletEnumList

+ Monitoring []PrometheusMonitoring

+ RpcTimeout time.Duration

+ Serve GlobalServe

+ ZfsBin string

+ type GlobalControl struct

+ SockMode uint32

+ SockPath string

+ type GlobalServe struct

+ StdinServer *GlobalStdinServer

+ type GlobalStdinServer struct

+ SockDir string

+ type HookCommand struct

+ Filesystems FilesystemsFilter

+ Path string

+ Timeout time.Duration

+ type HookEnum struct

+ Ret any

+ func (t *HookEnum) UnmarshalYAML(value *yaml.Node) (err error)

+ type HookList []HookEnum

+ type HookSettingsCommon struct

+ ErrIsFatal bool

+ Type string

+ type JobEnum struct

+ Ret any

+ func (j JobEnum) MonitorSnapshots() MonitorSnapshots

+ func (j JobEnum) Name() string

+ func (t *JobEnum) UnmarshalYAML(value *yaml.Node) (err error)

+ type Listen struct

+ Addr string

+ Control bool

+ Metrics bool

+ TLSCert string

+ TLSKey string

+ Unix string

+ UnixMode uint32

+ type LocalConnect struct

+ ClientIdentity string

+ DialTimeout time.Duration

+ ListenerName string

+ type LocalServe struct

+ ListenerName string

+ type LoggingOutletCommon struct

+ Format string

+ HideFields []string

+ Level string

+ Time bool

+ Type string

+ type LoggingOutletEnum struct

+ Ret any

+ func (t *LoggingOutletEnum) UnmarshalYAML(value *yaml.Node) (err error)

+ type LoggingOutletEnumList []LoggingOutletEnum

+ func (l *LoggingOutletEnumList) SetDefaults()

+ type MonitorCount struct

+ Critical uint

+ Prefix string

+ Warning uint

+ type MonitorCreation struct

+ Critical time.Duration

+ Prefix string

+ Warning time.Duration

+ type MonitorSnapshots struct

+ Count []MonitorCount

+ Latest []MonitorCreation

+ Oldest []MonitorCreation

+ func (self *MonitorSnapshots) Valid() bool

+ type ParseFlags uint

+ const ParseFlagsNoCertCheck

+ const ParseFlagsNone

+ type PassiveJob struct

+ MonitorSnapshots MonitorSnapshots

+ Name string

+ Serve ServeEnum

+ Type string

+ type PlaceholderRecvOptions struct

+ Encryption string

+ type PositiveDuration struct

+ func (d *PositiveDuration) UnmarshalYAML(value *yaml.Node) error

+ func (d PositiveDuration) Duration() time.Duration

+ type PositiveDurationOrManual struct

+ Interval time.Duration

+ Manual bool

+ func (i *PositiveDurationOrManual) UnmarshalYAML(value *yaml.Node) (err error)

+ type PrometheusMonitoring struct

+ Listen string

+ ListenFreeBind bool

+ Type string

+ type PropertyRecvOptions struct

+ Inherit []zfsprop.Property

+ Override map[zfsprop.Property]string

+ type PruneGrid struct

+ Grid RetentionIntervalList

+ Regex string

+ Type string

+ type PruneKeepLastN struct

+ Count int

+ Regex string

+ Type string

+ type PruneKeepNotReplicated struct

+ KeepSnapshotAtCursor bool

+ Type string

+ type PruneKeepRegex struct

+ Negate bool

+ Regex string

+ Type string

+ type PruningEnum struct

+ Ret any

+ func (t *PruningEnum) UnmarshalYAML(value *yaml.Node) (err error)

+ type PruningLocal struct

+ Keep []PruningEnum

+ type PruningSenderReceiver struct

+ KeepReceiver []PruningEnum

+ KeepSender []PruningEnum

+ type PullJob struct

+ Recv RecvOptions

+ RootFS string

+ func (j *PullJob) GetAppendClientIdentity() bool

+ func (j *PullJob) GetRecvOptions() *RecvOptions

+ func (j *PullJob) GetRootFS() string

+ type PushJob struct

+ Filesystems FilesystemsFilter

+ Send SendOptions

+ Snapshotting SnapshottingEnum

+ func (j *PushJob) GetFilesystems() FilesystemsFilter

+ func (j *PushJob) GetSendOptions() *SendOptions

+ type RecvOptions struct

+ BandwidthLimit BandwidthLimit

+ ExecPipe [][]string

+ Placeholder PlaceholderRecvOptions

+ Properties PropertyRecvOptions

+ type Replication struct

+ Concurrency ReplicationOptionsConcurrency

+ OneStep bool

+ Protection ReplicationOptionsProtection

+ type ReplicationOptionsConcurrency struct

+ SizeEstimates int

+ Steps int

+ type ReplicationOptionsProtection struct

+ Incremental string

+ Initial string

+ type RetentionInterval struct

+ func ParseRetentionIntervalSpec(s string) (intervals []RetentionInterval, err error)

+ func (i *RetentionInterval) KeepCount() int

+ func (i *RetentionInterval) Length() time.Duration

+ type RetentionIntervalList []RetentionInterval

+ func (t *RetentionIntervalList) UnmarshalYAML(value *yaml.Node) (err error)

+ type SSHStdinserverConnect struct

+ DialTimeout time.Duration

+ Host string

+ IdentityFile string

+ Options []string

+ Port uint16

+ SSHCommand string

+ TransportOpenCommand []string

+ User string

+ type SendOptions struct

+ BackupProperties bool

+ BandwidthLimit BandwidthLimit

+ Compressed bool

+ EmbeddedData bool

+ Encrypted bool

+ ExecPipe [][]string

+ LargeBlocks bool

+ Raw bool

+ Saved bool

+ SendProperties bool

+ type ServeCommon struct

+ Type string

+ type ServeEnum struct

+ Ret any

+ func (t *ServeEnum) UnmarshalYAML(value *yaml.Node) (err error)

+ type SinkJob struct

+ Recv RecvOptions

+ RootFS string

+ func (j *SinkJob) GetAppendClientIdentity() bool

+ func (j *SinkJob) GetRecvOptions() *RecvOptions

+ func (j *SinkJob) GetRootFS() string

+ type SnapJob struct

+ Filesystems FilesystemsFilter

+ MonitorSnapshots MonitorSnapshots

+ Name string

+ Pruning PruningLocal

+ Snapshotting SnapshottingEnum

+ Type string

+ type SnapshottingEnum struct

+ Ret any

+ func (t *SnapshottingEnum) UnmarshalYAML(value *yaml.Node) (err error)

+ type SnapshottingManual struct

+ Type string

+ type SnapshottingPeriodic struct

+ Cron string

+ Hooks HookList

+ Interval Duration

+ Prefix string

+ TimestampFormat string

+ TimestampLocal bool

+ Type string

+ func (self *SnapshottingPeriodic) CronSpec() string

+ type SourceJob struct

+ Filesystems FilesystemsFilter

+ Send SendOptions

+ Snapshotting SnapshottingEnum

+ func (j *SourceJob) GetFilesystems() FilesystemsFilter

+ func (j *SourceJob) GetSendOptions() *SendOptions

+ type StdinserverServer struct

+ ClientIdentities []string

+ type SyslogFacility syslog.Priority

+ func (f *SyslogFacility) SetDefaults()

+ func (f *SyslogFacility) UnmarshalJSON(b []byte) error

+ func (t *SyslogFacility) UnmarshalYAML(value *yaml.Node) (err error)

+ type SyslogLoggingOutlet struct

+ Facility SyslogFacility

+ RetryInterval time.Duration

+ type TCPConnect struct

+ Address string

+ DialTimeout time.Duration

+ type TCPLoggingOutlet struct

+ Address string

+ Net string

+ RetryInterval time.Duration

+ TLS *TCPLoggingOutletTLS

+ type TCPLoggingOutletTLS struct

+ CA string

+ Cert string

+ Key string

+ type TCPServe struct

+ Clients map[string]string

+ Listen string

+ ListenFreeBind bool

+ type TLSConnect struct

+ Address string

+ Ca string

+ Cert string

+ DialTimeout time.Duration

+ Key string

+ ServerCN string

+ type TLSServe struct

+ Ca string

+ Cert string

+ ClientCNs []string

+ HandshakeTimeout time.Duration

+ Key string

+ Listen string

+ ListenFreeBind bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL