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

Update the NDMP configuration for an SVM

PDFs

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

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

_links

_links

authentication_types

array[string]

NDMP authentication types.

enabled

boolean

Is the NDMP service enabled on the SVM?

svm

svm
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "authentication_types": [
    "plaintext",
    "challenge"
  ],
  "enabled": 1,
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 200, Ok
Name Type Description

_links

_links

authentication_types

array[string]

NDMP authentication types.

enabled

boolean

Is the NDMP service enabled on the SVM?

svm

svm
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "authentication_types": [
    "plaintext",
    "challenge"
  ],
  "enabled": 1,
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Error

Status: Default, Error

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

ndmp_svm

Name Type Description

_links

_links

authentication_types

array[string]

NDMP authentication types.

enabled

boolean

Is the NDMP service enabled on the SVM?

svm

svm