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

NAME

6       pntadm - DHCP network table management utility
7

SYNOPSIS

9       pntadm -C [-r resource] [-p path] [-u uninterpreted] network
10
11
12       pntadm -A name_IP_address [-c comment] [-e mm/dd/yyyy]
13            [-f num | keywords] [-h client_hostname]
14            [-i [-a] client_ID] [-m [-y] macro] [-s server]
15            [-r resource] [-p path] [-u uninterpreted] network
16
17
18       pntadm -M name_IP_address [-c comment] [-e mm/dd/yyyy]
19            [-f num | keywords] [-h client_hostname]
20            [-i [-a] client  ID] [-m [-y] macro]
21            [-n new_client_IP_address] [-s server] [-r resource]
22            [-p path] [-u uninterpreted] network
23
24
25       pntadm -D name_IP_address [-y] [-r resource] [-p path]
26            [-u uninterpreted] network
27
28
29       pntadm -P [-v] [-x] [-r resource] [-p path]
30            [-u uninterpreted] network
31
32
33       pntadm -R [-r resource] [-p path] [-u uninterpreted] network
34
35
36       pntadm -L [-r resource] [-p path] [-u uninterpreted]
37
38
39       pntadm -B [-v] [batchfile]
40
41

DESCRIPTION

43       The  pntadm  command  is  used to manage the Dynamic Host Configuration
44       Protocol (DHCP) network tables. It is used to add and  remove  networks
45       under  DHCP  management,  and add, delete, or modify IP address records
46       within network tables, or to view tables. For a description of the for‐
47       mat of DHCP network tables, see dhcp_network(4).
48
49
50       pntadm  can  be run as root or by other users assigned to the DHCP Man‐
51       agement profile. See rbac(5) and user_attr(4).
52
53
54       If the networks you want to add are subnetted, you need to  update  the
55       netmasks(4) table.
56
57
58       One  of  the  following options (function flags) must be specified with
59       the pntadm command: -A, -B, -C, -D, -L, -M, -P, or-R.
60

OPTIONS

62       The following options are supported:
63
64       -A name_IP_address        Add a client entry with hostname or client IP
65                                 address,  name_IP_address,  to the named DHCP
66                                 network table.
67
68                                 The following sub-options are optional:
69
70                                 -c comment            Comment    text.    The
71                                                       default is NULL.
72
73
74                                 -e mm/dd/yyyy         Absolute   lease.   The
75                                                       default is 0.
76
77
78                                 -f num | keywords     Flag value. The default
79                                                       is 00.
80
81                                                       The  flag  (-f)  option
82                                                       can be specified either
83                                                       as   a   single  number
84                                                       denoting  the  intended
85                                                       flag  value,  or  as  a
86                                                       series of the following
87                                                       keywords,      combined
88                                                       using the plus (+) sym‐
89                                                       bol:
90
91                                                       DYNAMIC or 00      Server
92                                                                          man‐
93                                                                          ager's
94                                                                          assign‐
95                                                                          ment.
96
97
98                                                       PERMANENT or 01    Lease
99                                                                          on
100                                                                          entry
101                                                                          is
102                                                                          per‐
103                                                                          ma‐
104                                                                          nent.
105
106
107                                                       MANUAL or 02       Admin‐
108                                                                          is‐
109                                                                          tra‐
110                                                                          tor
111                                                                          man‐
112                                                                          aged
113                                                                          assign‐
114                                                                          ment.
115
116
117                                                       UNUSABLE or 04     Entry
118                                                                          is
119                                                                          not
120                                                                          valid.
121
122
123                                                       BOOTP or 08        Entry
124                                                                          reserved
125                                                                          for
126                                                                          BOOTP
127                                                                          clients.
128
129                                                       For  a  more   detailed
130                                                       description of the flag
131                                                       values,  see  dhcp_net‐
132                                                       work(4).
133
134
135                                 -h client_hostname    Client   hostname.  The
136                                                       default is NULL.
137
138                                                       When the -h  option  is
139                                                       used  in this mode, the
140                                                       client_hostname      is
141                                                       added  to the hosts ta‐
142                                                       ble within the resource
143                                                       used  for  storing host
144                                                       names (files,  NIS+  or
145                                                       DNS).  The command will
146                                                       fail      if       this
147                                                       client_hostname      is
148                                                       already present in  the
149                                                       hosts table.
150
151
152                                 -i client_ID [-a]     Client identifier [-a].
153                                                       The default is 00.
154
155                                                       The -i option  modified
156                                                       with  -a specifies that
157                                                       the  client  identifier
158                                                       is in ASCII format, and
159                                                       thus needs to  be  con‐
160                                                       verted  to  hexadecimal
161                                                       format before insertion
162                                                       into the table.
163
164
165                                 -m macro [-y]         Macro  name. Default is
166                                                       UNKNOWN.
167
168                                                       The -m option  modified
169                                                       with  -y  verifies  the
170                                                       existence of the  named
171                                                       macro  in  the  dhcptab
172                                                       table before adding the
173                                                       entry.
174
175
176                                 -s server             Server   IP   or  name.
177                                                       Default is system  name
178                                                       (uname -n).
179
180
181
182       -B                        Activate  batch  mode.  pntadm will read from
183                                 the specified file or from standard  input  a
184                                 series  of  pntadm  commands and execute them
185                                 within  the  same  process.  Processing  many
186                                 pntadm  commands  using  this  method is much
187                                 faster than running an  executable  batchfile
188                                 itself.  Batch  mode is recommended for using
189                                 pntadm in scripts.
190
191                                 The following sub-option is optional:
192
193                                 -v    Display commands to standard output  as
194                                       they are processed.
195
196
197
198       -C                        Create the DHCP network table for the network
199                                 specified by network. See . For details,  see
200                                 dhcp_network(4) and networks(4).
201
202
203       -D  name_IP_address       Delete  the specified client entry with host‐
204                                 name or client IP  address,  name_IP_address,
205                                 in   the   named  DHCP  network  table.  (See
206                                 dhcp_network(4).)
207
208                                 The following sub-option is optional:
209
210                                 -y    Remove associated host table entry. The
211                                       -y  option  requests that all hostnames
212                                       associated with the IP address  in  the
213                                       hosts table in the resource be removed.
214
215
216
217       -L                        List  the  DHCP network tables presently con‐
218                                 figured, one per line, on standard output. If
219                                 none  are  found, no output is printed and an
220                                 exit status of 0 is returned.
221
222
223       -M  name_IP_address       Modify the specified client entry with  host‐
224                                 name  or  client IP address, name_IP_address,
225                                 in  the  named  DHCP   network   table.   See
226                                 dhcp_network(4).  The  default  for  the sub-
227                                 options is what they currently are set to.
228
229                                 The following sub-options are optional.
230
231                                 -c comment                   New      comment
232                                                              text.
233
234
235                                 -e mm/dd/yy                  New     absolute
236                                                              lease expiration
237                                                              date.       Time
238                                                              defaults      to
239                                                              12:00  AM of the
240                                                              day specified.
241
242
243                                 -f num | keyboard            New flag  value,
244                                                              see  explanation
245                                                              following    the
246                                                              description   of
247                                                              the -A option.
248
249
250                                 -h host_name                 New client host‐
251                                                              name.
252
253                                                              The   -h  option
254                                                              allows  you   to
255                                                              change  the cur‐
256                                                              rent    hostname
257                                                              associated  with
258                                                              the  IP  address
259                                                              or  to add a new
260                                                              hostname to  the
261                                                              hosts  table  if
262                                                              an entry associ‐
263                                                              ated  with  this
264                                                              IP address  does
265                                                              not exist.
266
267
268                                 -i client_ID                 New client iden‐
269                                                              tifier [-a].
270
271
272                                 -m macro [-y]                Macro       name
273                                                              defined       in
274                                                              dhcptab.
275
276
277                                 -n  new_client_IP_address    New IP address.
278
279
280                                 -s server                    New server IP or
281                                                              name.
282
283                                  For  more  detailed  description of the sub-
284                                 options and flag values, see dhcp_network(4).
285
286
287       -P                        Display the named DHCP network table.
288
289                                 The following sub-options are optional:
290
291                                 -v    Display lease time in full verbose for‐
292                                       mat  and  resolve  IP addresses for the
293                                       clients and server to hostnames.
294
295
296                                 -x    Display lease time in raw format.
297
298                                 These flag codes are used with  the  -P  sub-
299                                 options:
300
301
302
303
304                                 -v                   -x                    Description
305                                 D                    00                    DYNAMIC
306                                 P                    01                    PERMANENT
307                                 M                    02                    MANUAL
308                                 U                    04                    UNUSABLE
309                                 B                    08                    BOOTP
310
311                                 See  dhcp_network(4) for information on these
312                                 sub-options and associated flag codes.
313
314
315       -p path                   Override  the  dhcpsvc.conf(4)  configuration
316                                 value  for data store resource path, path See
317                                 dhcpsvc.conf(4)
318
319
320       -R                        Remove the  named  DHCP  network  table.  See
321                                 dhcp_network(4).
322
323
324       -r data_store_resource    Override  the /etc/inet/dhcpsvc.conf configu‐
325                                 ration   value   for   RESOURCE=   with   the
326                                 data_store_resource    specified.   See   the
327                                 dhcpsvc.conf(4) man page for more details  on
328                                 resource  type, and the  for more information
329                                 about adding support for other data stores.
330
331
332       -u uninterpreted          Data which will be  ignored  by  pntadm,  but
333                                 passed  to  the  currently  configured public
334                                 module to be interpreted by the  data  store.
335                                 This  might  be  used  for a database account
336                                 name or other authentication or authorization
337                                 parameters  required  by  a  particular  data
338                                 store.
339
340

OPERANDS

342       The following operand is supported:
343
344       network    The network address or network name which corresponds to the
345                  dhcp network table. See dhcp_network(4).
346
347

EXAMPLES

349       Example 1 Creating a Table for the 10.0.0.0 DHCP Network
350
351
352       The  following  command  creates a table for the 10.0.0.0 (subnetted to
353       class C) DHCP network table. Note that if you have an  alias  for  this
354       network  in  your networks(4) table, you can use that value rather than
355       the dotted Internet Address notation.
356
357
358         example# pntadm -C 10.0.0.0
359
360
361
362       Example 2 Adding an Entry to the 10.0.0.0 Table
363
364
365       The following command adds an entry to the 10.0.0.0 table in the  files
366       resource in the /var/mydhcp directory:
367
368
369         example# pntadm -r SUNWfiles -p /var/mydhcp -A 10.0.0.1 10.0.0.0
370
371
372
373       Example 3 Modifying the 10.0.0.1 Entry of the 10.0.0.0 Table
374
375
376       The  following  command modifies the 10.0.0.1 entry of the 10.0.0.0 ta‐
377       ble, changing the macro name to Green, setting the flags field to  MAN‐
378       UAL and PERMANENT:
379
380
381         example# pntadm -M 10.0.0.1 -m Green -f 'PERMANENT+MANUAL' 10.0.0.0
382
383
384
385       Example 4 Changing the 10.0.0.1 Entry to 10.0.0.2
386
387
388       The following command changes the 10.0.0.1 entry to 10.0.0.2, making an
389       entry in the hosts(4) table called myclient:
390
391
392         example# pntadm -M 10.0.0.1 -n 10.0.0.2 -h myclient 10.0.0.0
393
394
395
396       Example 5 Setting the Client ID as ASCII
397
398
399       The following command sets the client ID as ASCII aruba.foo.com for the
400       myclient entry:
401
402
403         example# pntadm -M myclient -i 'aruba.foo.com' -a 10.0.0.0
404
405
406
407       Example 6 Deleting the myclientEntry from the 10.0.0.0 Table
408
409
410       The  following  command  deletes the myclient (10.0.0.2) entry from the
411       10.0.0.0 table:
412
413
414         example# pntadm -D myclient 10.0.0.0
415
416
417
418       Example 7 Removing the Named DHCP Network Table
419
420
421       The following command removes the named DHCP network table in the  NIS+
422       directory specified:
423
424
425         example# pntadm -r SUNWnisplus -p Test.Nis.Plus. -R 10.0.0.0
426
427
428
429       Example 8 Listing the Configured DHCP Network Tables
430
431
432       The following command lists the configured DHCP network tables:
433
434
435         example# pntadm -L
436         192.168.0.0
437         10.0.0.0
438
439
440
441       Example 9 Executing pntadm Commands in Batch Mode
442
443
444       The  following  command runs a series of pntadm commands contained in a
445       batch file:
446
447
448         example# pntadm -B addclients
449
450
451

EXIT STATUS

453       0    Successful completion.
454
455
456       1    Object already exists.
457
458
459       2    Object does not exist.
460
461
462       3    Non-critical error.
463
464
465       4    Critical error.
466
467

FILES

469       /etc/inet/dhcpsvc.conf
470
471
472       /etc/inet/hosts
473
474

ATTRIBUTES

476       See attributes(5) for descriptions of the following attributes:
477
478
479
480
481       ┌─────────────────────────────┬─────────────────────────────┐
482       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
483       ├─────────────────────────────┼─────────────────────────────┤
484       │Availability                 │SUNWdhcsu                    │
485       ├─────────────────────────────┼─────────────────────────────┤
486       │Interface Stability          │Evolving                     │
487       └─────────────────────────────┴─────────────────────────────┘
488

SEE ALSO

490       dhcpconfig(1M),  dhcpmgr(1M),   dhcp_network(4),   ,   dhcpsvc.conf(4),
491       dhcptab(4),    hosts(4),    netmasks(4),   networks(4),   user_attr(4),
492       attributes(5), dhcp(5), dhcp_modules(5), rbac(5)
493
494
495
496
497
498
499
500
501       Alexander, S., and R. Droms, DHCP Options and BOOTP Vendor  Extensions,
502       RFC 1533, Lachman Technology, Inc., Bucknell University, October 1993.
503
504
505       Droms,  R.,  Interoperation  Between DHCP and BOOTP, RFC 1534, Bucknell
506       University, October 1993.
507
508
509       Droms, R., Dynamic Host Configuration Protocol, RFC 1541, Bucknell Uni‐
510       versity, October 1993.
511
512
513       Wimer,  W.,  Clarifications  and Extensions for the Bootstrap Protocol,
514       RFC 1542, Carnegie Mellon University, October 1993.
515
516
517
518SunOS 5.11                        9 Jan 2004                        pntadm(1M)
Impressum