Skip to main content
REST API reference

Update NDMP configuration for an SVM

PDFs

PATCH /protocols/ndmp/svms/{svm.uuid}

Introduced In: 9.7

Updates the NDMP configuration for a specific SVM.

  • vserver services ndmp modify

Learn more

Parameters

Name Type In Required Description

svm.uuid

string

path

True

SVM UUID

Request Body

Name Type Description

authentication_types

array[string]

NDMP authentication types.

enabled

boolean

Is the NDMP service enabled on the SVM?

svm

svm

SVM, applies only to SVM-scoped objects.
Example request 
{
  "authentication_types": [
    "plaintext",
    "challenge"
  ],
  "enabled": 1,
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 200, Ok
Name Type Description

authentication_types

array[string]

NDMP authentication types.

enabled

boolean

Is the NDMP service enabled on the SVM?

svm

svm

SVM, applies only to SVM-scoped objects.
Example response 
{
  "authentication_types": [
    "plaintext",
    "challenge"
  ],
  "enabled": 1,
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default

ONTAP Error Response codes

Error code Description

65601536

The operation is not supported because NDMP SVM-aware mode is disabled.

65601551

Authentication type "plaintext_sso" cannot be combined with other authentication types.

Definitions

See Definitions

href

Name Type Description

href

string

_links

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

ndmp_svm

Name Type Description

authentication_types

array[string]

NDMP authentication types.

enabled

boolean

Is the NDMP service enabled on the SVM?

svm

svm

SVM, applies only to SVM-scoped objects.

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.