JSON RPC

Module description

Manages cluster nodes through BMC controllers using the IPMI protocol

Operations

Set node IPMI credentials

Request data

{
    "context": {
        "op": "ipmi_node_add"
    },
    "data": {
        "node_uuid": "<node_uuid>",
        "node_name": "<node_name>",
        "ipmi_addr": "<ipmi_addr>",
        "ipmi_port": "<ipmi_port>",
        "user": "<user>",
        "password": "<password>"
    }
}

Description

node_uuid [ str required ] - cluster node uuid

node_name [ str ] - node name

ipmi_addr [ str required ] - ipmi address

ipmi_port [ int ] - ipmi port

user [ str required ] - ipmi user

password [ str required ] - ipmi password

Update node IPMI credentials

Request data

{
    "context": {
        "op": "ipmi_node_update"
    },
    "data": {
        "node_uuid": "<node_uuid>",
        "node_name": "<node_name>",
        "ipmi_addr": "<ipmi_addr>",
        "ipmi_port": "<ipmi_port>",
        "user": "<user>",
        "password": "<password>"
    }
}

Description

node_uuid [ str required ] - cluster node uuid

node_name [ str ] - node name

ipmi_addr [ str ] - ipmi address

ipmi_port [ int ] - ipmi port

user [ str ] - ipmi user

password [ str ] - new ipmi password

Removes node IPMI credentials

Request data

{
    "context": {
        "op": "ipmi_node_del"
    },
    "data": {
        "node_uuid": "<node_uuid>"
    }
}

Description

node_uuid [ str required ] - cluster node uuid

List IPMI credentials by node

Request data

{
    "context": {
        "op": "ipmi_node_list"
    }
}

Show node IPMI credentials

Request data

{
    "context": {
        "op": "ipmi_node_show"
    },
    "data": {
        "node_uuid": "<node_uuid>"
    }
}

Description

node_uuid [ str required ] - cluster node uuid

Poweron node

Request data

{
    "context": {
        "op": "ipmi_power_on"
    },
    "data": {
        "node_uuid": "<node_uuid>"
    }
}

Description

node_uuid [ str required ] - cluster node uuid

Poweroff node

Request data

{
    "context": {
        "op": "ipmi_power_off"
    },
    "data": {
        "node_uuid": "<node_uuid>"
    }
}

Description

node_uuid [ str required ] - cluster node uuid

Reset node power

Request data

{
    "context": {
        "op": "ipmi_power_reset"
    },
    "data": {
        "node_uuid": "<node_uuid>",
        "mode": "<mode>"
    }
}

Description

node_uuid [ str required ] - cluster node uuid

mode [ str ] - reset mode (default: warm) ['warm', 'cold']

Shows bmc info

Request data

{
    "context": {
        "op": "ipmi_info"
    },
    "data": {
        "node_uuid": "<node_uuid>"
    }
}

Description

node_uuid [ str required ] - cluster node uuid