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

Retrieve the NDMP node configurations for all nodes

Contributors
PDFs

GET /protocols/ndmp/nodes

Introduced In: 9.7

Retrieves NDMP node configurations for all of the nodes.

  • system services ndmp show

Learn more

Parameters

Name Type In Required Description

user

string

query

False

Filter by user

enabled

boolean

query

False

Filter by enabled

node.name

string

query

False

Filter by node.name

node.uuid

string

query

False

Filter by node.uuid

authentication_types

string

query

False

Filter by authentication_types

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of Records

records

array[ndmp_node]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_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.

68812804

Failed to get the node name from the specified node UUID.
Name Type Description

error

returned_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

next

href

self

href

_links

Name Type Description

self

href

node

Storage system node

Name Type Description

_links

_links

name

string

uuid

string

ndmp_node

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

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.