enomalism2.modules.machinecontrol.model

Core machine control functionality. Includes helper classes as well as hooks and proxying functionality.

_get_remote_info(target_machine, puuid, purl)

Helper function for getting remote machine information.

Example usage:

>>> from enomalism2 import model
>>> from machinecontrol.model import _get_remote_info
>>> machine_obj=model.UUIDSearch.machine('123')
>>> _get_remote_info(machine_obj, '456', 'http://192.168.4.105/rest/')

Parameters:

target_machine (enomalism2.machine.Machine) - The machine we are getting information for.
puuid (String) - The uuid of the parent machine we are calling.
purl (String) - The url of the parent machine we are calling.

Returns: Dictionary

The remote information.

Raises:

None - No exceptions are raised by this function.

Status: Stable

See Also:: enomalism2.modules.machinecontrol.model.InfoProxy.get_remote_info, enomalism2.utilities.e2_log

_run_status_updates(uuid)

Run status updates for the specified machine's children.

Example usage:

>>> from machinecontrol.model import _run_status_updates
>>> _run_status_updates('123')

Parameters:

uuid (String) - The machine uuid.

Returns: None

None

Raises:

None - No exceptions are raised by this function.

Status: Stable

See Also:: enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound, enomalism2.machine.Machine.get_info

hook_machine_get_actions_by_state(fn, self, state)

Hook to add actions to a machine.

Parameters:

fn (enomalism2.machine.ActualMachine.get_actions_by_state) - The method we are hooking into.
self (enomalism2.machine.Machine) - The machine instance that is being hooked into.
state (Integer) - The machine state.

Returns: List

The result of the original method invocation.

Decorators:

@model.hook(model.Machine, model.Machine.get_actions_by_state)

Raises:

None - No exceptions are raised by this function.

Status: Stable

See Also:: enomalism2.machine.Machine.get_actions_by_state, enomalism2.utilities.e2_log

hook_machine_get_info(fn, self)

Hook for getting machine information.

Parameters:

fn (enomalism2.machine.ActualMachine.get_info) - The method we are hooking into.
self (enomalism2.machine.Machine) - The machine instance we are hooking into.

Returns: Dictionary

The machine information.

Decorators:

@model.hook(model.Machine, model.Machine.get_info)

Raises:

None - No exceptions are raised by this method.

Status: Stable

See Also:: enomalism2.utilities.e2_log, enomalism2.modules.machinecontrol.model._get_remote_info, enomalism2.model.guess_parent, enomalism2.machine.Machine.get_info

hook_machine_get_state(fn, self)

Hook that is processed when getting the machine state.

Parameters:

fn (enomalism2.machine.ActualMachine.get_state) - The method we are hooking into.
self (enomalism2.machine.Machine) - The class that defines the method we are hooking into.

Returns: Tuple

The machine state.

Decorators:

@model.hook(model.Machine, model.Machine.get_state)

Raises:

None - No exceptions are raised by this function.

Status: Stable

See Also:: enomalism2.machine.Machine.get_state, enomalism2.machine.Machine._get_readable_state, enomalism2.model.guess_parent, enomalism2.modules.machinecontrol.model._get_remote_info, enomalism2.utilities.e2_log

hook_machine_trigger_status_updates(fn, self)

Hook that is processed when status updates are triggered.

Parameters:

fn (enomalism2.machine.ActualMachine.trigger_status_updates) - The method we are hooking into.
self (enomalism2.machine.Machine) - The class that defines the method we are hooking into.

Returns: None

None

Decorators:

@model.hook(model.Machine, model.Machine.trigger_status_updates)

Raises:

None - No exceptions are raised by this function.

Status: Stable

See Also:: enomalism2.machine.Machine.trigger_status_updates, enomalism2.REST_library.call_rest, enomalism2.modules.machinecontrol.model._run_status_updates

provision_utility(*args, **kw)

Utility function which actually does the provisioning job.

Parameters:

pkguuid (String) - The uuid of the package to provision.
hvmuuid (String) - The uuid of the provisioning hypervisor.
name (String) - The name of the new machine.

Returns: Dictionary

A dictionary cntaining the result of the provisioning job.

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.model.UUIDSearch.package, enomalism2.model.UUIDSearch.hypervisor, enomalism2.exceptions.E2MachineNotFound, enomalism2.exceptions.E2PackageNotFound, enomalism2.exceptions.E2HypervisorNotFound

actions

Value:

{'libvirt': {STATE_PAUSED: ['shutdown', 'resume', 'poweroff', 'reboot'
, 'store_xml', 'totaldelete'], STATE_RUNNING: ['shutdown', 'suspend', 
'poweroff', 'reboot', 'store_xml', 'totaldelete'], STATE_BLOCKED: ['sh
utdown', 'suspend', 'poweroff', 'reboot', 'store_xml', 'totaldelete'],
 STATE_OFF: ['create', 'totaldelete'], STATE_SHUTDOWN: ['create', 'tot
aldelete'], STATE_UNKNOWN: ['create', 'totaldelete'], STATE_UNAVAILABL
E: ['create', 'totaldelete'], STATE_UNMANAGED: ['store_xml'], STATE_HO
ST_DOWN: [],}, None: {}}

Module model

_get_remote_info(target_machine, puuid, purl)

_run_status_updates(uuid)

hook_machine_get_actions_by_state(fn, self, state)

hook_machine_get_info(fn, self)

hook_machine_get_state(fn, self)

hook_machine_trigger_status_updates(fn, self)

provision_utility(*args, **kw)

actions