mcvirt package

Subpackages

• mcvirt.auth package
  • Submodules
  • mcvirt.auth.auth module
  • mcvirt.auth.cluster_user module
  • mcvirt.auth.connection_user module
  • mcvirt.auth.factory module
  • mcvirt.auth.permissions module
  • mcvirt.auth.session module
  • mcvirt.auth.user module
  • mcvirt.auth.user_base module
  • Module contents
• mcvirt.client package
  • Submodules
  • mcvirt.client.rpc module
  • Module contents
• mcvirt.cluster package
  • Submodules
  • mcvirt.cluster.cluster module
  • mcvirt.cluster.remote module
  • Module contents
• mcvirt.iso package
  • Submodules
  • mcvirt.iso.factory module
  • mcvirt.iso.iso module
  • Module contents
• mcvirt.node package
  • Subpackages
    • mcvirt.node.network package
      • Submodules
      • mcvirt.node.network.factory module
      • mcvirt.node.network.network module
      • Module contents
  • Submodules
  • mcvirt.node.drbd module
  • mcvirt.node.libvirt_config module
  • mcvirt.node.node module
  • Module contents
• mcvirt.rpc package
  • Submodules
  • mcvirt.rpc.certificate_generator module
  • mcvirt.rpc.certificate_generator_factory module
  • mcvirt.rpc.constants module
  • mcvirt.rpc.daemon_lock module
  • mcvirt.rpc.lock module
  • mcvirt.rpc.name_server module
  • mcvirt.rpc.pyro_object module
  • mcvirt.rpc.rpc_daemon module
  • mcvirt.rpc.ssl_socket module
  • Module contents
• mcvirt.test package
  • Subpackages
    • mcvirt.test.lock package
      • Submodules
      • mcvirt.test.lock.lock_tests module
      • Module contents
    • mcvirt.test.node package
      • Submodules
      • mcvirt.test.node.network_tests module
      • mcvirt.test.node.node_tests module
      • Module contents
    • mcvirt.test.virtual_machine package
      • Subpackages
        • mcvirt.test.virtual_machine.hard_drive package
          • Submodules
          • mcvirt.test.virtual_machine.hard_drive.drbd_tests module
          • Module contents
      • Submodules
      • mcvirt.test.virtual_machine.online_migrate_tests module
      • mcvirt.test.virtual_machine.virtual_machine_tests module
      • Module contents
  • Submodules
  • mcvirt.test.auth_tests module
  • mcvirt.test.run_tests module
  • mcvirt.test.test_base module
  • mcvirt.test.unit_test_bootstrap module
  • mcvirt.test.update_tests module
  • mcvirt.test.validation_tests module
  • Module contents
• mcvirt.virtual_machine package
  • Subpackages
    • mcvirt.virtual_machine.hard_drive package
      • Submodules
      • mcvirt.virtual_machine.hard_drive.base module
      • mcvirt.virtual_machine.hard_drive.drbd module
      • mcvirt.virtual_machine.hard_drive.factory module
      • mcvirt.virtual_machine.hard_drive.local module
      • Module contents
    • mcvirt.virtual_machine.network_adapter package
      • Submodules
      • mcvirt.virtual_machine.network_adapter.factory module
      • mcvirt.virtual_machine.network_adapter.network_adapter module
      • Module contents
  • Submodules
  • mcvirt.virtual_machine.disk_drive module
  • mcvirt.virtual_machine.factory module
  • mcvirt.virtual_machine.virtual_machine module
  • mcvirt.virtual_machine.virtual_machine_config module
  • Module contents

Submodules

mcvirt.argument_validator module

Argument validators.

class mcvirt.argument_validator.ArgumentValidator

Bases: object

Provide methods to validate argument values

static validate_boolean(variable)

Ensure variable is a boolean

static validate_drbd_resource(variable)

Validate DRBD resource name

static validate_hostname(hostname)

Validate a hostname

static validate_integer(value)

Validate integer

static validate_network_name(name)

Validate the name of a network

static validate_positive_integer(value)

Validate that a given variable is a positive integer

mcvirt.bash-complete module

mcvirt.config_file module

Provide base class for configuration files

class mcvirt.config_file.ConfigFile

Bases: object

Provides operations to obtain and set the MCVirt configuration for a VM

CURRENT_VERSION = 4

GIT = '/usr/bin/git'

static create()

Creates a basic VM configuration for new VMs

getPermissionConfig()

get_config()

Load the VM configuration from disk and returns the parsed JSON.

static get_config_path(vm_name)

Provide the path of the VM-specific configuration file

gitAdd(message='')

Commits changes to an added or modified configuration file

gitRemove(message='')

Removes and commits a configuration file

setConfigPermissions()

Sets file permissions for config directories

update_config(callback_function, reason='')

Write a provided configuration back to the configuration file.

upgrade()

Performs an upgrade of the config file

mcvirt.constants module

Provide constants used throughout MCVirt.

class mcvirt.constants.DirectoryLocation

Bases: object

Provides directory/file path constants.

BASE_STORAGE_DIR = '/var/lib/mcvirt'

BASE_VM_STORAGE_DIR = '/var/lib/mcvirt/build-4189623-project-52530-mcvirt/vm'

ISO_STORAGE_DIR = '/var/lib/mcvirt/build-4189623-project-52530-mcvirt/iso'

LOCK_FILE = '/var/run/lock/mcvirt/lock'

LOCK_FILE_DIR = '/var/run/lock/mcvirt'

LOG_FILE = '/var/log/mcvirt.log'

NODE_STORAGE_DIR = '/var/lib/mcvirt/build-4189623-project-52530-mcvirt'

TEMPLATE_DIR = '/usr/lib/mcvirt/templates'

mcvirt.exceptions module

Provide access to all MCVirt exceptions.

exception mcvirt.exceptions.ArgumentParserException

Bases: mcvirt.exceptions.MCVirtException

An invalid argument was provided

exception mcvirt.exceptions.AttributeAlreadyChanged

Bases: mcvirt.exceptions.MCVirtException

Attribute, user is trying to change, has already changed

exception mcvirt.exceptions.AuthenticationError

Bases: mcvirt.exceptions.MCVirtException

Incorrect credentials

exception mcvirt.exceptions.BackupSnapshotAlreadyExistsException

Bases: mcvirt.exceptions.MCVirtException

The backup snapshot for the logical volume already exists

exception mcvirt.exceptions.BackupSnapshotDoesNotExistException

Bases: mcvirt.exceptions.MCVirtException

The backup snapshot for the logical volume does not exist

exception mcvirt.exceptions.BlankPasswordException

Bases: mcvirt.exceptions.MCVirtException

The provided password is blank

exception mcvirt.exceptions.CACertificateAlreadyExists

Bases: mcvirt.exceptions.MCVirtException

CA file for server already exists

exception mcvirt.exceptions.CACertificateNotFoundException

Bases: mcvirt.exceptions.MCVirtException

CA certificate for host could not be found

exception mcvirt.exceptions.CAFileAlreadyExists

Bases: mcvirt.exceptions.MCVirtException

The CA file already exists.

exception mcvirt.exceptions.CannotCloneDrbdBasedVmsException

Bases: mcvirt.exceptions.MCVirtException

Cannot clone Drbd-based VMs

exception mcvirt.exceptions.CannotDeleteClonedVmException

Bases: mcvirt.exceptions.MCVirtException

Cannot delete a cloned VM

exception mcvirt.exceptions.CannotMigrateLocalDiskException

Bases: mcvirt.exceptions.MCVirtException

Local disks cannot be migrated

exception mcvirt.exceptions.CannotStartClonedVmException

Bases: mcvirt.exceptions.MCVirtException

Cloned VMs cannot be started

exception mcvirt.exceptions.ClusterNotInitialisedException

Bases: mcvirt.exceptions.MCVirtException

The cluster has not been initialised, so cannot connect to the remote node

exception mcvirt.exceptions.ConfigFileCouldNotBeFoundException

Bases: mcvirt.exceptions.MCVirtException

Config file could not be found

exception mcvirt.exceptions.ConnectionFailureToRemoteLibvirtInstance

Bases: mcvirt.exceptions.MCVirtException

Connection failure whilst attempting to obtain a remote libvirt connection

exception mcvirt.exceptions.CouldNotConnectToNodeException

Bases: mcvirt.exceptions.MCVirtException

Could not connect to remove cluster node

exception mcvirt.exceptions.CurrentUserError

Bases: mcvirt.exceptions.MCVirtException

Error whilst obtaining current pyro user

exception mcvirt.exceptions.DiskAlreadyExistsException

Bases: mcvirt.exceptions.MCVirtException

The disk already exists

exception mcvirt.exceptions.DrbdAlreadyEnabled

Bases: mcvirt.exceptions.MCVirtException

Drbd has already been enabled on this node

exception mcvirt.exceptions.DrbdBlockDeviceDoesNotExistException

Bases: mcvirt.exceptions.MCVirtException

Drbd block device does not exist

exception mcvirt.exceptions.DrbdNotEnabledOnNode

Bases: mcvirt.exceptions.MCVirtException

Drbd volumes cannot be created on a node that has not been configured to use Drbd

exception mcvirt.exceptions.DrbdNotInstalledException

Bases: mcvirt.exceptions.MCVirtException

Drbd is not installed

exception mcvirt.exceptions.DrbdStateException

Bases: mcvirt.exceptions.MCVirtException

The Drbd state is not OK

exception mcvirt.exceptions.DrbdVolumeNotInSyncException

Bases: mcvirt.exceptions.MCVirtException

The last Drbd verification of the volume failed

exception mcvirt.exceptions.DuplicatePermissionException

Bases: mcvirt.exceptions.MCVirtException

User already exists in group

exception mcvirt.exceptions.ExternalStorageCommandErrorException

Bases: mcvirt.exceptions.MCVirtException

An error occurred whilst performing an external command

exception mcvirt.exceptions.FailedToRemoveFileException

Bases: mcvirt.exceptions.MCVirtException

A failure occurred whilst trying to remove an ISO

exception mcvirt.exceptions.HardDriveDoesNotExistException

Bases: mcvirt.exceptions.MCVirtException

The given hard drive does not exist

exception mcvirt.exceptions.InaccessibleNodeException

Bases: mcvirt.exceptions.MCVirtException, Pyro4.errors.SecurityError

Unable to connect to node in the cluster

exception mcvirt.exceptions.IncorrectCredentials

Bases: mcvirt.exceptions.MCVirtException

The supplied credentials are incorrect

exception mcvirt.exceptions.InsufficientPermissionsException

Bases: mcvirt.exceptions.MCVirtException

User does not have the required permission

exception mcvirt.exceptions.InterfaceDoesNotExist

Bases: mcvirt.exceptions.MCVirtException

Physical interface does not exist

exception mcvirt.exceptions.InvalidArgumentException

Bases: mcvirt.exceptions.MCVirtException

Argument given is not valid

exception mcvirt.exceptions.InvalidConnectionString

Bases: mcvirt.exceptions.MCVirtException

Connection string is invalid

exception mcvirt.exceptions.InvalidIPAddressException

Bases: mcvirt.exceptions.MCVirtException

The specified IP address is invalid

exception mcvirt.exceptions.InvalidISOPathException

Bases: mcvirt.exceptions.MCVirtException

ISO to add does not exist

exception mcvirt.exceptions.InvalidNodesException

Bases: mcvirt.exceptions.MCVirtException

The nodes passed is invalid

exception mcvirt.exceptions.InvalidPermissionGroupException

Bases: mcvirt.exceptions.MCVirtException

Attempted to perform actions on an invalid permission group

exception mcvirt.exceptions.InvalidUserTypeException

Bases: mcvirt.exceptions.MCVirtException

An invalid user type was specified.

exception mcvirt.exceptions.InvalidUsernameException

Bases: mcvirt.exceptions.MCVirtException

Username is within a reserved namespace

exception mcvirt.exceptions.InvalidVirtualMachineNameException

Bases: mcvirt.exceptions.MCVirtException

VM is being created with an invalid name

exception mcvirt.exceptions.InvalidVolumeGroupNameException

Bases: mcvirt.exceptions.MCVirtException

The specified name of the volume group is invalid

exception mcvirt.exceptions.IsoAlreadyExistsException

Bases: mcvirt.exceptions.MCVirtException

An ISO with the same name already exists

exception mcvirt.exceptions.IsoInUseException

Bases: mcvirt.exceptions.MCVirtException

The ISO is in use, so cannot be removed

exception mcvirt.exceptions.IsoNotPresentOnDestinationNodeException

Bases: mcvirt.exceptions.MCVirtException

ISO attached to VM does not exist on destination node whilst performing a migration]

exception mcvirt.exceptions.LibVirtConnectionException

Bases: mcvirt.exceptions.MCVirtException

An error ocurred whilst connecting to LibVirt

exception mcvirt.exceptions.LibvirtException

Bases: mcvirt.exceptions.MCVirtException

Issue with performing libvirt command

exception mcvirt.exceptions.LibvirtNotInstalledException

Bases: mcvirt.exceptions.MCVirtException

Libvirt does not appear to be installed

exception mcvirt.exceptions.LogicalVolumeDoesNotExistException

Bases: mcvirt.exceptions.MCVirtException

A required logical volume does not exist

exception mcvirt.exceptions.MCVirtCommandException

Bases: mcvirt.exceptions.MCVirtException

Provides an exception to be thrown after errors whilst calling external commands

exception mcvirt.exceptions.MCVirtException

Bases: exceptions.Exception

Provides an exception to be thrown for errors in MCVirt

exception mcvirt.exceptions.MCVirtLockException

Bases: mcvirt.exceptions.MCVirtException

A lock has already been found

exception mcvirt.exceptions.MigrationFailureExcpetion

Bases: mcvirt.exceptions.MCVirtException

A Libvirt Exception occurred whilst performing a migration

exception mcvirt.exceptions.MissingConfigurationException

Bases: mcvirt.exceptions.MCVirtException

Configuration is missing

exception mcvirt.exceptions.MustGenerateCertificateException

Bases: mcvirt.exceptions.MCVirtException

The certificate cannot be manually added and must be generated

exception mcvirt.exceptions.NameNotSpecifiedException

Bases: mcvirt.exceptions.MCVirtException

A name has not been specified and cannot be determined by the path/URL

exception mcvirt.exceptions.NetworkAdapterDoesNotExistException

Bases: mcvirt.exceptions.MCVirtException

The network adapter does not exist

exception mcvirt.exceptions.NetworkAlreadyExistsException

Bases: mcvirt.exceptions.MCVirtException

Network already exists with the same name

exception mcvirt.exceptions.NetworkDoesNotExistException

Bases: mcvirt.exceptions.MCVirtException

Network does not exist

exception mcvirt.exceptions.NetworkUtilizedException

Bases: mcvirt.exceptions.MCVirtException

Network is utilized by virtual machines

exception mcvirt.exceptions.NodeAlreadyPresent

Bases: mcvirt.exceptions.MCVirtException

Node being added is already connected to cluster

exception mcvirt.exceptions.NodeAuthenticationException

Bases: mcvirt.exceptions.MCVirtException

Incorrect password supplied for remote node

exception mcvirt.exceptions.NodeDoesNotExistException

Bases: mcvirt.exceptions.MCVirtException

The node does not exist

exception mcvirt.exceptions.NodeVersionMismatch

Bases: Pyro4.errors.SecurityError

A node is running a different version of MCVirt

exception mcvirt.exceptions.OpenSSLNotFoundException

Bases: mcvirt.exceptions.MCVirtException

The OpenSSL executable could not be found

exception mcvirt.exceptions.PasswordsDoNotMatchException

Bases: mcvirt.exceptions.MCVirtException

The new passwords do not match

exception mcvirt.exceptions.ReachedMaximumStorageDevicesException

Bases: mcvirt.exceptions.MCVirtException

Reached the limit to number of hard disks attached to VM

exception mcvirt.exceptions.RemoteCommandExecutionFailedException

Bases: mcvirt.exceptions.MCVirtException

A remote command execution fails

exception mcvirt.exceptions.RemoteNodeLockedException

Bases: mcvirt.exceptions.MCVirtException

Remote node is locked

exception mcvirt.exceptions.RemoteObjectConflict

Bases: mcvirt.exceptions.MCVirtException

The remote node contains an object that will cause conflict when syncing

exception mcvirt.exceptions.StorageTypeNotSpecified

Bases: mcvirt.exceptions.MCVirtException

Storage type has not been specified

exception mcvirt.exceptions.StorageTypesCannotBeMixedException

Bases: mcvirt.exceptions.MCVirtException

Storage types cannot be mixed within a single VM

exception mcvirt.exceptions.UnknownRemoteCommandException

Bases: mcvirt.exceptions.MCVirtException

An unknown command was passed to the remote machine

exception mcvirt.exceptions.UnknownStorageTypeException

Bases: mcvirt.exceptions.MCVirtException

An hard drive object with an unknown disk type has been initialised

exception mcvirt.exceptions.UnprivilegedUserException

Bases: mcvirt.exceptions.MCVirtException

Unprivileged user running executable

exception mcvirt.exceptions.UnsuitableNodeException

Bases: mcvirt.exceptions.MCVirtException

The node is unsuitable to run the VM

exception mcvirt.exceptions.UserAlreadyExistsException

Bases: mcvirt.exceptions.MCVirtException

The given user already exists.

exception mcvirt.exceptions.UserDoesNotExistException

Bases: mcvirt.exceptions.MCVirtException

The specified user does not exist

exception mcvirt.exceptions.UserNotPresentInGroup

Bases: mcvirt.exceptions.MCVirtException

User to be removed from group is not in the group

exception mcvirt.exceptions.VirtualMachineDoesNotExistException

Bases: mcvirt.exceptions.MCVirtException

Virtual machine does not exist

exception mcvirt.exceptions.VirtualMachineLockException

Bases: mcvirt.exceptions.MCVirtException

Lock cannot be set to the current lock state

exception mcvirt.exceptions.VmAlreadyExistsException

Bases: mcvirt.exceptions.MCVirtException

VM is being created with a duplicate name

exception mcvirt.exceptions.VmAlreadyRegisteredException

Bases: mcvirt.exceptions.MCVirtException

VM is already registered on a node

exception mcvirt.exceptions.VmAlreadyStartedException

Bases: mcvirt.exceptions.MCVirtException

VM is already started when attempting to start it

exception mcvirt.exceptions.VmAlreadyStoppedException

Bases: mcvirt.exceptions.MCVirtException

VM is already stopped when attempting to stop it

exception mcvirt.exceptions.VmDirectoryAlreadyExistsException

Bases: mcvirt.exceptions.MCVirtException

Directory for a VM already exists

exception mcvirt.exceptions.VmIsCloneException

Bases: mcvirt.exceptions.MCVirtException

VM is a clone

exception mcvirt.exceptions.VmNotRegistered

Bases: mcvirt.exceptions.MCVirtException

The virtual machine is not currently registered on a node

exception mcvirt.exceptions.VmRegisteredElsewhereException

Bases: mcvirt.exceptions.MCVirtException

Attempt to perform an action on a VM registered on another node

exception mcvirt.exceptions.VmRunningException

Bases: mcvirt.exceptions.MCVirtException

An offline migration can only be performed on a powered off VM

exception mcvirt.exceptions.VmStoppedException

Bases: mcvirt.exceptions.MCVirtException

An online migraiton can only be performed on a powered on VM

exception mcvirt.exceptions.VncNotEnabledException

Bases: mcvirt.exceptions.MCVirtException

VNC is not enabled on the VM

mcvirt.exceptions.exception_class

alias of InaccessibleNodeException

mcvirt.libvirt_connector module

class mcvirt.libvirt_connector.LibvirtConnector

Bases: mcvirt.rpc.pyro_object.PyroObject

Obtains/manages Libvirt connections

get_connection(server=None)

Obtains a Libvirt connection for a given server

mcvirt.logger module

class mcvirt.logger.LogItem(method, user, object_name, object_type)

Bases: object

description

finish_error(exception)

finish_error_unknown(exception)

finish_success()

start()

class mcvirt.logger.LogState

Bases: object

FAILED = {'status': 3, 'name': 'FAILED'}

QUEUED = {'status': 0, 'name': 'QUEUED'}

RUNNING = {'status': 1, 'name': 'RUNNING'}

SUCCESS = {'status': 2, 'name': 'SUCCESS'}

class mcvirt.logger.Logger

Bases: mcvirt.rpc.pyro_object.PyroObject

LOGS = []

create_log(method, user, object_name, object_type)

get_logs(start_log=None, back=0, newer=False)

mcvirt.logger.getLogNames(callback, instance_method, object_type, args, kwargs)

Attempts to determine object name and object type, based on method

mcvirt.mcvirt-drbd module

mcvirt.mcvirt_config module

class mcvirt.mcvirt_config.MCVirtConfig

Bases: mcvirt.config_file.ConfigFile

Provides operations to obtain and set the MCVirt configuration for a VM

create()

Create a basic VM configuration for new VMs

getListenAddress()

Return the address that should be used for listening for connections - the stored IP address, if configured, else all interfaces

mcvirt.parser module

Provides argument parser.

class mcvirt.parser.Parser(verbose=True)

Bases: object

Provides an argument parser for MCVirt.

parse_arguments(script_args=None)

Parse arguments and performs actions based on the arguments.

print_status(status)

Print if the user has specified that the parser should print statuses.

class mcvirt.parser.ThrowingArgumentParser(prog=None, usage=None, description=None, epilog=None, version=None, parents=[], formatter_class=<class 'argparse.HelpFormatter'>, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True)

Bases: argparse.ArgumentParser

Override the ArgumentParser class, in order to change the handling of errors.

error(message)

Override the error function.

mcvirt.syslogger module

class mcvirt.syslogger.Syslogger

Bases: object

Provide interface for logging to log file

LOGGER_INSTANCE = None

static get_log_level()

Return the log level, set either by environmental variable or configuration in MCVirt config

static logger()

Obtain logger instance if not already create, else return cached object

mcvirt.system module

class mcvirt.system.System

Bases: object

static getNewPassword()

Prompts the user for a new password, throwing an exception is the password is not repeated correctly

static getUserInput(display_text, password=False)

Prompts the user for input

static runCommand(command_args, raise_exception_on_failure=True, cwd=None)

Runs system command, throwing an exception if the exit code is not 0

mcvirt.utils module

mcvirt.utils.get_all_submodules(target_class)

Returns all inheriting classes, recursively

mcvirt.utils.get_hostname()

Returns the hostname of the system

mcvirt.version module

Module contents