openstack.cluster.v1.Node

openstack.cluster.v1.Node

The Node Class

The Node class inherits from Resource.

class openstack.cluster.v1.node.Node(attrs=None, loaded=False)

Construct a Resource to interact with a service’s REST API.

The Resource class offers two class methods to construct resource objects, which are preferrable to entering through this initializer. See Resource.new() and Resource.existing().

Parameters:
  • attrs (dict) – The attributes to set when constructing this Resource.
  • loaded (bool) – True if this Resource exists on the server, False if it does not.
name = None

The name of the node.

physical_id = None

The ID of the physical object that backs the node.

cluster_id = None

The ID of the cluster in which this node is a member. A node is an orphan node if this field is empty.

profile_id = None

The ID of the profile used by this node.

project_id = None

The ID of the project this node belongs to.

profile_name = None

The name of the profile used by this node.

index = None

An integer that is unique inside the owning cluster. A value of -1 means this node is an orphan node.

role = None

A string indicating the role the node plays in a cluster.

init_at = None

The timestamp of the node object’s initialization.

created_at = None

The timestamp of the node’s creation, i.e. the physical object represented by this node is also created.

updated_at = None

The timestamp the node was last updated.

status = None

A string indicating the node’s status.

status_reason = None

A string describing why the node entered its current status.

metadata = None

A map containing key-value pairs attached to the node.

data = None

A map containing some runtime data for this node.

details = None

A map containing the details of the physical object this node represents

check(session, **params)

An action procedure for the node to check its health status.

Parameters:session – A session object used for sending request.
Returns:A dictionary containing the action ID.
recover(session, **params)

An action procedure for the node to recover.

Parameters:session – A session object used for sending request.
Returns:A dictionary containing the action ID.
delete(session)

Delete the remote resource associated with this instance.

Parameters:session (Session) – The session to use for making this request.
Returns:The instance of the Node which was deleted.
Return type:Node.
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.