Skip to main content

Delete a node from a cluster

Contributors
PDFs

DELETE /cluster/nodes/{uuid}

Introduced In: 9.7

Deletes a node from the cluster. Note that before deleting a node from the cluster, you must shut down all of the node's shared resources, such as virtual interfaces to clients. If any of the node's shared resources are still active, the command fails.

Optional parameters:

  • force - Forcibly removes a node that is down and cannot be brought online to remove its shared resources. This flag is set to "false" by default.

  • cluster remove-node

Learn more

Parameters

Name Type In Required Description

uuid

string

path

True

force

boolean

query

False

Set the force flag to "true" to forcibly remove a node that is down and cannot be brought online to remove its shared resources.

  • Default value:

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

Response

Status: 200, Ok
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

458755

Replication service is offline.

458758

Failed to load job for cluster remove node operation as the job exists.

1179732

Cannot remove a node in a single-node cluster.

1179735

Node is not part of a cluster.

1182805

Cannot remove a node from the node network address of the node to be removed.

2293765

Removing a node only works for nodes not in failover configuration.

2293767

Node has volumes. Either move or delete them from the node before removing the node.

2293768

Node is the home node for one or more logical interfaces.

2293769

Node is the current node for one or more logical interfaces.

2293770

Node has data logical interfaces configured as target node.

2293787

Cannot remove node a node with epsilon.

2293788

Failed to check HA configuration in the cluster.

2293789

Removing a node only works for nodes not in HA configuration.

2293790

Failed to check if the node has epsilon.

2293796

Cluster ring is offline on the node

2293798

Cannot forcibly remove a node that is online.

2293800

Node is configured with MetroCluster.

2293801

Cannot remove node because it has foreign LUN Imports.

2293812

Node is a member of MetroCluster DR group.

2293813

Cannot remove a node from the cluster because a controller replacement is in progress.

2293814

The DELETE operation is not supported until the cluster is upgraded.

2293816

Cannot remove node because its Storage Encryption devices use authentication keys (AKs) that will not be available to the node after it leaves the cluster.

2293821

Cannot remove a node that is offline.

10551347

An update is in progress.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.