libioc.errors module

Collection of iocage errors.

exception libioc.errors.ActivationFailed(reason=None, logger=None)

Bases: libioc.errors.IocException

Raised when ZFS pool activation failed.

exception libioc.errors.BackupInProgress(logger=None)

Bases: libioc.errors.IocException

Raised when a backup operation is already in progress.

exception libioc.errors.BackupSourceDoesNotExist(source, logger=None)

Bases: libioc.errors.IocException

Raised when a backup source is not available for import.

exception libioc.errors.BackupSourceUnknownFormat(source, logger=None)

Bases: libioc.errors.IocException

Raised when a backup source is in unknown format.

exception libioc.errors.CannotRedrawLine(reason=None, logger=None)

Bases: libioc.errors.LogException

Raised when manipulating previous log entries fails.

exception libioc.errors.CommandFailure(returncode, logger=None)

Bases: libioc.errors.IocException

Raised when iocage fails to execute a command.

exception libioc.errors.ConflictingResourceSelection(source_a, source_b, logger=None)

Bases: libioc.errors.IocException

Raised when a resource was configured with conflicting sources.

exception libioc.errors.DatasetExists(dataset_name, logger=None)

Bases: libioc.errors.IocException

Raised when a dataset already exists.

exception libioc.errors.DatasetNotAvailable(dataset_name, logger=None)

Bases: libioc.errors.IocException

Raised when a dataset is not available.

exception libioc.errors.DatasetNotJailed(dataset, logger=None)

Bases: libioc.errors.IocException

Raised when a ZFS share was not flagged as such.

exception libioc.errors.DatasetNotMounted(dataset, logger=None)

Bases: libioc.errors.IocException

Raised when a dataset is not mounted but should be.

exception libioc.errors.DefaultConfigNotFound(config_file_path, logger=None)

Bases: libioc.errors.IocException, FileNotFoundError

Raised when no default config was found on the host.

exception libioc.errors.DefaultReleaseNotFound(host_release_name, logger=None)

Bases: libioc.errors.IocException

Raised when the default (host) release does not match a remote.

exception libioc.errors.DevfsRuleException(message, logger=None)

Bases: libioc.errors.IocException

Raised on errors in devfs rules.

exception libioc.errors.DistributionUnknown(distribution_name, logger=None)

Bases: libioc.errors.IocException

Raised when the host distribution is unknown or not supported.

exception libioc.errors.DownloadFailed(url, code, logger=None, level='error')

Bases: libioc.errors.IocException

Raised when downloading EOL warnings failed.

exception libioc.errors.DuplicateDevfsRuleset(devfs_rules_file, reason=None, logger=None)

Bases: libioc.errors.DevfsRuleException

Raised when a duplicate devfs rule was found.

exception libioc.errors.EventAlreadyFinished(event, logger=None)

Bases: libioc.errors.IocException

Raised when a event is touched that was already finished.

exception libioc.errors.ExportDestinationExists(destination, logger=None)

Bases: libioc.errors.IocException

Raised when a backup operation is already in progress.

exception libioc.errors.FirewallCommandFailure(logger=None)

Bases: libioc.errors.IocException

Raised when a firewall command fails (Secure VNET).

exception libioc.errors.FirewallDisabled(hint=None, logger=None)

Bases: libioc.errors.IocException

Raised when the firewall is required but disabled (Secure VNET).

exception libioc.errors.FstabDestinationExists(mountpoint, logger=None)

Bases: libioc.errors.IocException

Raised when the destination directory does not exist.

exception libioc.errors.HostReleaseUnknown(logger=None)

Bases: libioc.errors.IocException

Raised when the host release could not be determined.

exception libioc.errors.HostUserlandVersionUnknown(logger=None)

Bases: libioc.errors.IocException

Raised when the hosts userland version could not be detected.

exception libioc.errors.IllegalArchiveContent(asset_name, reason, logger=None)

Bases: libioc.errors.IocException

Raised when a release asset archive contains malicious content.

exception libioc.errors.InsecureJailPath(path, logger=None)

Bases: libioc.errors.SecurityViolation

Raised when a a path points outside of a resource.

exception libioc.errors.InvalidDevfsRulesSyntax(devfs_rules_file, reason=None, logger=None)

Bases: libioc.errors.DevfsRuleException

Raised when a devfs rule has invalid syntax.

exception libioc.errors.InvalidIPAddress(reason, ipv6, logger=None, level='error')

Bases: libioc.errors.IocException

Raised when an invalid IP address was assigned to a network.

exception libioc.errors.InvalidInterfaceName(logger=None)

Bases: libioc.errors.IocException

Raised when a NIC name is invalid.

exception libioc.errors.InvalidJailConfigAddress(value, property_name, jail=None, logger=None, level='error')

Bases: libioc.errors.InvalidJailConfigValue

Raised when a jail address is invalid.

exception libioc.errors.InvalidJailConfigValue(property_name, jail=None, reason=None, logger=None, level='error')

Bases: libioc.errors.JailConfigError, ValueError

Raised when a jail configuration value is invalid.

exception libioc.errors.InvalidJailName(name, invalid_characters=None, logger=None)

Bases: libioc.errors.JailConfigError

Raised when a jail has an invalid name.

exception libioc.errors.InvalidLogLevel(log_level, logger=None)

Bases: libioc.errors.IocException

Raised when the logger was initialized with an invalid log level.

exception libioc.errors.InvalidMacAddress(mac_address, logger=None)

Bases: libioc.errors.IocException, ValueError

Raised when a jail MAC address is invalid.

exception libioc.errors.InvalidMountpoint(mountpoint, logger=None)

Bases: libioc.errors.IocException

Raised when a mountpoint was invalid or not found.

exception libioc.errors.InvalidNetworkBridge(reason=None, logger=None)

Bases: libioc.errors.IocException, ValueError

Raised when a network bridge is invalid.

exception libioc.errors.InvalidReleaseAssetSignature(name, asset_name, logger=None)

Bases: libioc.errors.UpdateFailure

Raised when a release signature is invalid.

exception libioc.errors.InvalidReleaseName(name, logger=None)

Bases: libioc.errors.IocException

Raised when interacting with an unsupported release.

exception libioc.errors.InvalidSnapshotIdentifier(identifier, logger=None)

Bases: libioc.errors.SnapshotError

Raised when a snapshot identifier is invalid.

exception libioc.errors.InvalidSourceName(logger=None)

Bases: libioc.errors.IocException

Raised when a source name is invalid.

exception libioc.errors.IocException(message, level='error', silent=False, append_warning=False, warning=None, logger=None)

Bases: Exception

A well-known exception raised by liblibioc.

exception libioc.errors.IocageNotActivated(logger=None)

Bases: libioc.errors.IocException

Raised when iocage is not active on any ZFS pool.

exception libioc.errors.JailAlreadyExists(jail, logger=None)

Bases: libioc.errors.IocException

Raised when the jail already exists.

exception libioc.errors.JailAlreadyRunning(jail, logger=None)

Bases: libioc.errors.IocException

Raised when the jail is already running.

exception libioc.errors.JailBackendMissing(logger=None)

Bases: libioc.errors.IocException

Raised when the jails backend was not found.

exception libioc.errors.JailCommandFailed(returncode, logger=None)

Bases: libioc.errors.IocException

Raised when a jail command fails with an exit code > 0.

exception libioc.errors.JailConfigError(message, level='error', silent=False, append_warning=False, warning=None, logger=None)

Bases: libioc.errors.IocException

Raised when a general configuration error occurs.

exception libioc.errors.JailConfigNotFound(config_type, logger=None)

Bases: libioc.errors.IocException

Raised when a jail is not configured.

exception libioc.errors.JailConigZFSIsNotAllowed(logger=None)

Bases: libioc.errors.JailConfigError

Raised when a jail is not allowed to use ZFS shares.

exception libioc.errors.JailDestructionFailed(jail, logger=None)

Bases: libioc.errors.JailException

Raised when the jail could not be destroyed.

exception libioc.errors.JailDoesNotExist(jail, logger=None)

Bases: libioc.errors.JailException

Raised when the jail does not exist.

exception libioc.errors.JailException(jail, message, logger=None)

Bases: libioc.errors.IocException

Raised when an exception related to a jail occurs.

exception libioc.errors.JailExecutionAborted(jail, logger=None)

Bases: libioc.errors.JailException

Raised when a jail command fails with an exit code > 0.

exception libioc.errors.JailFilterException(message, logger=None)

Bases: libioc.errors.IocException

Raised when a jail filter is invalid.

exception libioc.errors.JailFilterInvalidName(logger=None)

Bases: libioc.errors.JailFilterException

Raised when the name of a jail filter is invalid.

exception libioc.errors.JailHookFailed(jail, hook, logger=None)

Bases: libioc.errors.JailException

Raised when the jail could not be launched.

exception libioc.errors.JailHostIdMismatch(host_hostid, jail, logger=None)

Bases: libioc.errors.JailException

Raised when attempting to start a jail with mismatching hostid.

exception libioc.errors.JailIsTemplate(jail, logger=None)

Bases: libioc.errors.JailException

Raised when the jail is a template but should not be.

exception libioc.errors.JailLaunchFailed(jail, reason=None, logger=None)

Bases: libioc.errors.JailException

Raised when the jail could not be launched.

exception libioc.errors.JailNotFound(text, logger=None)

Bases: libioc.errors.IocException

Raised when the jail was not found.

exception libioc.errors.JailNotRunning(jail, logger=None)

Bases: libioc.errors.IocException

Raised when the jail is not running.

exception libioc.errors.JailNotSupplied(logger=None)

Bases: libioc.errors.IocException

Raised when no jail was supplied.

exception libioc.errors.JailNotTemplate(jail, logger=None)

Bases: libioc.errors.JailException

Raised when the jail is no template but should be one.

exception libioc.errors.JailStateUpdateFailed(logger=None)

Bases: libioc.errors.IocException

Raised when a JLS query failed.

exception libioc.errors.JailUnknownIdentifier(logger=None)

Bases: libioc.errors.IocException

Raised when the jail has an unknown identifier.

exception libioc.errors.ListableResourceNamespaceUndefined(logger=None)

Bases: libioc.errors.IocException

Raised when a ListableResource was not defined with a namespace.

exception libioc.errors.LogException(message, logger=None)

Bases: libioc.errors.IocException

Raised when logging fails.

exception libioc.errors.MissingDevfsRulesetName(devfs_rules_file, logger=None)

Bases: libioc.errors.DevfsRuleException

Raised when a duplicate devfs rule was found.

exception libioc.errors.MissingFeature(feature_name, plural=False, logger=None)

Bases: libioc.errors.IocException, NotImplementedError

Raised when an iocage feature is not fully implemented yet.

exception libioc.errors.MountFailed(mountpoint, reason=None, logger=None)

Bases: libioc.errors.IocException

Raised when a mount operation fails.

exception libioc.errors.MustBeRoot(message, logger=None)

Bases: libioc.errors.IocException

Raised when iocage is executed without root permission.

exception libioc.errors.NonReleaseUpdateFetch(resource, logger=None)

Bases: libioc.errors.UpdateFailure

Raised when attempting to fetch updates for a custom release.

exception libioc.errors.NotAnIocageZFSProperty(property_name, logger=None)

Bases: libioc.errors.IocException

Raised when iocage attempts to touch a non-iocage ZFS property.

exception libioc.errors.PkgNotFound(message=None, logger=None)

Bases: libioc.errors.IocException

Raised when the pkg package was not found in the local mirror.

exception libioc.errors.ReleaseAssetHashesUnavailable(logger=None)

Bases: libioc.errors.IocException

Raised when the list could not be downloaded from the remote.

exception libioc.errors.ReleaseListUnavailable(logger=None)

Bases: libioc.errors.IocException

Raised when the list could not be downloaded from the remote.

exception libioc.errors.ReleaseNotFetched(name, logger=None)

Bases: libioc.errors.IocException

Raised when a release was not yet fetched.

exception libioc.errors.ReleaseUpdateBranchLookup(release_name, reason=None, logger=None)

Bases: libioc.errors.IocException

Raised when failing to lookup the remote update branch.

exception libioc.errors.ResourceLimitActionFailed(action, logger=None)

Bases: libioc.errors.IocException, KeyError

Raised when a resource limit has is unknown.

exception libioc.errors.ResourceLimitUnknown(logger=None)

Bases: libioc.errors.IocException, KeyError

Raised when a resource limit has is unknown.

exception libioc.errors.ResourceUnmanaged(dataset_name, logger=None)

Bases: libioc.errors.IocException

Raised when locating a resources dataset on a root dataset fails.

exception libioc.errors.SecurityViolation(reason, logger=None)

Bases: libioc.errors.IocException

Raised when iocage has security concerns.

exception libioc.errors.SecurityViolationConfigJailEscape(file, logger=None)

Bases: libioc.errors.SecurityViolation

Raised when a file symlinks to a location outside of the jail.

exception libioc.errors.SnapshotCreation(reason=None, logger=None)

Bases: libioc.errors.SnapshotError

Raised when creating a snapshot failed.

exception libioc.errors.SnapshotDeletion(reason=None, logger=None)

Bases: libioc.errors.SnapshotError

Raised when deleting a snapshot failed.

exception libioc.errors.SnapshotError(message, logger=None)

Bases: libioc.errors.IocException

Raised on snapshot related errors.

exception libioc.errors.SnapshotNotFound(snapshot_name, dataset_name, logger=None)

Bases: libioc.errors.SnapshotError

Raised when a snapshot was not found.

exception libioc.errors.SnapshotRollback(reason=None, logger=None)

Bases: libioc.errors.SnapshotError

Raised when rolling back a snapshot failed.

exception libioc.errors.SourceNotFound(logger=None)

Bases: libioc.errors.IocException

Raised when a source was not found.

exception libioc.errors.UndefinedProvisionerMethod(logger=None)

Bases: libioc.errors.IocException

Raised when a provisioner method is not set.

exception libioc.errors.UndefinedProvisionerSource(logger=None)

Bases: libioc.errors.IocException

Raised when a provisioner source is not set.

exception libioc.errors.UnknownConfigProperty(key, logger=None, level='error', jail=None)

Bases: libioc.errors.IocException, KeyError

Raised when a unknown jail config property was used.

exception libioc.errors.UnmountFailed(mountpoint=None, reason=None, logger=None)

Bases: libioc.errors.IocException

Raised when an unmount operation fails.

exception libioc.errors.UnsupportedRelease(version, logger=None)

Bases: libioc.errors.MissingFeature

Raised when interacting with an unsupported release.

exception libioc.errors.UpdateFailure(name, reason=None, logger=None, level='error')

Bases: libioc.errors.IocException

Raised when an update fails.

exception libioc.errors.VirtualFstabLineHasNoRealIndex(logger=None)

Bases: libioc.errors.IocException

Raised when attempting to access the index of a virtual fstab line.

exception libioc.errors.VnetBridgeDoesNotExist(bridge_name, logger=None)

Bases: libioc.errors.IocException

Raised when a vnet bridge is missing.

exception libioc.errors.VnetBridgeMissing(logger=None)

Bases: libioc.errors.IocException

Raised when a vnet bridge is missing.

exception libioc.errors.ZFSException(message, logger=None)

Bases: libioc.errors.IocException

Raised when a ZFS pool not available.

exception libioc.errors.ZFSPoolInvalid(consequence, logger=None)

Bases: libioc.errors.IocException, TypeError

Raised when a ZFS pool is invalid.

exception libioc.errors.ZFSPoolUnavailable(pool_name, logger=None)

Bases: libioc.errors.IocException

Raised when a ZFS pool not available.

exception libioc.errors.ZFSSourceMountpoint(dataset_name, logger=None)

Bases: libioc.errors.IocException

Raised when iocage could not determine its mountpoint.