ndmpadm(1m) - osol9

1ndmpadm(1M)             System Administration Commands             ndmpadm(1M)
2
3
4

NAME

6       ndmpadm - administer Network Data Management Protocol activities
7

SYNOPSIS

9       /usr/sbin/ndmpadm [-? ] subcommand [options] [direct-object]
10
11

DESCRIPTION

13       The  ndmpadm  command  can be used to query the ndmpd(1M) daemon to get
14       the status of  active  sessions,  terminate  a  session,  query  backup
15       devices,  and set or get the current NDMP (Network Data Management Pro‐
16       tocol) service variables and properties. ndmpadm is  implemented  as  a
17       set  of  subcommands,  many  with  their  own  direct object, which are
18       described in the section for a given  subcommand.  Certain  subcommands
19       support options, which are described along with the subcommand.
20
21
22       The ndmpadm command supports the following subcommands:
23
24       disable
25
26           Disable the specified authentication password handling.
27
28
29       enable
30
31           Enable the specified authentication password handling.
32
33
34       get
35
36           Get the value of an NDMP configuration property.
37
38
39       kill-sessions
40
41           Terminate an active session.
42
43
44       set
45
46           Set the value of an NDMP configuration property.
47
48
49       show-devices
50
51           Get a list of tape devices connected to the server.
52
53
54       show-sessions
55
56           Display the details of active NDMP sessions.
57
58

OPTIONS

60       The following option is supported:
61
62       -?    Display a list of all subcommands and options.
63
64

SUB-COMMANDS

66       The ndmpadm command supports the subcommands described below.
67
68   disable Subcommand
69       The syntax for the disable subcommand is:
70
71         # ndmpadm disable -a auth-type
72
73
74
75
76       This subcommand disables the authentication type specified by auth-type
77       for an NDMP client's remote access.  Valid  values  for  auth-type  are
78       cram-md5 or cleartext.
79
80   enable Subcommand
81       The syntax for the enable subcommand is:
82
83         # ndmpadm enable -a auth-type -u username
84
85
86
87
88       This  subcommand prompts for the user's password twice for confirmation
89       and activates the specified authentication type with the given username
90       and  password  for  NDMP  client access. Valid values for auth-type are
91       cram-md5 or cleartext.
92
93   get Subcommand
94       The syntax for the get subcommand is:
95
96         # ndmpadm get [-p] [property] [[-p] property=value]...
97
98
99
100
101       The property names are the same as used for the set subcommand and  are
102       described  below.  If you do not specify a property, the get subcommand
103       returns all configuration properties.
104
105   kill-sessions Subcommand
106       The kill-sessions subcommand allows you to terminate the session number
107       ID.
108
109
110       The syntax for the kill-sessions subcommand is:
111
112         # ndmpadm kill-sessions ID
113
114
115
116   set Subcommand
117       The syntax for the set subcommand is:
118
119         # ndmpadm set [-p] property=value [[-p] property=value]...
120
121
122
123
124       The properties you can set with the set subcommand are described in the
125       ndmp(4) man page.
126
127   show-devices Subcommand
128       The syntax for the show-devices subcommand is:
129
130         # ndmpadm show-devices
131
132
133
134
135       This subcommand lists the name, vendor, serial number, and other infor‐
136       mation about the current tape drive and libraries connected to the sys‐
137       tem.
138
139   show-sessions Subcommand
140       The show-sessions subcommand displays details of a session. The  syntax
141       for the show-sessions subcommand is:
142
143         # ndmpadm show-sessions [-i tape,scsi,data,mover] [ID]
144
145
146
147
148       The show-sessions subcommand supports the following arguments:
149
150       -i tape,scsi,data,mover
151
152           Identify  a  type  of  interface  about which to obtain data. If no
153           interface is specified, show-sessions displays information for  all
154           types of interfaces.
155
156
157       ID
158
159           Identifies  a particular session about which to display data. If no
160           ID is specified, show-sessions displays data for all sessions.
161
162

EXAMPLES

164       Example 1 Obtaining the Status of All NDMP Connections
165
166
167       The following command obtains status on all connections.
168
169
170         # ndmpadm show-devices
171
172
173
174       Example 2 Obtaining the Status of Certain Types of Connections
175
176
177       The following command obtains status on tape and SCSI interfaces.
178
179
180         # ndmpadm show-sessions -i scsi,tape
181
182
183
184       Example 3 Limiting Protocol Version
185
186
187       The following command limits the use of the NDMP protocol to version 3.
188
189
190         # ndmpadm set -p version=3
191
192
193
194       Example 4 Turning on Debugging
195
196
197       The following command enables debugging. It also sets the NDMP protocol
198       to version 3.
199
200
201         # ndmpadm set -p debug-level=1 -p version=3
202
203
204
205       Example 5 Obtaining Current Version Number
206
207
208       The  following command obtains the version number of the currently run‐
209       ning NDMP.
210
211
212         # ndmpadm get -p version
213
214
215
216       Example 6 Disconnecting a Specific Session
217
218
219       The command shown below disconnects session 5. The session  number  was
220       previously obtained from an ndmpadm show-sessions command.
221
222
223         # ndmpadm kill-session 5
224
225
226
227       Example 7 Obtaining the Values for All NDMP Properties
228
229
230       The following command obtains the values for all NDMP properties.
231
232
233         # ndmpadm get
234
235
236
237       Example 8 Enabling CRAM-MD5 Authentication
238
239
240       The following command enables CRAM-MD5 authentication.
241
242
243         # ndmpadm enable -a cram-md5 -u admin
244         Enter new password:*****
245         Re-enter password:*****
246
247
248
249       Example 9 Disabling Clear Text Password Authentication
250
251
252       The following command disables clear text password authentication.
253
254
255         # ndmpadm disable -a cleartext
256
257
258

EXIT STATUS

260       0    Successful completion.
261
262
263       1    An  error  occurred, such as the ndmpd daemon is not running, that
264            prevented ndmpadm from contacting the demon.
265
266
267       2    Invalid command-line options were specified.
268
269

ATTRIBUTES

271       See attributes(5) for descriptions of the following attributes:
272
273
274
275
276       ┌─────────────────────────────┬─────────────────────────────┐
277       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
278       ├─────────────────────────────┼─────────────────────────────┤
279       │Availability                 │SUNWndmpu, SUNWndmpr         │
280       ├─────────────────────────────┼─────────────────────────────┤
281       │Interface Stability          │Committed                    │
282       └─────────────────────────────┴─────────────────────────────┘
283

NOTES

289       The  ndmpd(1M)  daemon  is  managed  by the service management facility
290       (smf(5)), under the service identifier:
291
292         svc:/system/ndmpd
293
294
295
296
297       Administrative actions on this service, such as setting and  getting  a
298       property  can  be alternatively performed using svccfg(1M). For example
299       to enable Direct Access Recovery (DAR) mode:
300
301         # svccfg -s svc:/system/ndmpd
302         svc:/system/ndmpd> setprop ndmpd/dar-support = yes
303
304
305
306
307       ...and to get the list of properties:
308
309         # svccfg -s svc:/system/ndmpd
310         svc:/system/ndmpd> listprop
311
312
313
314
315
316SunOS 5.11                        24 Jun 2009                      ndmpadm(1M)