Package enomalism2 :: Package modules :: Package valet :: Module rest
[hide private]

Module rest

REST controllers for the valet module.


Requires:

Status: Stable

Functions [hide private]
Dictionary
rest_valet(self, *args, **kw)
This method can be called with a POST or PUT (functionality will be the same either way).
Dictionary
rest_valet_packages(self, *args, **kw)
Return a list of packages.
Dictionary
rest_valet_machinedefs(self, *args, **kw)
Return a list of machine definitions.
Dictionary
rest_valet_machinedefs_UUID(self, *args, **kw)
Get the actual machine capabilities XML.
Function Details [hide private]

rest_valet(self, *args, **kw)

 

This method can be called with a POST or PUT (functionality will be the same either way). The call will attempt to create a new virtual machine based on the incoming request The current user must have read permission on the valet module.

URL Format:

   /rest/valet/
Parameters:
  • self (enomalism2.REST.rest) - The method class.
  • pkguuid (String) - Package UUID to provision.
  • mduuid (String) - Machine definition UUID to provision on.
  • num_machines (Integer) - The number of machines to provision.
Returns: Dictionary
A dictionary containing the result of the action.
Decorators:
  • @register_extension("valet", allowed_methods= ['POST', 'PUT'])
Raises:
  • None - No exceptions are raised by this method.

rest_valet_packages(self, *args, **kw)

 

Return a list of packages.

URL Format:

   /rest/valet/packages/
Parameters:
Returns: Dictionary
A dictionary containing a list of packages.
Decorators:
  • @register_extension("valet/packages", allowed_methods= ['POST', 'GET'])
Raises:
  • None - No exceptions are raised by this method.

Status: Deprecated

rest_valet_machinedefs(self, *args, **kw)

 

Return a list of machine definitions. THese are the hardware profiles used to define how good of a machine is used for valet. The current user must have read permission on the valet module.

URL Format:

   /rest/valet/machinedefs/
Parameters:
Returns: Dictionary
A dictionary containing a list of machine definitions.
Decorators:
  • @register_extension("valet/machinedefs", allowed_methods= ['GET'])
Raises:
  • None - No exceptions are raised by this method.

Status: Stable

See Also: enomalism2.identity.validate_permission

rest_valet_machinedefs_UUID(self, *args, **kw)

 

Get the actual machine capabilities XML. The current user must have read permission on the valet module.

URL Format:

   /rest/valet/machinedefs/
Parameters:
Returns: Dictionary
A dictionary containing the machine definition.
Decorators:
  • @register_extension("valet/machinedefs/*", allowed_methods= ['GET'])
Raises:
  • None - No exceptions are raised by this method.

Status: Stable

See Also: enomalism2.identity.validate_permission