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

Update the NDMP mode

PDFs

PATCH /protocols/ndmp

Updates the NDMP mode.

  • system services ndmp node-scope-mode

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

Request Body

Name Type Description

_links

_links

mode

string

Indicates whether NDMP is in node-scoped or SVM-scoped mode.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "mode": "string"
}

Response

Status: 200, Ok
Name Type Description

_links

_links

mode

string

Indicates whether NDMP is in node-scoped or SVM-scoped mode.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "mode": "string"
}

Error

Status: Default, Error
Name Type Description

error

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

cluster_ndmp_properties

Name Type Description

_links

_links

mode

string

Indicates whether NDMP is in node-scoped or SVM-scoped mode.

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.