Shutdown

You can use the Shutdown method to restart or shutdown a node that has not yet been added to a cluster. To use this method, login in to the MIP for the pending node and enter the shutdown method with either the restart or halt options in the following table.

Parameter

CAUTION:
This method restarts all networking services on a node, causing temporary loss of networking connectivity.

This method has the following input parameter:

Name Description Type Default value Required
option Action to take for the node shutdown:
  • restart: Restarts the node.
  • halt: Performs full power-off of the node.
string None Yes
Note: You need to use port 443 to access the API service on an individual node. See the following HTTPS API request example, replacing <MIP> with the management IP address of the individual node, and <API version> with the version of Element software running on the node:
https://<MIP>:443/json-rpc/<API version>/?method=Shutdown&option=halt

Return values

This method has no return values.

Request example

Requests for this method are similar to the following example:

{
   "method": "Shutdown",
   "params": {
      "option": "restart"
   },
   "id": 1
}

Response example

This method returns a response similar to the following example:

{ "id" : 1, 
  "result" : {}
}