Skip to content

Latest commit

 

History

History
106 lines (67 loc) · 2.08 KB

api.rst

File metadata and controls

106 lines (67 loc) · 2.08 KB

API

Enumerations

simplezfs.types.DatasetType

simplezfs.types.PEHelperMode

simplezfs.types.PropertySource

simplezfs.types.ZPoolHealth

Types

simplezfs.types.Dataset

simplezfs.types.Property

Interfaces

ZFS

simplezfs.zfs.get_zfs

simplezfs.zfs.ZFS

ZPool

simplezfs.zpool.get_zpool

simplezfs.zpool.ZPool

Implementations

simplezfs.zfs_cli.ZFSCli

simplezfs.zfs_native.ZFSNative

simplezfs.zpool_cli.ZPoolCli

simplezfs.zpool_native.ZPoolNative

Privilege escalation

simplezfs.pe_helper.PEHelperBase

simplezfs.pe_helper.ExternalPEHelper

simplezfs.pe_helper.SudoPEHelper

Validation functions

A set of validation functions exist to validate names and other data. All of them raise a simplezfs.exceptions.ValidationError as a result of a failed validation and return nothing if everything is okay.

simplezfs.validation.validate_dataset_name

simplezfs.validation.validate_dataset_path

simplezfs.validation.validate_native_property_name

simplezfs.validation.validate_metadata_property_name

simplezfs.validation.validate_pool_name

simplezfs.validation.validate_property_value

Exceptions

simplezfs.exceptions.ZFSException

simplezfs.exceptions.DatasetNotFound

simplezfs.exceptions.PermissionError

simplezfs.exceptions.PoolNotFound

simplezfs.exceptions.PropertyNotFound

simplezfs.exceptions.ValidationError