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

Retrieve the NDMP node configuration for a node

Contributors
PDFs

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

Retrieves an NDMP node configuration for a specific node.

  • system services ndmp show

Learn more

Parameters

Name Type In Required Description

fields

array[string]

query

False

Specify the fields to return.

node.uuid

string

path

True

Node UUID

Response

Status: 200, Ok
Name Type Description

_links

_links

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 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "authentication_types": [
    "plaintext",
    "challenge"
  ],
  "enabled": 1,
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "password": "string",
  "user": "ndmp_user"
}

Error

Status: Default

ONTAP Error Response codes

Error code Description

68812801

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

68812802

The UUID is not valid.

68812804

Failed to get the node name from the specified node UUID.
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

node

Storage system node

Name Type Description

_links

_links

name

string

uuid

string

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.