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