The cluster high-level interface is available through the cluster member of a Connection object. The cluster member will only be added if the service is detected.
Get build info for service engine and API
Returns: | A dictionary containing the API and engine revision string. |
---|
Get a generator of profile types.
Returns: | A generator of objects that are of type ProfileType |
---|
Get the details about a profile_type.
Parameters: | name – The name of the profile_type to retrieve or an object of ProfileType. |
---|---|
Returns: | A ProfileType object. |
Raises: | ResourceNotFound when no profile_type matching the name could be found. |
Get a generator of policy types.
Returns: | A generator of objects that are of type PolicyType |
---|
Get the details about a policy_type.
Parameters: | policy_type – The name of a poicy_type or an object of PolicyType. |
---|---|
Returns: | A PolicyType object. |
Raises: | ResourceNotFound when no policy_type matching the name could be found. |
Create a new profile from attributes.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a Profile, it is comprised of the properties on the Profile class. |
---|---|
Returns: | The results of profile creation. |
Return type: | Profile. |
Delete a profile.
Parameters: |
|
---|---|
Returns: | None |
Find a single profile.
Parameters: |
|
---|---|
Returns: | One Profile object or None |
Get a single profile.
Parameters: | profile – The value can be the name or ID of a profile or a Profile instance. |
---|---|
Returns: | One Profile |
Raises: | ResourceNotFound when no profile matching the criteria could be found. |
Retrieve a generator of profiles.
Parameters: | **query (kwargs) – Optional query parameters to be sent to restrict the profiles to be returned. Available parameters include:
|
---|---|
Returns: | A generator of profile instances. |
Update a profile.
Parameters: |
|
---|---|
Returns: | The updated profile. |
Return type: |
Validate a profile spec.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a ProfileValidate, it is comprised of the properties on the Profile class. |
---|---|
Returns: | The results of profile validation. |
Return type: | ProfileValidate. |
Create a new cluster from attributes.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a Cluster, it is comprised of the properties on the Cluster class. |
---|---|
Returns: | The results of cluster creation. |
Return type: | Cluster. |
Delete a cluster.
Parameters: |
|
---|---|
Returns: | The instance of the Cluster which was deleted. |
Return type: |
Find a single cluster.
Parameters: |
|
---|---|
Returns: | One Cluster object or None |
Get a single cluster.
Parameters: | cluster – The value can be the name or ID of a cluster or a Cluster instance. |
---|---|
Returns: | One Cluster |
Raises: | ResourceNotFound when no cluster matching the criteria could be found. |
Retrieve a generator of clusters.
Parameters: | **query (kwargs) – Optional query parameters to be sent to restrict the clusters to be returned. Available parameters include:
|
---|---|
Returns: | A generator of cluster instances. |
Update a cluster.
Parameters: |
|
---|---|
Returns: | The updated cluster. |
Return type: |
Add nodes to a cluster.
Parameters: |
|
---|---|
Returns: | A dict containing the action initiated by this operation. |
Remove nodes from a cluster.
Parameters: |
|
---|---|
Returns: | A dict containing the action initiated by this operation. |
Inflate the size of a cluster.
Parameters: |
|
---|---|
Returns: | A dict containing the action initiated by this operation. |
Shrink the size of a cluster.
Parameters: |
|
---|---|
Returns: | A dict containing the action initiated by this operation. |
Resize of cluster.
Parameters: |
|
---|---|
Returns: | A dict containing the action initiated by this operation. |
Attach a policy to a cluster.
Parameters: |
|
---|---|
Returns: | A dict containing the action initiated by this operation. |
Attach a policy to a cluster.
Parameters: |
|
---|---|
Returns: | A dict containing the action initiated by this operation. |
Change properties of a policy which is bound to the cluster.
Parameters: |
|
---|---|
Returns: | A dict containing the action initiated by this operation. |
Collect attribute values across a cluster.
Parameters: |
|
---|---|
Returns: | A dictionary containing the list of attribute values. |
check a cluster.
Parameters: |
|
---|---|
Returns: | A dictionary containing the action ID. |
recover a node.
Parameters: |
|
---|---|
Returns: | A dictionary containing the action ID. |
Create a new node from attributes.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a Node, it is comprised of the properties on the Node class. |
---|---|
Returns: | The results of node creation. |
Return type: | Node. |
Delete a node.
Parameters: |
|
---|---|
Returns: | The instance of the Node which was deleted. |
Return type: | Node. |
check a node.
Parameters: | node – The value can be either the ID of a node or a Node instance. |
---|---|
Returns: | A dictionary containing the action ID. |
recover a node.
Parameters: | node – The value can be either the ID of a node or a Node instance. |
---|---|
Returns: | A dictionary containing the action ID. |
Find a single node.
Parameters: | name_or_id (str) – The name or ID of a node. |
---|---|
Returns: | One Node object or None. |
Get a single node.
Parameters: |
|
---|---|
Returns: | One Node |
Raises: | ResourceNotFound when no node matching the name or ID could be found. |
Retrieve a generator of nodes.
Parameters: | **query (kwargs) – Optional query parameters to be sent to restrict the nodes to be returned. Available parameters include:
|
---|---|
Returns: | A generator of node instances. |
Update a node.
Parameters: |
|
---|---|
Returns: | The updated node. |
Return type: |
Create a new policy from attributes.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a Policy, it is comprised of the properties on the Policy class. |
---|---|
Returns: | The results of policy creation. |
Return type: | Policy. |
Delete a policy.
Parameters: |
|
---|---|
Returns: | None |
Find a single policy.
Parameters: |
|
---|---|
Returns: | A policy object or None. |
Return type: |
Get a single policy.
Parameters: | policy – The value can be the name or ID of a policy or a Policy instance. |
---|---|
Returns: | A policy object. |
Return type: | Policy |
Raises: | ResourceNotFound when no policy matching the criteria could be found. |
Retrieve a generator of policies.
Parameters: | **query (kwargs) – Optional query parameters to be sent to restrict the policies to be returned. Available parameters include:
|
---|---|
Returns: | A generator of policy instances. |
Update a policy.
Parameters: |
|
---|---|
Returns: | The updated policy. |
Return type: |
Validate a policy spec.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a PolicyValidate, it is comprised of the properties on the Policy class. |
---|---|
Returns: | The results of Policy validation. |
Return type: | PolicyValidate. |
Retrieve a generator of cluster-policy bindings.
Parameters: |
|
---|---|
Returns: | A generator of cluster-policy binding instances. |
Get a cluster-policy binding.
Parameters: | |
---|---|
Returns: | a cluster-policy binding object. |
Return type: | CLusterPolicy |
Raises: | ResourceNotFound when no cluster-policy binding matching the criteria could be found. |
Create a new receiver from attributes.
Parameters: | attrs (dict) – Keyword arguments that will be used to create a Receiver, it is comprised of the properties on the Receiver class. |
---|---|
Returns: | The results of receiver creation. |
Return type: | Receiver. |
Delete a receiver.
Parameters: |
|
---|---|
Returns: | None |
Find a single receiver.
Parameters: |
|
---|---|
Returns: | A receiver object or None. |
Return type: |
Get a single receiver.
Parameters: | receiver – The value can be the name or ID of a receiver or a Receiver instance. |
---|---|
Returns: | A receiver object. |
Return type: | Receiver |
Raises: | ResourceNotFound when no receiver matching the criteria could be found. |
Retrieve a generator of receivers.
Parameters: | **query (kwargs) – Optional query parameters for restricting the receivers to be returned. Available parameters include:
|
---|---|
Returns: | A generator of receiver instances. |
Get a single action.
Parameters: | action – The value can be the name or ID of an action or a Action instance. |
---|---|
Returns: | an action object. |
Return type: | Action |
Raises: | ResourceNotFound when no action matching the criteria could be found. |
Retrieve a generator of actions.
Parameters: | **query (kwargs) – Optional query parameters to be sent to restrict the actions to be returned. Available parameters include:
|
---|---|
Returns: | A generator of action instances. |
Get a single event.
Parameters: | event – The value can be the name or ID of an event or a Event instance. |
---|---|
Returns: | an event object. |
Return type: | Event |
Raises: | ResourceNotFound when no event matching the criteria could be found. |
Retrieve a generator of events.
Parameters: | **query (kwargs) – Optional query parameters to be sent to restrict the events to be returned. Available parameters include:
|
---|---|
Returns: | A generator of event instances. |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.