Managing Nodes

Node is a logical object managed by the Senlin service. A node can be a member of at most one cluster at any time. A node can be an orphan node which means it doesn’t belong to any clusters.

List Nodes

To examine the list of Nodes:

def list_nodes(conn):
    print("List Nodes:")

    for node in conn.clustering.nodes():
    for node in conn.clustering.nodes(sort='asc:name'):

When listing nodes, you can specify the sorting option using the sort parameter and you can do pagination using the limit and marker parameters.

Full example: manage node

Create Node

When creating a node, you will provide a dictionary with keys and values according to the node type referenced.

def create_node(conn):
    print("Create Node:")

    spec = {
        'name': NODE_NAME,
        'profile_id': PROFILE_ID,
    node = conn.clustering.create_node(**spec)

Optionally, you can specify a metadata keyword argument that contains some key-value pairs to be associated with the node.

Full example: manage node

Get Node

To get a node based on its name or ID:

def get_node(conn):
    print("Get Node:")

    node = conn.clustering.get_node(NODE_ID)

Full example: manage node

Find Node

To find a node based on its name or ID:

def find_node(conn):
    print("Find Node:")

    node = conn.clustering.find_node(NODE_ID)

Full example: manage node

Update Node

After a node is created, most of its properties are immutable. Still, you can update a node’s name and/or params.

def update_node(conn):
    print("Update Node:")

    spec = {
        'name': 'Test_Node01',
        'profile_id': 'c0e3a680-e270-4eb8-9361-e5c9503fba0b',

    node = conn.clustering.update_node(NODE_ID, **spec)

Full example: manage node

Delete Node

A node can be deleted after creation, provided that it is not referenced by any active clusters. If you attempt to delete a node that is still in use, you will get an error message.

def delete_node(conn):
    print("Delete Node:")

    print("Node deleted.")
    # node support force delete
    conn.clustering.delete_node(NODE_ID, False, True)
    print("Node deleted")

Full example: manage node

Check Node

If the underlying physical resource is not healthy, the node will be set to ERROR status.

def check_node(conn):
    print("Check Node:")

    node = conn.clustering.check_node(NODE_ID)

Full example: manage node

Recover Node

To restore a specified node.

def recover_node(conn):
    print("Recover Node:")

    spec = {'check': True}
    node = conn.clustering.recover_node(NODE_ID, **spec)