libioc.ZFS module

ioc libzfs enhancement module.

class libioc.ZFS.ZFS[source]

Bases: libzfs.ZFS

libzfs enhancement module.

clone_dataset(source, target, delete_existing=False)[source]

Clone a ZFSDataset from a source to a target dataset name.

Return type

None

clone_snapshot(snapshot, target)[source]

Clone a ZFSSnapshot to the target dataset name.

Return type

None

create_dataset(dataset_name)[source]

Automatically get the pool and create a dataset from its name.

Return type

ZFSDataset

delete_dataset_recursive(dataset, delete_snapshots=True, delete_origin_snapshot=False)[source]

Recursively delete a dataset.

Return type

None

get_or_create_dataset(dataset_name)[source]

Find or create the dataset, then return it.

Return type

ZFSDataset

get_pool(name)[source]

Get the pool with a given name.

Return type

ZFSPool

property logger

Return logger or raise an exception when it is unavailable.

Return type

Logger

promote_dataset(dataset, logger=None)[source]

Recursively promote a dataset.

Return type

None

rename_snapshot_recursive(snapshot, new_name)[source]

Rename a snapshot recursively.

Return type

None

libioc.ZFS.append_snapshot_datetime(text)[source]

Append the current datetime string to a snapshot name.

Return type

str

libioc.ZFS.get_zfs(logger=None, history=True, history_prefix='<iocage>')[source]

Get an instance of iocages enhanced ZFS class.

Return type

ZFS