qubesadmin.vm package

Module contents

Qubes VM objects.

class qubesadmin.vm.DispVM(app, name, klass=None, power_state=None)

Bases: QubesVM

Disposable VM

classmethod from_appvm(app, appvm, redirect_dispvm_calls=False)

Returns a wrapper for calling service in a new DispVM based on given AppVM. If appvm is none, use default DispVM template

If redirect_dispvm_calls is used, calls made before the disposable is created will instead guess the disposable template to query for features, properties etc.

class qubesadmin.vm.DispVMWrapper(*args, **kwargs)

Bases: QubesVM

Wrapper class for new disposable, supporting only service call.

Note that when running in dom0, one need to manually kill the disposable after service call ends.

cleanup()

Cleanup after disposable usage.

Disposable is cleaned up automatically in ‘remote’ case.

create_disposable()

Create disposable.

run_service(service, **kwargs)

Create disposable if absent and run service.

start()

Create disposable if absent and start it.

class qubesadmin.vm.QubesVM(app, name, klass=None, power_state=None)

Bases: PropertyHolder

Qubes domain.

property appvms

Returns a generator containing all domains based on the current TemplateVM.

Do not check vm type of self, core (including its extentions) have ultimate control what can be a template of what.

property connected_vms

Return a generator containing all domains connected to the current NetVM.

property derived_vms

Return list of all domains based on the current TemplateVM at any level of inheritance.

devices: qubesadmin.devices.DeviceManager

features: qubesadmin.features.Features

firewall: qubesadmin.firewall.Firewall

force_shutdown()

Deprecated alias for kill()

get_disk_utilization()

Get total disk usage of the VM

get_mem()

Get current memory usage from VM.

get_notes() → str

Get qube notes

get_power_state()

Return power state description string.

Return value may be one of those:

return value	meaning
'Halted'	Machine is not active.
'Transient'	Machine is in progress of starting. This state will be deprecated in favor of 'Starting'.
'Running'	Machine is ready and running.
'Paused'	Machine is paused.
'Suspended'	Machine is S3-suspended.
'Halting'	Machine is in process of shutting down (OS shutdown).
'Crashed'	Machine crashed and is unusable.
'NA'	Machine is in unknown state.

See also

http://wiki.libvirt.org/page/VM_lifecycle

Description of VM life cycle from the point of view of libvirt.

https://libvirt.org/html/libvirt-libvirt-domain.html#virDomainState

Libvirt’s enum describing precise state of a domain.

is_halted()

Check whether this domain’s state is ‘Halted’ :returns: True if this domain is halted, False otherwise. :rtype: bool

is_networked()

Check whether this VM can reach network (firewall notwithstanding).

Returns:

True if is machine can reach network, False otherwise.

Return type:

bool

is_paused()

Check whether this domain is paused.

Returns:

True if this domain is paused, False otherwise.

Return type:

bool

is_running()

Check whether this domain is running.

Returns:

True if this domain is started, False otherwise.

Return type:

bool

is_suspended()

Check whether this domain is suspended.

Returns:

True if this domain is suspended, False otherwise.

Return type:

bool

kill()

Kill domain (forcefuly shutdown).

Returns:

property klass

Qube class

log: Logger

property name: str

Domain name

pause()

Pause domain.

Pause its execution without any prior notification.

Returns:

prepare_input_for_vmshell(command, input=None)

Prepare shell input for the given command and optional (real) input

resume()

Resume domain (from S3).

Opposite to suspend().

Returns:

run(command, input=None, **kwargs)

Run a shell command inside the domain using qubes.VMShell qrexec.

run_service(service, **kwargs)

Run service on this VM

Parameters:

service (str) – service name

Return type:

subprocess.Popen

run_service_for_stdio(service, input=None, timeout=None, **kwargs)

Run a service, pass an optional input and return (stdout, stderr).

Raises an exception if return code != 0.

args and kwargs are passed verbatim to run_service().

Warning

There are some combinations if stdio-related kwargs, which are not filtered for problems originating between the keyboard and the chair.

run_with_args(*args, **kwargs)

Run a single command inside the domain. Use the qubes.VMExec qrexec, if available.

This method execute a single command, without interpreting any shell special characters.

set_notes(notes: str)

Set qube notes

shutdown(force=False, wait=False)

Shutdown domain.

Returns:

start()

Start domain.

Returns:

suspend()

Suspend domain.

Suspend domain (S3). Pauses it if it does not suspend.

Returns:

tags: qubesadmin.tags.Tags

unpause()

Unpause domain.

Opposite to pause().

Returns:

property volumes

VM disk volumes