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

Retrieve NDMP sessions

Contributors
PDFs

GET /protocols/ndmp/sessions

Retrieves a collection of NDMP sessions. In the case of SVM-scope, if this API is executed on a data IP, it displays the list of NDMP sessions under the specified SVM; otherwise it displays the list of NDMP sessions for all the SVMs under the cluster. In the case of node-scope, it displays the list of NDMP sessions for all nodes.

  • vserver services ndmp probe

  • system services ndmp probe

Learn more

Parameters

Name Type In Required Description

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.

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.

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

client_port

integer

query

False

Filter by client_port

source_address

string

query

False

Filter by source_address

data.reason

string

query

False

Filter by data.reason

data.connection.type

string

query

False

Filter by data.connection.type

data.connection.address

string

query

False

Filter by data.connection.address

data.connection.port

integer

query

False

Filter by data.connection.port

data.state

string

query

False

Filter by data.state

data.bytes_processed

integer

query

False

Filter by data.bytes_processed

data.operation

string

query

False

Filter by data.operation

client_address

string

query

False

Filter by client_address

tape_device

string

query

False

Filter by tape_device

id

string

query

False

Filter by id

data_path

string

query

False

Filter by data_path

tape_mode

string

query

False

Filter by tape_mode

mover.bytes_moved

integer

query

False

Filter by mover.bytes_moved

mover.state

string

query

False

Filter by mover.state

mover.mode

string

query

False

Filter by mover.mode

mover.connection.type

string

query

False

Filter by mover.connection.type

mover.connection.address

string

query

False

Filter by mover.connection.address

mover.connection.port

integer

query

False

Filter by mover.connection.port

mover.reason

string

query

False

Filter by mover.reason

backup_engine

string

query

False

Filter by backup_engine

scsi.target_id

integer

query

False

Filter by scsi.target_id

scsi.lun_id

integer

query

False

Filter by scsi.lun_id

scsi.host_adapter

integer

query

False

Filter by scsi.host_adapter

scsi.device_id

string

query

False

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of Records.

records

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

Error

Status: Default

ONTAP Error Response codes

Error code Description

68812805

Failed to obtain the NDMP mode of the operation.
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

next

href

self

href

_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

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

ndmp_session

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

tape_device

string

Indicates the NDMP tape device.

tape_mode

string

The modes of a NDMP mover instance.

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.