Welcome to MCVirt’s documentation!

MCVirt - Managed Consistent Virtualisation

MCVirt (em-see-vert) - Command line virtual machine management utility.

Description

MCVirt is a utility for managing virtual machines, supporting the following technologies:

MCVirt is implemented in Python, using the libvirt virtualisation library.

BETA WARNING

The master branch currently contains a beta release of v9.0.0.

To use the latest stable release, please switch to tag v8.3.0.

Getting started

MCVirt must currently be built from source into a deb package, using the build script. The package and dependencies can then be installed:

$ ./build.sh
$ sudo dpkg -i mcvirt_*_all.deb
$ sudo apt-get -f install

See the installation guide for other dependencies and system configuration.

Start the MCVirt nameserver and daemon by running:

$ sudo service mcvirt-ns start
$ sudo service mcvirtd start

Most commands require a username and password to the MCVirt daemon. During installation a superuser is created with username mjc and password pass - see permissions for information on creating new users.

Configure the volume group that MCVirt will use to store virtual machine data:

$ mcvirt node --set-vm-vg <Volume Group>

See the configuration guide for further node configuration steps.

Create a VM:

$ mcvirt create --cpu-count 1 --memory 512 --disk-size 8000 test-vm

See the create/remove VMs, cluster, permissions and modifying VMs guides for further administrative instructions.

Start the VM:

$ mcvirt start test-vm

See the controlling VMs guide for further user instructions.

Note: Username and password can be provided on the command line with the --username and --password options to instead of typing them in after every command.

For information on developing on MCVirt, see the development documentation.

See the guide index for a full list of manuals

For more information, please feel free to contact us

LICENSE

MCVirt is licensed under GPL v2. For more information, please see LICENSE

API Documentation

Contents:

mcvirt package

Subpackages

mcvirt.agent package

Submodules
mcvirt.agent.daemon module
mcvirt.agent.host_connection module
Module contents

mcvirt.auth package

Subpackages
mcvirt.auth.group package
Submodules
mcvirt.auth.group.factory module
mcvirt.auth.group.group module
Module contents
mcvirt.auth.user_types package
Submodules
mcvirt.auth.user_types.cluster_user module
mcvirt.auth.user_types.connection_user module
mcvirt.auth.user_types.drbd_hook_user module
mcvirt.auth.user_types.ldap_user module
mcvirt.auth.user_types.local_user module
mcvirt.auth.user_types.user_base module
Module contents
Submodules
mcvirt.auth.auth module
mcvirt.auth.factory module
mcvirt.auth.permissions module
mcvirt.auth.session 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.ldap_factory module
mcvirt.node.libvirt_config module
mcvirt.node.node module
Module contents

mcvirt.parser_modules package

Subpackages
mcvirt.parser_modules.virtual_machine package
Submodules
mcvirt.parser_modules.virtual_machine.backup_parser module
mcvirt.parser_modules.virtual_machine.clone_parser module
mcvirt.parser_modules.virtual_machine.create_parser module
mcvirt.parser_modules.virtual_machine.delete_parser module
mcvirt.parser_modules.virtual_machine.duplicate_parser module
mcvirt.parser_modules.virtual_machine.info_parser module
mcvirt.parser_modules.virtual_machine.list_parser module
mcvirt.parser_modules.virtual_machine.lock_parser module
mcvirt.parser_modules.virtual_machine.migrate_parser module
mcvirt.parser_modules.virtual_machine.move_parser module
mcvirt.parser_modules.virtual_machine.register_parser module
mcvirt.parser_modules.virtual_machine.reset_parser module
mcvirt.parser_modules.virtual_machine.shutdown_parser module
mcvirt.parser_modules.virtual_machine.start_parser module
mcvirt.parser_modules.virtual_machine.stop_parser module
mcvirt.parser_modules.virtual_machine.unregister_parser module
mcvirt.parser_modules.virtual_machine.update_parser module
Module contents
Submodules
mcvirt.parser_modules.clear_method_lock_parser module
mcvirt.parser_modules.cluster_parser module
mcvirt.parser_modules.drbd_parser module
mcvirt.parser_modules.group_parser module
mcvirt.parser_modules.iso_parser module
mcvirt.parser_modules.network_parser module
mcvirt.parser_modules.node_parser module
mcvirt.parser_modules.permission_parser module
mcvirt.parser_modules.resync_parser module
mcvirt.parser_modules.storage_parser module
mcvirt.parser_modules.user_parser module
mcvirt.parser_modules.verify_parser module
mcvirt.parser_modules.watchdog_parser 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.expose_method 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.storage package

Submodules
mcvirt.storage.base module
mcvirt.storage.factory module
mcvirt.storage.file module
mcvirt.storage.lvm 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.ldap_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.thread package

Submodules
mcvirt.thread.auto_start_watchdog module
mcvirt.thread.repeat_timer module
mcvirt.thread.watchdog 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.agent_connection module
mcvirt.virtual_machine.disk_drive module
mcvirt.virtual_machine.factory module
mcvirt.virtual_machine.usb_device module
mcvirt.virtual_machine.virtual_machine module
mcvirt.virtual_machine.virtual_machine_config module
Module contents

Submodules

mcvirt.argument_validator module

mcvirt.bash-complete module

mcvirt.build_man module

mcvirt.config_file module

mcvirt.constants module

mcvirt.exceptions module

mcvirt.libvirt_connector module

mcvirt.logger module

mcvirt.mcvirt-drbd module

mcvirt.mcvirt_config module

mcvirt.parser module

mcvirt.syslogger module

mcvirt.system module

mcvirt.utils module

mcvirt.version module

Module contents

Indices and tables