Skip to main content

Retrieve NDMP session details

Contributors
PDFs

GET /protocols/ndmp/sessions/{owner.uuid}/{session.id}

Introduced In: 9.7

Retrieves the details of a specific NDMP session.

  • vserver services ndmp probe

  • system services ndmp probe

Learn more

Parameters

Name Type In Required Description

owner.uuid

string

path

True

The NDMP node or SVM UUID based on whether NDMP is operating in node-scope or SVM-scope mode.

session.id

string

path

True

NDMP session identifier

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

backup_engine

string

Indicates the NDMP backup engine.

client_address

string

Indicates the NDMP client address.

client_port

integer

Indicates the NDMP client port.

data

ndmp_data

Information about the NDMP data server.

data_path

string

Indicates the NDMP backup or restore path.

id

string

NDMP session identifier.

mover

ndmp_mover

Information about the NDMP mover.

node

node

scsi

ndmp_scsi

Information about the NDMP SCSI server.

source_address

string

Indicates the NDMP local address on which connection was established.

svm

svm

SVM, applies only to SVM-scoped objects.

tape_device

string

Indicates the NDMP tape device.

tape_mode

string

The modes of a NDMP mover instance.

uuid

string

The NDMP node or SVM UUID based on whether NDMP is operating in node-scope or SVM-scope mode.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "backup_engine": "string",
  "client_address": "string",
  "data": {
    "bytes_processed": 5000,
    "connection": {
      "address": "string",
      "port": 18600,
      "type": "local"
    },
    "operation": "backup",
    "reason": "aborted",
    "state": "halted"
  },
  "data_path": "/vserver1/vol1",
  "id": "string",
  "mover": {
    "bytes_moved": 645120,
    "connection": {
      "address": "string",
      "port": 18600,
      "type": "local"
    },
    "mode": "read",
    "reason": "end_of_media",
    "state": "connected"
  },
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "scsi": {
    "device_id": "string"
  },
  "source_address": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "tape_device": "nrst0a",
  "tape_mode": "write",
  "uuid": "string"
}

Error

Status: Default

ONTAP Error Response codes

Error code Description

68812802

The UUID is not valid.
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

self

href

ndmp_connect

Indicates the NDMP connection attributes.

Name Type Description

address

string

Indicates the NDMP data connection address.

port

integer

Indicates the NDMP data connection port.

type

string

The different NDMP connection types.

ndmp_data

Information about the NDMP data server.

Name Type Description

bytes_processed

integer

Indicates the NDMP data bytes processed.

connection

ndmp_connect

Indicates the NDMP connection attributes.

operation

string

Indicates the NDMP data server operation.

reason

string

If the NDMP mover or data server is in the paused or halted state, then this property provides additional information for the state.

state

string

The various states of the NDMP state machine during a backup or restore workflow.

ndmp_mover

Information about the NDMP mover.

Name Type Description

bytes_moved

integer

Indicates the NDMP mover bytes moved.

connection

ndmp_connect

Indicates the NDMP connection attributes.

mode

string

The modes of a NDMP mover instance.

reason

string

If the NDMP mover or data server is in the paused or halted state, then this property provides additional information for the state.

state

string

The various states of the NDMP state machine during a backup or restore workflow.

node

Name Type Description

_links

_links

name

string

uuid

string

ndmp_scsi

Information about the NDMP SCSI server.

Name Type Description

device_id

string

Indicates the NDMP SCSI device ID.

host_adapter

integer

Indicates the NDMP SCSI host adapter.

lun_id

integer

Indicates the NDMP SCSI LUN ID.

target_id

integer

Indicates the NDMP SCSI target ID.

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

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.

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.