Print this page
7388 Support DHCP Client FQDN. Allow IAID/DUID for all v4.
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1m/ipadm.1m
+++ new/usr/src/man/man1m/ipadm.1m
1 1 .\"
2 2 .\" This file and its contents are supplied under the terms of the
3 3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
4 4 .\" You may only use this file in accordance with the terms of version
|
↓ open down ↓ |
4 lines elided |
↑ open up ↑ |
5 5 .\" 1.0 of the CDDL.
6 6 .\"
7 7 .\" A full copy of the text of the CDDL should have accompanied this
8 8 .\" source. A copy of the CDDL is also available via the Internet at
9 9 .\" http://www.illumos.org/license/CDDL.
10 10 .\"
11 11 .\"
12 12 .\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved
13 13 .\" Copyright (c) 2013 by Delphix. All rights reserved.
14 14 .\" Copyright 2014 Nexenta Systems, Inc. All rights reserved.
15 +.\" Copyright (c) 2016, Chris Fraire <cfraire@me.com>.
15 16 .\"
16 -.Dd April 9, 2016
17 +.Dd November 7, 2016
17 18 .Dt IPADM 1M
18 19 .Os
19 20 .Sh NAME
20 21 .Nm ipadm
21 22 .Nd configure IP interfaces, addresses and protocols
22 23 .Sh SYNOPSIS
23 24 .Nm
24 25 .Ic create-if
25 26 .Op Fl t
26 27 .Ar interface
27 28 .Nm
28 29 .Ic disable-if
29 30 .Fl t
30 31 .Ar interface
31 32 .Nm
32 33 .Ic enable-if
33 34 .Fl t
34 35 .Ar interface
35 36 .Nm
36 37 .Ic delete-if
37 38 .Ar interface
38 39 .Nm
39 40 .Ic show-if
40 41 .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
41 42 .Op Ar interface
42 43 .Nm
43 44 .Ic set-ifprop
44 45 .Op Fl t
45 46 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
46 47 .Fl m Ar protocol
47 48 .Ar interface
48 49 .Nm
49 50 .Ic reset-ifprop
50 51 .Op Fl t
51 52 .Fl p Ar prop
52 53 .Fl m Ar protocol
53 54 .Ar interface
54 55 .Nm
55 56 .Ic show-ifprop
56 57 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar value Oc Ns ...
57 58 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
58 59 .Op Fl m Ar protocol
59 60 .Op Ar interface
60 61 .Nm
61 62 .Ic create-addr
62 63 .Op Fl t
|
↓ open down ↓ |
36 lines elided |
↑ open up ↑ |
63 64 .Fl T Cm static
64 65 .Op Fl d
65 66 .Fl a Oo Cm local Ns | Ns Cm remote Ns = Oc Ns
66 67 .Ar addr Ns Oo / Ns Ar prefixlen Oc Ns ...
67 68 .Ar addrobj
68 69 .Nm
69 70 .Ic create-addr
70 71 .Op Fl t
71 72 .Fl T Cm dhcp
72 73 .Op Fl w Ar seconds Ns | Ns Cm forever
74 +.Op Fl 1
75 +.Op Fl h Ar hostname
73 76 .Ar addrobj
74 77 .Nm
75 78 .Ic create-addr
76 79 .Op Fl t
77 80 .Fl T Cm addrconf
78 81 .Op Fl i Ar interface-id
79 82 .Oo Fl p Bro Cm stateful Ns | Ns Cm stateless Brc Ns = Ns
80 83 .Bro Cm yes Ns | Ns Cm no Brc Oc Ns ...
81 84 .Ar addrobj
82 85 .Nm
83 86 .Ic down-addr
84 87 .Op Fl t
85 88 .Ar addrobj
86 89 .Nm
87 90 .Ic up-addr
88 91 .Op Fl t
89 92 .Ar addrobj
90 93 .Nm
91 94 .Ic disable-addr
92 95 .Op Fl t
93 96 .Ar addrobj
94 97 .Nm
95 98 .Ic enable-addr
96 99 .Op Fl t
97 100 .Ar addrobj
98 101 .Nm
99 102 .Ic refresh-addr
100 103 .Op Fl i
101 104 .Ar addrobj
102 105 .Nm
103 106 .Ic delete-addr
104 107 .Op Fl r
105 108 .Ar addrobj
106 109 .Nm
107 110 .Ic show-addr
108 111 .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
109 112 .Op Ar addrobj
110 113 .Nm
111 114 .Ic set-addrprop
112 115 .Op Fl t
113 116 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
114 117 .Ar addrobj
115 118 .Nm
116 119 .Ic reset-addrprop
117 120 .Op Fl t
118 121 .Fl p Ar prop
119 122 .Ar addrobj
120 123 .Nm
121 124 .Ic show-addrprop
122 125 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
123 126 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
124 127 .Op Ar addrobj
125 128 .Nm
126 129 .Ic set-prop
127 130 .Op Fl t
128 131 .Fl p Ar prop Ns Oo Cm + Ns | Ns Cm - Oc Ns = Ns
129 132 .Ar value Ns Oo , Ns Ar value Oc Ns ...
130 133 .Ar protocol
131 134 .Nm
132 135 .Ic reset-prop
133 136 .Op Fl t
134 137 .Fl p Ar prop
135 138 .Ar protocol
136 139 .Nm
137 140 .Ic show-prop
138 141 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
139 142 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
140 143 .Op Ar protocol
141 144 .Sh DESCRIPTION
142 145 The
143 146 .Nm
144 147 command is a stable replacement for the
145 148 .Xr ifconfig 1M
146 149 and
147 150 .Xr ndd 1M
148 151 commands. It is used to create IP interfaces and to configure IP addresses on
149 152 those interfaces. It is also used to get, set or reset properties on interfaces,
150 153 addresses and protocols.
151 154 .Pp
152 155 For subcommands that take an
153 156 .Em addrobj ,
154 157 the
155 158 .Em addrobj
156 159 specifies a unique address on the system. It is made up of two parts, delimited
157 160 by a
158 161 .Sq / .
159 162 The first part is the name of the interface and the second part is a string up
160 163 to 32 characters long. For example,
161 164 .Qq lo0/v4
162 165 is a loopback interface
163 166 .Em addrobj
164 167 name.
165 168 .Pp
166 169 For subcommands that take a
167 170 .Em protocol ,
168 171 this can be one of the following values:
169 172 .Cm ip ,
170 173 .Cm ipv4 ,
171 174 .Cm ipv6 ,
172 175 .Cm icmp ,
173 176 .Cm tcp ,
174 177 .Cm sctp
175 178 or
176 179 .Cm udp.
177 180 .Sh SUBCOMMANDS
178 181 The following subcommands are supported:
179 182 .Bl -tag -width ""
180 183 .It Xo
181 184 .Nm
182 185 .Ic create-if
183 186 .Op Fl t
184 187 .Ar interface
185 188 .Xc
186 189 Create an IP interface that will handle both IPv4 and IPv6 packets. The
187 190 interface will be enabled as part of the creation process. The IPv4 interface
188 191 will have the address 0.0.0.0. The IPv6 interface will have the address ::.
189 192 .Bl -tag -width ""
190 193 .It Fl t Ns , Ns Fl -temporary
191 194 Temporary, not persistent across reboots.
192 195 .El
193 196 .It Xo
194 197 .Nm
195 198 .Ic disable-if
196 199 .Fl t
197 200 .Ar interface
198 201 .Xc
199 202 Disable an IP interface.
200 203 .Bl -tag -width ""
201 204 .It Fl t Ns , Ns Fl -temporary
202 205 Temporary, not persistent across reboots.
203 206 .El
204 207 .It Xo
205 208 .Nm
206 209 .Ic enable-if
207 210 .Fl t
208 211 .Ar interface
209 212 .Xc
210 213 Enable an IP interface.
211 214 .Bl -tag -width ""
212 215 .It Fl t Ns , Ns Fl -temporary
213 216 Temporary, not persistent across reboots.
214 217 .El
215 218 .It Xo
216 219 .Nm
217 220 .Ic delete-if
218 221 .Ar interface
219 222 .Xc
220 223 Permanently delete an IP interface.
221 224 .It Xo
222 225 .Nm
223 226 .Ic show-if
224 227 .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
225 228 .Op Ar interface
226 229 .Xc
227 230 Show the current IP interface configuration.
228 231 .Bl -tag -width ""
229 232 .It Fl o Ns , Ns Fl -output
230 233 Select which fields will be shown. The field value can be one of the following
231 234 names:
232 235 .Bl -tag -compact -width "PERSISTENT"
233 236 .It Cm ALL
234 237 Display all fields.
235 238 .It Cm IFNAME
236 239 The name of the interface.
237 240 .It Cm STATE
238 241 The state can be one of the following values:
239 242 .Bl -tag -compact -width "disabled"
240 243 .It Sy ok
241 244 resources for the interface have been allocated
242 245 .It Sy offline
243 246 the interface is offline
244 247 .It Sy failed
245 248 the interface's datalink is down
246 249 .It Sy down
247 250 the interface is down
248 251 .It Sy disabled
249 252 the interface is disabled
250 253 .El
251 254 .It Cm CURRENT
252 255 A set of single character flags indicating the following:
253 256 .Bl -tag -compact -width "b"
254 257 .It Sy b
255 258 broadcast (mutually exclusive with
256 259 .Sq p )
257 260 .It Sy m
258 261 multicast
259 262 .It Sy p
260 263 point-to-point (mutually exclusive with
261 264 .Sq b )
262 265 .It Sy v
263 266 virtual interface
264 267 .It Sy I
265 268 IPMP
266 269 .It Sy s
267 270 IPMP standby
268 271 .It Sy i
269 272 IPMP inactive
270 273 .It Sy V
271 274 VRRP
272 275 .It Sy a
273 276 VRRP accept mode
274 277 .It Sy 4
275 278 IPv4
276 279 .It Sy 6
277 280 IPv6
278 281 .El
279 282 .It Cm PERSISTENT
280 283 A set of single character flags showing what configuration will be used the
281 284 next time the interface is enabled:
282 285 .Bl -tag -compact -width "s"
283 286 .It Sy s
284 287 IPMP standby
285 288 .It Sy 4
286 289 IPv4
287 290 .It Sy 6
288 291 IPv6
289 292 .El
290 293 .El
291 294 .It Fl p Ns , Ns Fl -parsable
292 295 Print the output in a parsable format.
293 296 .El
294 297 .It Xo
295 298 .Nm
296 299 .Ic set-ifprop
297 300 .Op Fl t
298 301 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
299 302 .Fl m Ar protocol
300 303 .Ar interface
301 304 .Xc
302 305 Set a property's value(s) on the IP interface.
303 306 .Bl -tag -width ""
304 307 .It Fl m Ns , Ns Fl -module
305 308 Specify which protocol the setting applies to.
306 309 .It Fl p Ns , Ns Fl -prop
307 310 Specify the property name and value(s). The property name can be one of the
308 311 following:
309 312 .Bl -tag -compact -width "exchange_routes"
310 313 .It Cm arp
311 314 Address resolution protocol
312 315 .Pq Cm on Ns / Ns Cm off .
313 316 .It Cm exchange_routes
314 317 Exchange of routing data
315 318 .Pq Cm on Ns / Ns Cm off .
316 319 .It Cm forwarding
317 320 IP Forwarding
318 321 .Pq Cm on Ns / Ns Cm off
319 322 .It Cm metric
320 323 Set the routing metric to the numeric value. The value is treated as extra
321 324 hops to the destination.
322 325 .It Cm mtu
323 326 Set the maximum transmission unit to the numeric value.
324 327 .It Cm nud
325 328 Neighbor unreachability detection
326 329 .Pq Cm on Ns / Ns Cm off
327 330 .It Cm usesrc
328 331 Indicates which interface to use for source address selection. A value
329 332 .Cm none
330 333 may also be used.
331 334 .El
332 335 .It Fl t Ns , Ns Fl -temporary
333 336 Temporary, not persistent across reboots.
334 337 .El
335 338 .It Xo
336 339 .Nm
337 340 .Ic reset-ifprop
338 341 .Op Fl t
339 342 .Fl p Ar prop
340 343 .Fl m Ar protocol
341 344 .Ar interface
342 345 .Xc
343 346 Reset an IP interface's property value to the default.
344 347 .Bl -tag -width ""
345 348 .It Fl m Ns , Ns Fl -module
346 349 Specify which protocol the setting applies to.
347 350 .It Fl p Ns , Ns Fl -prop
348 351 Specify the property name. See the
349 352 .Nm ipadm Ic set-ifprop
350 353 subcommand for the list of property names.
351 354 .It Fl t Ns , Ns Fl -temporary
352 355 Temporary, not persistent across reboots.
353 356 .El
354 357 .It Xo
355 358 .Nm
356 359 .Ic show-ifprop
357 360 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar value Oc Ns ...
358 361 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
359 362 .Op Fl m Ar protocol
360 363 .Op Ar interface
361 364 .Xc
362 365 Display the property values for one or all of the IP interfaces.
363 366 .Bl -tag -width ""
364 367 .It Fl c Ns , Ns Fl -parsable
365 368 Print the output in a parsable format.
366 369 .It Fl m Ns , Ns Fl -module
367 370 Specify which protocol to display.
368 371 .It Fl o Ns , Ns Fl -output
369 372 Select which fields will be shown. The field value can be one of the following
370 373 names:
371 374 .Bl -tag -compact -width "PERSISTENT"
372 375 .It Cm ALL
373 376 Display all fields.
374 377 .It Cm IFNAME
375 378 The name of the interface.
376 379 .It Cm PROPERTY
377 380 The name of the property.
378 381 .It Cm PROTO
379 382 The name of the protocol.
380 383 .It Cm PERM
381 384 If the property is readable
382 385 .Pq Qq r
383 386 and/or writable
384 387 .Pq Qq w .
385 388 .It Cm CURRENT
386 389 The value of the property.
387 390 .It Cm PERSISTENT
388 391 The persistent value of the property.
389 392 .It Cm DEFAULT
390 393 The default value of the property.
391 394 .It Cm POSSIBLE
392 395 The possible values for the property.
393 396 .El
394 397 .It Fl p Ns , Ns Fl -prop
395 398 Specify which properties to display. See the
396 399 .Nm ipadm Ic set-ifprop
397 400 subcommand for the list of property names.
398 401 .El
399 402 .It Xo
400 403 .Nm
401 404 .Ic create-addr
402 405 .Op Fl t
403 406 .Fl T Cm static
|
↓ open down ↓ |
321 lines elided |
↑ open up ↑ |
404 407 .Op Fl d
405 408 .Fl a Oo Cm local Ns | Ns Cm remote Ns = Oc Ns
406 409 .Ar addr Ns Oo / Ns Ar prefixlen Oc Ns ...
407 410 .Ar addrobj
408 411 .br
409 412 .Nm
410 413 .Ic create-addr
411 414 .Op Fl t
412 415 .Fl T Cm dhcp
413 416 .Op Fl w Ar seconds Ns | Ns Cm forever
417 +.Op Fl 1
418 +.Op Fl h Ar hostname
414 419 .Ar addrobj
415 420 .br
416 421 .Nm
417 422 .Ic create-addr
418 423 .Op Fl t
419 424 .Fl T Cm addrconf
420 425 .Op Fl i Ar interface-id
421 426 .Oo Fl p Bro Cm stateful Ns | Ns Cm stateless Brc Ns = Ns
422 427 .Bro Cm yes Ns | Ns Cm no Brc Oc Ns ...
423 428 .Ar addrobj
424 429 .Xc
425 430 Create an address on an IP interface. The address will be enabled but can
426 431 disabled using the
427 432 .Nm ipadm Ic disable-addr
428 433 subcommand. This subcommand has three different forms, depending on the
429 434 value of the
430 435 .Fl T
431 436 option.
432 437 .Bl -tag -width ""
433 438 .It Fl T Cm static
434 439 Create a static addrobj. Note that
435 440 .Cm addrconf
436 441 address configured on an interface is required to configure
437 442 .Cm static
438 443 IPv6 address on the same interface. This takes the following options:
439 444 .Bl -tag -width ""
440 445 .It Fl a Ns , Ns Fl -address
441 446 Specify the address. The
442 447 .Cm local
443 448 or
444 449 .Cm remote
445 450 prefix can be used for a point-to-point interface. In this case, both addresses
446 451 must be given. Otherwise, the equal sign
|
↓ open down ↓ |
23 lines elided |
↑ open up ↑ |
447 452 .Pq Qq =
448 453 should be omitted and the address should be provided by itself without second
449 454 address.
450 455 .It Fl d Ns , Ns Fl -down
451 456 The address is down.
452 457 .El
453 458 .It Fl T Cm dhcp
454 459 Obtain the address via DHCP. This takes the following options:
455 460 .Bl -tag -width ""
456 461 .It Fl w Ns , Ns Fl -wait
457 -Specify the time, in seconds, that the command should wait to obtain an address.
462 +Specify the time, in seconds, that the command should wait to obtain an
463 +address; or specify
464 +.Cm forever
465 +to wait without interruption. The default value is 120.
466 +.It Fl 1 Ns , Ns Fl -primary
467 +Specify that the interface is primary. One effect will be that
468 +.Xr nodename 4
469 +will serve as
470 +.Fl h Ns , Ns Fl -reqhost
471 +if that switch is not otherwise specified.
472 +.It Fl h Ns , Ns Fl -reqhost
473 +Specify the host name to send to the DHCP server in order to request an
474 +association of a Fully Qualified Domain Name to the interface. An FQDN is
475 +determined from
476 +.Ar hostname
477 +if it is "rooted" (ending in a '.'), or if it consists of at least three
478 +DNS labels, or by appending to
479 +.Ar hostname
480 +the value configured separately using either
481 +.Xr defaultdomain 4
482 +or
483 +.Xr resolv.conf 4 .
484 +N.b. that the DHCP server implementation ultimately determines whether and
485 +how the client-sent FQDN is used.
458 486 .El
459 487 .It Fl T Cm addrconf
460 488 Create an auto-configured address. This takes the following options:
461 489 .Bl -tag -width ""
462 490 .It Fl i Ns , Ns Fl -interface-id
463 491 Specify the interface ID to be used.
464 492 .It Fl p Ns , Ns Fl -prop
465 493 Specify which method of auto-configuration should be used.
466 494 .El
467 495 .It Fl t Ns , Ns Fl -temporary
468 496 Temporary, not persistent across reboots.
469 497 .El
470 498 .It Xo
471 499 .Nm
472 500 .Ic down-addr
473 501 .Op Fl t
474 502 .Ar addrobj
475 503 .Xc
476 504 Down the address. This will stop packets from being sent or received.
477 505 .Bl -tag -width ""
478 506 .It Fl t Ns , Ns Fl -temporary
479 507 Temporary, not persistent across reboots.
480 508 .El
481 509 .It Xo
482 510 .Nm
483 511 .Ic up-addr
484 512 .Op Fl t
485 513 .Ar addrobj
486 514 .Xc
487 515 Up the address. This will enable packets to be sent and received.
488 516 .Bl -tag -width ""
489 517 .It Fl t Ns , Ns Fl -temporary
490 518 Temporary, not persistent across reboots.
491 519 .El
492 520 .It Xo
493 521 .Nm
494 522 .Ic disable-addr
495 523 .Op Fl t
496 524 .Ar addrobj
497 525 .Xc
498 526 Disable the address.
499 527 .Bl -tag -width ""
500 528 .It Fl t Ns , Ns Fl -temporary
501 529 Temporary, not persistent across reboots.
502 530 .El
503 531 .It Xo
504 532 .Nm
505 533 .Ic enable-addr
506 534 .Op Fl t
507 535 .Ar addrobj
508 536 .Xc
509 537 Enable the address.
510 538 .Bl -tag -width ""
511 539 .It Fl t Ns , Ns Fl -temporary
512 540 Temporary, not persistent across reboots.
513 541 .El
514 542 .It Xo
515 543 .Nm
516 544 .Ic refresh-addr
517 545 .Op Fl i
518 546 .Ar addrobj
519 547 .Xc
520 548 Extend the lease for
521 549 .Sy DHCP
522 550 addresses. It also restarts duplicate address
523 551 detection for
524 552 .Cm static
525 553 addresses.
526 554 .Bl -tag -width ""
527 555 .It Fl i Ns , Ns Fl -inform
528 556 Obtain network configuration from DHCP without taking a lease on the address.
529 557 .El
530 558 .It Xo
531 559 .Nm
532 560 .Ic delete-addr
533 561 .Op Fl r
534 562 .Ar addrobj
535 563 .Xc
536 564 Delete the given address.
537 565 .Bl -tag -width ""
538 566 .It Fl r Ns , Ns Fl -release
539 567 Indicate that the DHCP-assigned address should be released.
540 568 .El
541 569 .It Xo
542 570 .Nm
543 571 .Ic show-addr
544 572 .Op Oo Fl p Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
545 573 .Op Ar addrobj
546 574 .Xc
547 575 Show the current address properties.
548 576 .Bl -tag -width ""
549 577 .It Fl o Ns , Ns Fl -output
550 578 Select which fields will be shown. The field value can be one of the following
551 579 names:
552 580 .Bl -tag -compact -width "PERSISTENT"
553 581 .It Cm ALL
554 582 Display all fields.
555 583 .It Cm ADDROBJ
556 584 The name of the address.
557 585 .It Cm TYPE
558 586 The type of the address
559 587 .Pq Sy static Ns / Ns Sy dhcp Ns / Ns Sy addrconf .
560 588 .It Cm STATE
561 589 The state of the address. It can be one of the following values:
562 590 .Bl -tag -compact -width "inaccessible"
563 591 .It Sy disabled
564 592 see the
565 593 .Nm ipadm Ic disable-addr
566 594 subcommand
567 595 .It Sy down
568 596 see the
569 597 .Nm ipadm Ic down-addr
570 598 subcommand
571 599 .It Sy duplicate
572 600 the address is a duplicate
573 601 .It Sy inaccessible
574 602 the interface for this address has failed
575 603 .It Sy ok
576 604 the address is up
577 605 .It Sy tentative
578 606 duplicate address detection in progress
579 607 .El
580 608 .It Cm CURRENT
581 609 A set of single character flags indicating the following:
582 610 .Bl -tag -compact -width "U"
583 611 .It Sy U
584 612 up
585 613 .It Sy u
586 614 unnumbered
587 615 .Pq matches another local address
588 616 .It Sy p
589 617 private, not advertised to routing
590 618 .It Sy t
591 619 temporary IPv6 address
592 620 .It Sy d
593 621 deprecated
594 622 .Pq not used for outgoing packets
595 623 .El
596 624 .It Cm PERSISTENT
597 625 A set of single character flags showing the configuration which will be used
598 626 when the address is enabled.
599 627 .Bl -tag -compact -width "U"
600 628 .It Sy U
601 629 up
602 630 .It Sy p
603 631 private, not advertised to routing
604 632 .It Sy d
605 633 deprecated
606 634 .Pq not used for outgoing packets
607 635 .El
608 636 .It Cm ADDR
609 637 The address.
610 638 .El
611 639 .It Fl p Ns , Ns Fl -parsable
612 640 Print the output in a parsable format.
613 641 .El
614 642 .It Xo
615 643 .Nm
616 644 .Ic set-addrprop
617 645 .Op Fl t
618 646 .Fl p Ar prop Ns = Ns Ar value Ns Oo , Ns Ar value Oc Ns ...
619 647 .Ar addrobj
620 648 .Xc
621 649 Set a property's value(s) on the addrobj.
622 650 .Bl -tag -width ""
623 651 .It Fl p Ns , Ns Fl -prop
|
↓ open down ↓ |
156 lines elided |
↑ open up ↑ |
624 652 Specify the property name and value(s). The property name can be one of the
625 653 following:
626 654 .Bl -tag -compact -width "deprecated"
627 655 .It Cm broadcast
628 656 The broadcast address (read-only).
629 657 .It Cm deprecated
630 658 The address should not be used to send packets but can still receive packets
631 659 .Pq Cm on Ns / Ns Cm off .
632 660 .It Cm prefixlen
633 661 The number of bits in the IPv4 netmask or IPv6 prefix.
662 +.It Cm primary
663 +The DHCP primary interface flag (read-only).
634 664 .It Cm private
635 665 The address is not advertised to routing
636 666 .Pq Cm on Ns / Ns Cm off .
667 +.It Cm reqhost
668 +The host name to send to the DHCP server in order to request an association
669 +of an FQDN to the interface. For a primary DHCP interface,
670 +.Xr nodename 4
671 +is sent if this property is not defined. See the
672 +.Nm
673 +.Ic create-addr
674 +.Fl T Cm dhcp
675 +subcommand for an explanation of how an FQDN is determined.
637 676 .It Cm transmit
638 677 Packets can be transmitted
639 678 .Pq Cm on Ns / Ns Cm off .
640 679 .It Cm zone
641 -The zone the addrobj is in.
680 +The zone the addrobj is in. (temporary-only. Use
681 +.Xr zonecfg 1M
682 +to make persistent).
642 683 .El
643 684 .It Fl t Ns , Ns Fl -temporary
644 685 Temporary, not persistent across reboots.
645 686 .El
646 687 .It Xo
647 688 .Nm
648 689 .Ic reset-addrprop
649 690 .Op Fl t
650 691 .Fl p Ar prop
651 692 .Ar addrobj
652 693 .Xc
653 694 Reset an addrobj's property value to the default.
654 695 .Bl -tag -width ""
655 696 .It Fl p Ns , Ns Fl -prop
656 697 Specify the property name. See the
657 698 .Nm ipadm Ic set-addrprop
658 699 subcommand for the list of property names.
659 700 .It Fl t Ns , Ns Fl -temporary
660 701 Temporary, not persistent across reboots.
661 702 .El
662 703 .It Xo
663 704 .Nm
664 705 .Ic show-addrprop
665 706 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
666 707 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
667 708 .Op Ar addrobj
668 709 .Xc
669 710 Display the property values for one or all of the addrobjs.
670 711 .Bl -tag -width ""
671 712 .It Fl c Ns , Ns Fl -parsable
672 713 Print the output in a parsable format.
673 714 .It Fl o Ns , Ns Fl -output
674 715 Select which fields will be shown. The field value can be one of the following
675 716 names:
676 717 .Bl -tag -compact -width "PERSISTENT"
677 718 .It Cm ALL
678 719 Display all fields.
679 720 .It Cm ADDROBJ
680 721 The name of the addrobj.
681 722 .It Cm PROPERTY
682 723 The name of the property.
683 724 .It Cm PERM
684 725 If the property is readable
685 726 .Pq Qq r
686 727 and/or writable
687 728 .Pq Qq w .
688 729 .It Cm CURRENT
689 730 The value of the property.
690 731 .It Cm PERSISTENT
691 732 The persistent value of the property.
692 733 .It Cm DEFAULT
693 734 The default value of the property.
694 735 .It Cm POSSIBLE
695 736 The possible values for the property.
696 737 .El
697 738 .It Fl p Ns , Ns Fl -prop
698 739 Specify which properties to display. See the
699 740 .Nm ipadm Ic set-addrprop
700 741 subcommand for the list of property names.
701 742 .El
702 743 .It Xo
703 744 .Ic set-prop
704 745 .Op Fl t
705 746 .Fl p Ar prop Ns Oo Cm + Ns | Ns Cm - Oc Ns = Ns
706 747 .Ar value Ns Oo , Ns Ar value Oc Ns ...
707 748 .Ar protocol
708 749 .Xc
709 750 Set a property's value(s) on the protocol.
710 751 .Bl -tag -width ""
711 752 .It Fl p Ns , Ns Fl -prop
712 753 Specify the property name and value(s). The optional
713 754 .Sy + Ns | Ns Sy -
714 755 syntax can be used to add/remove values from the current list of values on the
715 756 property. The property name can be one of the following:
716 757 .Bl -tag -compact -width "smallest_nonpriv_port"
717 758 .It Cm ecn
718 759 Explicit congestion control
719 760 .Pq Cm never Ns / Ns Cm passive Ns / Ns Cm active
720 761 .Pq TCP .
721 762 .It Cm extra_priv_ports
722 763 Additional privileged ports
723 764 .Pq SCTP/TCP/UDP .
724 765 .It Cm forwarding
725 766 Packet forwarding
726 767 .Pq Cm on Ns / Ns Cm off .
727 768 .It Cm hoplimit
728 769 The IPv6 hoplimit.
729 770 .It Cm largest_anon_port
730 771 Largest ephemeral port
731 772 .Pq SCTP/TCP/UDP .
732 773 .It Cm max_buf
733 774 Maximum receive or send buffer size
734 775 .Pq ICMP/SCTP/TCP/UDP .
735 776 This also sets the upper limit for the
736 777 .Cm recv_buf
737 778 and
738 779 .Cm send_buf
739 780 properties.
740 781 .It Cm recv_buf
741 782 Default receive buffer size
742 783 .Pq ICMP/SCTP/TCP/UDP .
743 784 The maximum value for this property is controlled by the
744 785 .Cm max_buf
745 786 property.
746 787 .It Cm sack
747 788 Selective acknowledgement
748 789 .Pq Cm active Ns / Ns Cm passive Ns / Ns Cm never
749 790 .Pq TCP .
750 791 .It Cm send_buf
751 792 Default send buffer size
752 793 .Pq ICMP/SCTP/TCP/UDP .
753 794 The maximum value for this property is controlled by the
754 795 .Cm max_buf
755 796 property.
756 797 .It Cm smallest_anon_port
757 798 Smallest ephemeral port
758 799 .Pq SCTP/TCP/UDP .
759 800 .It Cm smallest_nonpriv_port
760 801 Smallest non-privileged port
761 802 .Pq SCTP/TCP/UDP .
762 803 .It Cm ttl
763 804 The IPv4 time-to-live.
764 805 .El
765 806 .It Fl t Ns , Ns Fl -temporary
766 807 Temporary, not persistent across reboots.
767 808 .El
768 809 .It Xo
769 810 .Nm
770 811 .Ic reset-prop
771 812 .Op Fl t
772 813 .Fl p Ar prop
773 814 .Ar protocol
774 815 .Xc
775 816 Reset a protocol's property value to the default.
776 817 .Bl -tag -width ""
777 818 .It Fl p Ns , Ns Fl -prop
778 819 Specify the property name. See the
779 820 .Nm ipadm Ic set-prop
780 821 subcommand for the list of property names.
781 822 .It Fl t Ns , Ns Fl -temporary
782 823 Temporary, not persistent across reboots.
783 824 .El
784 825 .It Xo
785 826 .Nm
786 827 .Ic show-prop
787 828 .Op Oo Fl c Oc Fl o Ar field Ns Oo , Ns Ar field Oc Ns ...
788 829 .Op Fl p Ar prop Ns Oo , Ns Ar prop Oc Ns ...
789 830 .Op Ar protocol
790 831 .Xc
791 832 Display the property values for one or all of the protocols.
792 833 .Bl -tag -width ""
793 834 .It Fl c Ns , Ns Fl -parsable
794 835 Print the output in a parsable format.
795 836 .It Fl o Ns , Ns Fl -output
796 837 Select which fields will be shown. The field value can be one of the following
797 838 names:
798 839 .Bl -tag -compact -width "PERSISTENT"
799 840 .It Cm ALL
800 841 Display all fields.
801 842 .It Cm PROTO
802 843 The name of the protocol.
803 844 .It Cm PROPERTY
804 845 The name of the property.
805 846 .It Cm PERM
806 847 If the property is readable
807 848 .Pq Qq r
808 849 and/or writable
809 850 .Pq Qq w .
810 851 .It Cm CURRENT
811 852 The value of the property.
812 853 .It Cm PERSISTENT
813 854 The persistent value of the property.
814 855 .It Cm DEFAULT
815 856 The default value of the property.
816 857 .It Cm POSSIBLE
817 858 The possible values for the property.
818 859 .El
819 860 .It Fl p Ns , Ns Fl -prop
820 861 Specify which properties to display. See the
821 862 .Nm ipadm Ic set-prop
822 863 subcommand for the list of property names.
|
↓ open down ↓ |
171 lines elided |
↑ open up ↑ |
823 864 .El
824 865 .El
825 866 .Sh SEE ALSO
826 867 .Xr arp 1M ,
827 868 .Xr cfgadm 1M ,
828 869 .Xr dladm 1M ,
829 870 .Xr if_mpadm 1M ,
830 871 .Xr ifconfig 1M ,
831 872 .Xr ndd 1M ,
832 873 .Xr zonecfg 1M ,
874 +.Xr defaultdomain 4 ,
875 +.Xr nodename 4 ,
833 876 .Xr nsswitch.conf 4 ,
877 +.Xr resolv.conf 4 ,
834 878 .Xr dhcp 5
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX