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