vserver services ndmp status

Display list of NDMP sessions

Availability: This command is available to cluster and Vserver administrators at the admin privilege level.

Description

The vserver services ndmp status command lists NDMP sessions belonging to a specific Vserver in the cluster. By default it lists the following details about the active sessions: A combination of parameters can be optionally supplied so as to list only those sessions which match specific conditions. A short description of each of the parameter is provided in the parameters section.

Parameters

{ [-fields <fieldname>, ...]
This optional parameter specifies which all additional fields to display. Any combination of the following fields are valid:
  • ndmp-version
  • session-authorized
  • data-state
  • data-operation
  • data-halt-reason
  • data-con-addr-type
  • data-con-addr
  • data-con-port
  • data-bytes-processed
  • mover-state
  • mover-mode
  • mover-pause-reason
  • mover-halt-reason
  • mover-record-size
  • mover-record-num
  • mover-bytes-moved
  • mover-seek-position
  • mover-bytes-left-to-read
  • mover-window-offset
  • mover-window-length
  • mover-position
  • mover-setrecordsize-flag
  • mover-setwindow-flag
  • mover-con-addr-type
  • mover-con-addr
  • mover-con-port
  • eff-host
  • client-addr
  • client-port
  • spt-device-id
  • spt-ha
  • spt-scsi-id
  • spt-scsi-lun
  • tape-device
  • tape-modes
  • node
  • is-secure-control-connection
  • data-backup-mode
  • data-path
  • source-addr
| [-instance ]}
If this parameter is specified, the command displays detailed information about all the active sessions.
[-vserver <vserver name>] - Vserver
Specifies the Vserver context in which NDMP sessions are running.
[-session-id <text>] - Session Identifier
If this parameter is specified, the command displays information about specific NDMP session. A session-id is a string used to identify a particular NDMP session.
[-ndmp-version <integer>] - NDMP Version
This parameter refers to the NDMP protocol version being used in the session.
[-session-authorized {true|false}] - Session Authorized
This field indicates whether an NDMP session is authenticated or not.
[-data-state <component state>] - Data State
This field identifies the current state of the data server's state machine.
[-data-operation <data operation>] - Data Operation
This field identifies the data server's current operation.
[-data-halt-reason <halt reason>] - Data Server Halt Reason
This field identifies the event that caused the data server state machine to enter the HALTED state.
[-data-con-addr-type <address type>] - Data Server Connect Type
This field specifies the type of data connection established by the data server. The data connection can be established locally within a given system or between remote networked systems.
[-data-con-addr <text>] - Data Server Connect Address
This specifies the connection endpoint information for the data server's data connection.
[-data-con-port <integer>] - Data Server Connect Port
This specifies the TCP/IP port that the data server will use when establishing a data connection.
[-data-bytes-processed <integer>] - Data Bytes Processed
This field represents the cumulative number of data stream bytes transferred between the backup or recovery method and the data connection during the current data operation.
[-mover-state <component state>] - Mover State
This parameter identifies the current state of the NDMP tape server's mover state machine.
[-mover-mode <mover mode>] - Mover Mode
This parameter identifies the direction of the mover data transfer.
[-mover-pause-reason <pause reason>] - Mover Pause Reason
This parameter identifies the event that caused the mover state machine to enter the PAUSED state.
[-mover-halt-reason <halt reason>] - Mover Halt Reason
This integer field identifies the event that caused the mover state machine to enter the HALTED state.
[-mover-record-size <integer>] - Mover Record Size
This field represents the current mover record size in bytes.
[-mover-record-num <integer>] - Mover Record Number
This field represents the last tape record processed by the mover.
[-mover-bytes-moved <integer>] - Mover Bytes Moved
This field represents the cumulative number of data stream bytes written to the data connection or the number of data stream bytes read from the data connection and written to the tape subsystem, depending on the mode of mover operation.
[-mover-seek-position <integer>] - Mover Seek Position
This field represents the data stream offset of the first byte the DMA requested the mover to transfer to the data connection during a mover read operation.
[-mover-bytes-left-to-read <integer>] - Mover Bytes Left to Read
This field represents the number of data bytes remaining to be transferred to the data connection to satisfy the current NDMP_MOVER_READ request.
[-mover-window-offset <integer>] - Mover Window Offset
This field represents the absolute offset of the first byte of the mover window within the overall data stream.
[-mover-window-length <integer>] - Mover Window Length
This field represents the length of the current mover window in bytes.
[-mover-position <integer>] - Mover Position
This parameter can be used to list only those sessions, whose mover position matches a specific value. Mover-position should be an integer.
[-mover-setrecordsize-flag {true|false}] - Mover SetRecordSize Flag
This field is used by the DMA to establish the record size used for mover-initiated tape read and write operations.
[-mover-setwindow-flag {true|false}] - Mover SetWindow Flag
This flag represents whether a mover window has been set or not. A mover window represents the portion of the overall backup stream that is accessible to the mover without intervening DMA tape manipulation.
[-mover-con-addr-type <address type>] - Mover Connect Type
This field specifies the type of data connection established by the mover. The data connection can be established locally within a given system or between remote networked systems.
[-mover-con-addr <text>] - Mover Connect Address
This specifies the endpoint address or addresses that the mover will use when establishing a data connection.
[-mover-con-port <integer>] - Mover Connect Port
This specifies the TCP/IP port that the mover will use when establishing a data connection.
[-eff-host <host type>] - Effective Host
This field indicates the host context in which the NDMP session runs. The valid values are: PRIMARY or PARTNER.
[-client-addr <text>] - NDMP Client Address
This parameter specifies the client's IP address.
[-client-port <integer>] - NDMP Client Port
This parameter specifies the client's port number.
[-spt-device-id <text>] - SCSI Device ID
This parameter specifies the SCSI device ID.
[-spt-ha <integer>] - SCSI Host Adapter
This parameter specifies the SCSI host adapter.
[-spt-scsi-id <integer>] - SCSI Target ID
This parameter specifies the SCSI target.
[-spt-scsi-lun <integer>] - SCSI LUN ID
This parameter specifies the SCSI LUN ID.
[-tape-device <text>] - Tape Device
This parameter specifies the name to identify the tape device.
[-tape-mode <mover mode>] - Tape Mode
This parameter specifies the mode in which tapes are opened.
[-node {<nodename>|local}] - Node
If this parameter is specified, the command displays information about the sessions running on the specified node only. Node should be a valid node name.
[-is-secure-control-connection {true|false}] - Is Secure Control Connection
This parameter specifies whether the control connection is secure or not.
[-data-backup-mode <text>] - Data Backup Mode
This parameter specifies whether the mode of data backup is Dump or SMTape.
[-data-path <text>] - Data Path
This parameter specifies the path of data being backed up.
[-source-addr <text>] - NDMP Source Address
This parameter specifies the control connection IP address of the NDMP session.

Examples

The following example displays all the NDMP sessions on the cluster:

cluster1::> vserver services ndmp status
                       Session
     Vserver             Id
------------------   ------------
          vserver1   1000:7445
          vserver2   1000:7446
          vserver2   1000:7447
3 entries were displayed.


The following example shows how to display only the sessions running belonging to Vserver vserver2:

cluster1::> vserver services ndmp status -vserver vserver2
                       Session
     Vserver             Id
------------------   ------------
          vserver2   1000:7446
          vserver2   1000:7447
2 entries were displayed.