Skip to main content
REST API reference
A newer release of this product is available.

Update an NDMP node configuration for a node

PDFs

PATCH /protocols/ndmp/nodes/{node.uuid}

Introduced In: 9.7

Updates the NDMP node configuration for a specific node.

  • system services ndmp modify

Learn more

Parameters

Name Type In Required Description

node.uuid

string

path

True

Node UUID

Request Body

Name Type Description

authentication_types

array[string]

NDMP authentication types.

enabled

boolean

Is the NDMP service enabled?

node

node

Storage system node

password

string

NDMP password. This can only be set and cannot be read back.

user

string

NDMP user ID
Example request 
{
  "authentication_types": [
    "plaintext",
    "challenge"
  ],
  "enabled": 1,
  "node": {
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "password": "string",
  "user": "ndmp_user"
}

Response

Status: 200, Ok
Name Type Description

authentication_types

array[string]

NDMP authentication types.

enabled

boolean

Is the NDMP service enabled?

node

node

Storage system node

password

string

NDMP password. This can only be set and cannot be read back.

user

string

NDMP user ID
Example response 
{
  "authentication_types": [
    "plaintext",
    "challenge"
  ],
  "enabled": 1,
  "node": {
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "password": "string",
  "user": "ndmp_user"
}

Error

Status: Default

ONTAP Error Response codes

Error code Description

68812800

The user is required to enable NDMP on a node.

68812801

Node-scoped operations are not allowed in an SVM-scope.

68812802

The UUID is not valid.

Definitions

See Definitions

href

Name Type Description

href

string

_links

node

Storage system node

Name Type Description

name

string

uuid

string

ndmp_node

Name Type Description

authentication_types

array[string]

NDMP authentication types.

enabled

boolean

Is the NDMP service enabled?

node

node

Storage system node

password

string

NDMP password. This can only be set and cannot be read back.

user

string

NDMP user ID

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.