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

Module rest

Functions [hide private]
Dictionary
rest_cluster(self, *args, **kw)
Create a new cluster instance.
Dictionary
rest_cluster_list(*args, **kw)
Return a list of Enomalism clusters.
Dictionary
rest_cluster_UUID(*args, **kw)
GET will retrieve the cluster instance.
Dictionary
rest_cluster_UUID_delete(self, *args, **kw)
Delete the specified cluster.
Dictionary
rest_cluster_UUID_machines(*args, **kw)
Return a list of machines that belong to the specified cluster.
Function Details [hide private]

rest_cluster(self, *args, **kw)

 

Create a new cluster instance.

URL Format:

   /rest/cluster/
Parameters:
  • cluster_name (String) - The name attribute of the new cluster.
Returns: Dictionary
A dictionary containing the result of the action.
Decorators:
  • @register_extension("cluster", allowed_methods= ['PUT'])
Raises:
  • None - No exceptions are raised by this method.

rest_cluster_list(*args, **kw)

 

Return a list of Enomalism clusters.

URL Format:

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

Status: Beta

See Also: enomalism2.model.PermSelect.cluster

rest_cluster_UUID(*args, **kw)

 

GET will retrieve the cluster instance. DELETE will delete the cluster instance. POST will update the instance with new attribute values.

URL Format:

   /rest/cluster/<UUID>/
Parameters:
  • cluster_name (String) - The name of the cluster. This parameter is only useful in POST requests.
Returns: Dictionary
A dictionary containing the result of the action.
Decorators:
  • @register_extension("cluster/*", allowed_methods= ['GET', 'POST', 'DELETE'])
Raises:
  • None - No exceptions are raised by this method.

rest_cluster_UUID_delete(self, *args, **kw)

 

Delete the specified cluster.

URL Format:

   /rest/cluster/<UUID>/delete/
Returns: Dictionary
A dictionary containing the result of the action.
Decorators:
  • @register_extension("cluster/*/delete", allowed_methods= ['GET', 'POST', 'DELETE'])
Raises:
  • None - No exceptions are raised by this method.

Status: Deprecated

rest_cluster_UUID_machines(*args, **kw)

 

Return a list of machines that belong to the specified cluster.

URL Format:

   /rest/cluster/<UUID>/machines/
Returns: Dictionary
A dictionary containing the result of the action. In this case, the dictionary will contain a list of machine instances.
Decorators:
  • @register_extension("cluster/*/machines", allowed_methods= ['GET', 'POST'])
Raises:
  • None - No exceptions are raised by this method.