enomalism2.modules.machinecontrol.rest

rest_machine_UUID_trigger_status_updates(self, *args, **kw)

Forces the machine to run a status update on all it's children. Nice for populating the database before a "get state" call.

URL Format:

   /rest/machine/<UUID>/trigger_status_updates/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: None

None

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.modules.machinecontrol.model._run_status_updates

rest_machines(self, *args, **kw)

List machines available in the database. Returns a list of machines by UUID in the return result machines.

URL Format:

   /rest/machines/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

Dictionary containing all machines.

Decorators:

@register_extension("machines", allowed_methods= ['GET', 'POST'])

Raises:

None - No exceptions are raised by this function.

Status: Stable

See Also: enomalism2.machine.Machine

rest_machine(self, *args, **kw)

Same as rest/machines.

URL Format:

   /rest/machine/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

Dictionary containing all machines.

Decorators:

@register_extension("machine", allowed_methods= ['GET', 'POST'])

Raises:

turbogears.redirect - Redirects to rest/machines.

Status: Stable

See Also:: enomalism2.machine.Machine, enomalism2.modules.machinecontrol.rest.rest_machines

rest_machine_UUID(self, *args, **kw)

Returns information about a given machine.

URL Format:

   /rest/machine/<UUID>/

Parameters:

self (enomalism2.REST.rest) - The method class.
action (String) - Only valid for post, the term "rename" is valid for now.
name (String) - When rename action is called, this is the new machine name.

Returns: Dictionary

Dictionary containing the results of the specified command.

Decorators:

@register_extension("machine/*", allowed_methods= ['GET', 'POST'])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.model.UUIDSearch.machine, enomalism2.model.UUIDSearch.hypervisor, enomalism2.exceptions.E2MachineNotFound, enomalism2.exceptions.E2HypervisorNotFound

rest_machine_UUID_rename(self, *args, **kw)

Rename the specified machine.

URL Format:

   /rest/machine/<UUID>/rename/

Parameters:

self (enomalism2.REST.rest) - The method class.
name (String) - The new machine name.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

@register_extension("machine/*/rename", allowed_methods= ['GET', 'POST'])

Raises:

None - No exceptions are raised by this method.

Status: Stable

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

rest_machine_UUID_hypervisors(self, *args, **kw)

Retrieves a list of hypervisors for the requested machine. Alternately (with a POST), adds a new hypervisor to the posted machine.

URL Format:

   /rest/machine/<UUID>/hypervisors/

Parameters:

self (enomalism2.REST.rest) - The method class.
virt_class (String) - Virtualization class to target.
virt_url (String) - The url for the virt_class to target.

Returns: Dictionary

A dictionary containing the result of the command.

Decorators:

@register_extension("machine/*/hypervisors", allowed_methods= ['GET', 'POST'])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.REST.redirect.redirect_REST, enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.model.UUIDSearch.machine

rest_machine_UUID_clusters(self, *args, **kw)

Add or list machine clusters.

URL Format:

   /rest/machine/<UUID>/clusters/

Parameters:

self (enomalism2.REST.rest) - The method class.
clusters (String) - The cluster we are adding the machine to.

Returns: Dictionary

A dictionary containing a list of clusters this machine is a member of.

Decorators:

@register_extension("machine/*/clusters", allowed_methods= ['GET', 'POST'])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound

rest_machine_UUID_actions(self, *args, **kw)

Get a list of available machine actions.

URL Format:

   /rest/machine/<UUID>/actions/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A Dictionary containing a list of available actions.

Decorators:

@register_extension("machine/*/actions", allowed_methods= ['GET', 'POST'])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound

rest_machine_UUID_actions_unlock(self, *args, **kw)

Unlock the specified machine.

URL Format:

   /rest/machine/<UUID>/actions/unlock/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

@register_extension("machine/*/actions/unlock", allowed_methods= ['POST'])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine

rest_machine_UUID_actions_suspend(self, *args, **kw)

Suspend the specified machine.

URL Format:

   /rest/machine/<UUID>/actions/suspend/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

@register_extension("machine/*/actions/suspend", allowed_methods= ['POST'])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound

rest_machine_UUID_actions_resume(self, *args, **kw)

Resume the specified machine.

URL Format:

   /rest/machine/<UUID>/actions/resume/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

@register_extension("machine/*/actions/resume", allowed_methods= ['POST'])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound

rest_machine_UUID_actions_shutdown(self, *args, **kw)

Shutdown the specified machine.

URL Format:

   /rest/machine/<UUID>/actions/shutdown/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing the result of the command.

Decorators:

@register_extension("machine/*/actions/shutdown", allowed_methods= ['POST'])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound, enomalism2.utilities.e2_log

rest_machine_UUID_actions_poweroff(self, *args, **kw)

Poweroff the specified machine.

URL Format:

   /rest/machine/<UUID>/actions/poweroff/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing the result of the command.

Decorators:

@register_extension("machine/*/actions/poweroff", allowed_methods= ['POST'])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.utilities.e2_log

rest_machine_UUID_actions_reboot(self, *args, **kw)

Reboot the specified machine.

URL Format:

   /rest/machine/<UUID>/actions/reboot/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing the result of the command.

Decorators:

@register_extension("machine/*/actions/reboot", allowed_methods= ['POST',])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound

rest_machine_UUID_actions_create(self, *args, **kw)

Create the specified machine.

URL Format:

   /rest/machine/<UUID>/actions/create/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing the result of the command.

Decorators:

@register_extension("machine/*/actions/create", allowed_methods= ['POST',])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound

rest_machine_UUID_actions_store_xml(self, *args, **kw)

This overwrites the xml definition in the database with the currently running XML definition.

URL Format:

   /rest/machine/<UUID>/actions/store_xml/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing the result of the command.

Decorators:

@register_extension("machine/*/actions/store_xml", allowed_methods= ['POST',])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound

rest_machine_UUID_actions_manage(self, *args, **kw)

This adds an unmanaged machine (legacy machine) into the administrative console. Once added, it is assigned a UUID and other management options become available.

URL Format:

   /rest/machine/<UUID>/actions/manage/

Parameters:

self (enomalism2.REST.rest) - The method class.
parent (String) - The parent hypervisor to add the specified machine to.

Returns: Dictionary

A dictionary containing the result of the command.

Decorators:

@register_extension("machine/*/actions/manage", allowed_methods= ['POST',])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound, enomalism2.utilities.e2_log

rest_machine_UUID_actions_totaldelete(self, *args, **kw)

This deletes all references to a machine in the database, and deletes it's hard drive images/files.

URL Format:

   /rest/machine/<UUID>/actions/totaldelete/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

@register_extension("machine/*/actions/totaldelete", allowed_methods= ['POST',])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.identity.validate_permission, enomalism2.exceptions.E2PermissionError, enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound, enomalism2.utilities.e2_log

rest_machine_UUID_actions_package(self, *args, **kw)

Package the target machine.

URL Format:

   /rest/machine/<UUID>/actions/package/

Parameters:

self (enomalism2.REST.rest) - The method class.

Returns: Dictionary

A dictionary containing the result of the action.

Decorators:

@register_extension("machine/*/actions/package", allowed_methods= ['POST',])

Raises:

cherrypy.HTTPError - Raised when permission is denied.

Status: Stable

See Also:: enomalism2.REST.redirect.redirect_REST, enomalism2.model.UUIDSearch.machine, enomalism2.exceptions.E2MachineNotFound, enomalism2.utilities.e2_log

Module rest

rest_machine_UUID_trigger_status_updates(self, *args, **kw)

rest_machines(self, *args, **kw)

rest_machine(self, *args, **kw)

rest_machine_UUID(self, *args, **kw)

rest_machine_UUID_rename(self, *args, **kw)

rest_machine_UUID_hypervisors(self, *args, **kw)

rest_machine_UUID_clusters(self, *args, **kw)

rest_machine_UUID_actions(self, *args, **kw)

rest_machine_UUID_actions_unlock(self, *args, **kw)

rest_machine_UUID_actions_suspend(self, *args, **kw)

rest_machine_UUID_actions_resume(self, *args, **kw)

rest_machine_UUID_actions_shutdown(self, *args, **kw)

rest_machine_UUID_actions_poweroff(self, *args, **kw)

rest_machine_UUID_actions_reboot(self, *args, **kw)

rest_machine_UUID_actions_create(self, *args, **kw)

rest_machine_UUID_actions_store_xml(self, *args, **kw)

rest_machine_UUID_actions_manage(self, *args, **kw)

rest_machine_UUID_actions_totaldelete(self, *args, **kw)

rest_machine_UUID_actions_package(self, *args, **kw)

rest_machine_UUID_actions_provision(self, *args, **kw)