Print this page
10553 ipadm.1m should document hostmodel property
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1m/ipadm.1m.man.txt
+++ new/usr/src/man/man1m/ipadm.1m.man.txt
1 1 IPADM(1M) Maintenance Commands IPADM(1M)
2 2
3 3 NAME
4 4 ipadm - configure IP interfaces, addresses and protocols
5 5
6 6 SYNOPSIS
7 7 ipadm create-if [-t] interface
8 8 ipadm disable-if -t interface
9 9 ipadm enable-if -t interface
10 10 ipadm delete-if interface
11 11 ipadm show-if [[-p] -o field[,field]...] [interface]
12 12 ipadm set-ifprop [-t] -p prop=value[,value]... -m protocol interface
13 13 ipadm reset-ifprop [-t] -p prop -m protocol interface
14 14 ipadm show-ifprop [[-c] -o field[,value]...] [-p prop[,prop]...]
15 15 [-m protocol] [interface]
16 16 ipadm create-addr [-t] -T static [-d]
17 17 -a [local|remote=]addr[/prefixlen]... addrobj
18 18 ipadm create-addr [-t] -T dhcp [-1] [-h hostname] [-w {seconds|forever}]
19 19 addrobj
20 20 ipadm create-addr [-t] -T addrconf [-i interface-id]
21 21 [-p {stateful|stateless}={yes|no}]... addrobj
22 22 ipadm down-addr [-t] addrobj
23 23 ipadm up-addr [-t] addrobj
24 24 ipadm disable-addr [-t] addrobj
25 25 ipadm enable-addr [-t] addrobj
26 26 ipadm refresh-addr [-i] addrobj
27 27 ipadm delete-addr [-r] addrobj
28 28 ipadm show-addr [[-p] -o field[,field]...] [addrobj]
29 29 ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
30 30 ipadm reset-addrprop [-t] -p prop addrobj
31 31 ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
32 32 [addrobj]
33 33 ipadm set-prop [-t] -p prop[+|-]=value[,value]... protocol
34 34 ipadm reset-prop [-t] -p prop protocol
35 35 ipadm show-prop [[-c] -o field[,field]...] [-p prop[,prop]...] [protocol]
36 36
37 37 DESCRIPTION
38 38 The ipadm command is a stable replacement for the ifconfig(1M) and
39 39 ndd(1M) commands. It is used to create IP interfaces and to configure IP
40 40 addresses on those interfaces. It is also used to get, set or reset
41 41 properties on interfaces, addresses and protocols.
42 42
43 43 For subcommands that take an addrobj, the addrobj specifies a unique
44 44 address on the system. It is made up of two parts, delimited by a `/'.
45 45 The first part is the name of the interface and the second part is a
46 46 string up to 32 characters long. For example, "lo0/v4" is a loopback
47 47 interface addrobj name.
48 48
49 49 For subcommands that take a protocol, this can be one of the following
50 50 values: ip, ipv4, ipv6, icmp, tcp, sctp or udp.
51 51
52 52 SUBCOMMANDS
53 53 The following subcommands are supported:
54 54
55 55 ipadm create-if [-t] interface
56 56 Create an IP interface that will handle both IPv4 and IPv6
57 57 packets. The interface will be enabled as part of the creation
58 58 process. The IPv4 interface will have the address 0.0.0.0. The
59 59 IPv6 interface will have the address ::.
60 60
61 61 -t,--temporary
62 62 Temporary, not persistent across reboots.
63 63
64 64 ipadm disable-if -t interface
65 65 Disable the specified IP interface.
66 66
67 67 -t,--temporary
68 68 Temporary, not persistent across reboots.
69 69
70 70 ipadm enable-if -t interface
71 71 Enable the specified IP interface.
72 72
73 73 -t,--temporary
74 74 Temporary, not persistent across reboots.
75 75
76 76 ipadm delete-if interface
77 77 Permanently delete the specified IP interface.
78 78
79 79 ipadm show-if [[-p] -o field[,field]...] [interface]
80 80 Show the current IP interface configuration.
81 81
82 82 -o,--output
83 83 Select which fields will be shown. The field value can
84 84 be one of the following names:
85 85 ALL Display all fields.
86 86 IFNAME The name of the interface.
87 87 STATE The state can be one of the following values:
88 88 ok resources for the interface have
89 89 been allocated
90 90 offline the interface is offline
91 91 failed the interface's datalink is down
92 92 down the interface is down
93 93 disabled the interface is disabled
94 94 CURRENT A set of single character flags indicating
95 95 the following:
96 96 b broadcast (mutually exclusive with `p')
97 97 m multicast
98 98 p point-to-point (mutually exclusive with
99 99 `b')
100 100 v virtual interface
101 101 I IPMP
102 102 s IPMP standby
103 103 i IPMP inactive
104 104 V VRRP
105 105 a VRRP accept mode
106 106 4 IPv4
107 107 6 IPv6
108 108 PERSISTENT A set of single character flags showing what
109 109 configuration will be used the next time the
110 110 interface is enabled:
111 111 s IPMP standby
112 112 4 IPv4
113 113 6 IPv6
114 114
115 115 -p,--parsable
116 116 Print the output in a parsable format.
117 117
118 118 ipadm set-ifprop [-t] -p prop=value[,value]... -m protocol interface
119 119 Set a property's value(s) on the specified IP interface.
120 120
121 121 -m,--module
122 122 Specify which protocol the setting applies to.
123 123
124 124 -p,--prop
125 125 Specify the property name and value(s). The property
126 126 name can be one of the following:
127 127 arp Address resolution protocol (on/off).
128 128 exchange_routes Exchange of routing data (on/off).
129 129 forwarding IP Forwarding (on/off)
130 130 metric Set the routing metric to the numeric
131 131 value. The value is treated as extra
132 132 hops to the destination.
133 133 mtu Set the maximum transmission unit to the
134 134 numeric value.
135 135 nud Neighbor unreachability detection
136 136 (on/off)
137 137 usesrc Indicates which interface to use for
138 138 source address selection. A value none
139 139 may also be used.
140 140
141 141 -t,--temporary
142 142 Temporary, not persistent across reboots.
143 143
144 144 ipadm reset-ifprop [-t] -p prop -m protocol interface
145 145 Reset the specified IP interface's property value to the default.
146 146
147 147 -m,--module
148 148 Specify which protocol the setting applies to.
149 149
150 150 -p,--prop
151 151 Specify the property name. See the ipadm set-ifprop
152 152 subcommand for the list of property names.
153 153
154 154 -t,--temporary
155 155 Temporary, not persistent across reboots.
156 156
157 157 ipadm show-ifprop [[-c] -o field[,value]...] [-p prop[,prop]...] [-m
158 158 protocol] [interface]
159 159 Display the property values for one or all of the IP interfaces.
160 160
161 161 -c,--parsable
162 162 Print the output in a parsable format.
163 163
164 164 -m,--module
165 165 Specify which protocol to display.
166 166
167 167 -o,--output
168 168 Select which fields will be shown. The field value can
169 169 be one of the following names:
170 170 ALL Display all fields.
171 171 IFNAME The name of the interface.
172 172 PROPERTY The name of the property.
173 173 PROTO The name of the protocol.
174 174 PERM If the property is readable ("r") and/or
175 175 writable ("w").
176 176 CURRENT The value of the property.
177 177 PERSISTENT The persistent value of the property.
178 178 DEFAULT The default value of the property.
179 179 POSSIBLE The possible values for the property.
180 180
181 181 -p,--prop
182 182 Specify which properties to display. See the ipadm
183 183 set-ifprop subcommand for the list of property names.
184 184
185 185 ipadm create-addr [-t] -T static [-d] -a
186 186 [local|remote=]addr[/prefixlen]... addrobj
187 187 Create an address on the specified IP interface using static
188 188 configuration. The address will be enabled but can disabled
189 189 using the ipadm disable-addr subcommand. Note that addrconf
190 190 address configured on an interface is required to configure
191 191 static IPv6 address on the same interface. This takes the
192 192 following options:
193 193
194 194 -a,--address
195 195 Specify the address. The local or remote prefix can be
196 196 used for a point-to-point interface. In this case, both
197 197 addresses must be given. Otherwise, the equal sign ("=")
198 198 should be omitted and the address should be provided by
199 199 itself without second address.
200 200
201 201 -d,--down
202 202 The address is down.
203 203
204 204 -t,--temporary
205 205 Temporary, not persistent across reboots.
206 206
207 207 ipadm create-addr [-t] -T dhcp [-1] [-h hostname] [-w {seconds|forever}]
208 208 addrobj
209 209 Create an address on the specified IP interface using DHCP. This
210 210 takes the following options:
211 211
212 212 -1,--primary
213 213 Specify that the interface is primary. One effect will
214 214 be that nodename(4) will serve as -h,--reqhost if that
215 215 switch is not otherwise specified.
216 216
217 217 -h,--reqhost
218 218 Specify the host name to send to the DHCP server in order
219 219 to request an association of a Fully Qualified Domain
220 220 Name to the interface. An FQDN is determined from
221 221 hostname if it is "rooted" (ending in a '.'), or if it
222 222 consists of at least three DNS labels, or by appending to
223 223 hostname the DNS domain name value configured in
224 224 /etc/default/dhcpagent for dhcpagent(1m). N.b. that the
225 225 DHCP server implementation ultimately determines whether
226 226 and how the client-sent FQDN is used.
227 227
228 228 -t,--temporary
229 229 Temporary, not persistent across reboots.
230 230
231 231 -w,--wait
232 232 Specify the time, in seconds, that the command should
233 233 wait to obtain an address; or specify forever to wait
234 234 without interruption. The default value is 120.
235 235
236 236 ipadm create-addr [-t] -T addrconf [-i interface-id] [-p
237 237 {stateful|stateless}={yes|no}]... addrobj
238 238 Create an auto-configured address on the specified IP interface.
239 239 This takes the following options:
240 240
241 241 -i,--interface-id
242 242 Specify the interface ID to be used.
243 243
244 244 -p,--prop
245 245 Specify which method of auto-configuration should be
246 246 used.
247 247
248 248 -t,--temporary
249 249 Temporary, not persistent across reboots.
250 250
251 251 ipadm down-addr [-t] addrobj
252 252 Down the address. This will stop packets from being sent or
253 253 received.
254 254
255 255 -t,--temporary
256 256 Temporary, not persistent across reboots.
257 257
258 258 ipadm up-addr [-t] addrobj
259 259 Up the address. This will enable packets to be sent and
260 260 received.
261 261
262 262 -t,--temporary
263 263 Temporary, not persistent across reboots.
264 264
265 265 ipadm disable-addr [-t] addrobj
266 266 Disable the address.
267 267
268 268 -t,--temporary
269 269 Temporary, not persistent across reboots.
270 270
271 271 ipadm enable-addr [-t] addrobj
272 272 Enable the address.
273 273
274 274 -t,--temporary
275 275 Temporary, not persistent across reboots.
276 276
277 277 ipadm refresh-addr [-i] addrobj
278 278 Extend the lease for DHCP addresses. It also restarts duplicate
279 279 address detection for static addresses.
280 280
281 281 -i,--inform
282 282 Obtain network configuration from DHCP without taking a
283 283 lease on the address.
284 284
285 285 ipadm delete-addr [-r] addrobj
286 286 Delete the given address.
287 287
288 288 -r,--release
289 289 Indicate that the DHCP-assigned address should be
290 290 released.
291 291
292 292 ipadm show-addr [[-p] -o field[,field]...] [addrobj]
293 293 Show the current address properties.
294 294
295 295 -o,--output
296 296 Select which fields will be shown. The field value can
297 297 be one of the following names:
298 298 ALL Display all fields.
299 299 ADDROBJ The name of the address.
300 300 TYPE The type of the address
301 301 (static/dhcp/addrconf).
302 302 STATE The state of the address. It can be one of
303 303 the following values:
304 304 disabled see the ipadm disable-addr
305 305 subcommand
306 306 down see the ipadm down-addr
307 307 subcommand
308 308 duplicate the address is a duplicate
309 309 inaccessible the interface for this address
310 310 has failed
311 311 ok the address is up
312 312 tentative duplicate address detection in
313 313 progress
314 314 CURRENT A set of single character flags indicating
315 315 the following:
316 316 U up
317 317 u unnumbered (matches another local address)
318 318 p private, not advertised to routing
319 319 t temporary IPv6 address
320 320 d deprecated (not used for outgoing packets)
321 321 PERSISTENT A set of single character flags showing the
322 322 configuration which will be used when the
323 323 address is enabled.
324 324 U up
325 325 p private, not advertised to routing
326 326 d deprecated (not used for outgoing packets)
327 327 ADDR The address.
328 328
329 329 -p,--parsable
330 330 Print the output in a parsable format.
331 331
332 332 ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
333 333 Set a property's value(s) on the addrobj.
334 334
335 335 -p,--prop
336 336 Specify the property name and value(s). The property
337 337 name can be one of the following:
338 338 broadcast The broadcast address (read-only).
339 339 deprecated The address should not be used to send
340 340 packets but can still receive packets
341 341 (on/off).
342 342 prefixlen The number of bits in the IPv4 netmask or
343 343 IPv6 prefix.
344 344 primary The DHCP primary interface flag (read-only).
345 345 private The address is not advertised to routing
346 346 (on/off).
347 347 reqhost The host name to send to the DHCP server in
348 348 order to request an association of the FQDN
349 349 to the interface. For a primary DHCP
350 350 interface, nodename(4) is sent if this
351 351 property is not defined. See the ipadm
352 352 create-addr -T dhcp subcommand for the
353 353 explanation of how an FQDN is determined.
354 354 transmit Packets can be transmitted (on/off).
355 355 zone The zone the addrobj is in (temporary-
356 356 only--use zonecfg(1M) to make persistent).
357 357
358 358 -t,--temporary
359 359 Temporary, not persistent across reboots.
360 360
361 361 ipadm reset-addrprop [-t] -p prop addrobj
362 362 Reset the addrobj's property value to the default.
363 363
364 364 -p,--prop
365 365 Specify the property name. See the ipadm set-addrprop
366 366 subcommand for the list of property names.
367 367
368 368 -t,--temporary
369 369 Temporary, not persistent across reboots.
370 370
371 371 ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
372 372 [addrobj]
373 373 Display the property values for one or all of the addrobjs.
374 374
375 375 -c,--parsable
376 376 Print the output in a parsable format.
377 377
378 378 -o,--output
379 379 Select which fields will be shown. The field value can
380 380 be one of the following names:
381 381 ALL Display all fields.
382 382 ADDROBJ The name of the addrobj.
383 383 PROPERTY The name of the property.
384 384 PERM If the property is readable ("r") and/or
385 385 writable ("w").
386 386 CURRENT The value of the property.
387 387 PERSISTENT The persistent value of the property.
388 388 DEFAULT The default value of the property.
389 389 POSSIBLE The possible values for the property.
390 390
391 391 -p,--prop
392 392 Specify which properties to display. See the ipadm
393 393 set-addrprop subcommand for the list of property names.
394 394
395 395 set-prop [-t] -p prop[+|-]=value[,value]... protocol
396 396 Set a property's value(s) on the protocol.
397 397
398 398 -p,--prop
|
↓ open down ↓ |
398 lines elided |
↑ open up ↑ |
399 399 Specify the property name and value(s). The optional +|-
400 400 syntax can be used to add/remove values from the current
401 401 list of values on the property. The property name can be
402 402 one of the following:
403 403 ecn Explicit congestion control
404 404 (never/passive/active) (TCP).
405 405 extra_priv_ports Additional privileged ports
406 406 (SCTP/TCP/UDP).
407 407 forwarding Packet forwarding (on/off).
408 408 hoplimit The IPv6 hoplimit.
409 + hostmodel IP packet handling on multi-homed
410 + systems (weak/strong/src-priority)
411 + (IPv4/IPv6). weak and strong
412 + correspond to the model
413 + definitions defined in RFC 1122.
414 + src-priority is a hybrid mode
415 + where outbound packets are sent
416 + from the interface with the
417 + packet's source address if
418 + possible.
409 419 largest_anon_port Largest ephemeral port
410 420 (SCTP/TCP/UDP).
411 421 max_buf Maximum receive or send buffer
412 422 size (ICMP/SCTP/TCP/UDP). This
413 423 also sets the upper limit for the
414 424 recv_buf and send_buf properties.
415 425 recv_buf Default receive buffer size
416 426 (ICMP/SCTP/TCP/UDP). The maximum
417 427 value for this property is
418 428 controlled by the max_buf
419 429 property.
420 430 sack Selective acknowledgement
421 431 (active/passive/never) (TCP).
422 432 send_buf Default send buffer size
423 433 (ICMP/SCTP/TCP/UDP). The maximum
424 434 value for this property is
425 435 controlled by the max_buf
426 436 property.
427 437 smallest_anon_port Smallest ephemeral port
428 438 (SCTP/TCP/UDP).
429 439 smallest_nonpriv_port Smallest non-privileged port
430 440 (SCTP/TCP/UDP).
431 441 ttl The IPv4 time-to-live.
432 442
433 443 -t,--temporary
434 444 Temporary, not persistent across reboots.
435 445
436 446 ipadm reset-prop [-t] -p prop protocol
437 447 Reset a protocol's property value to the default.
438 448
439 449 -p,--prop
440 450 Specify the property name. See the ipadm set-prop
441 451 subcommand for the list of property names.
442 452
443 453 -t,--temporary
444 454 Temporary, not persistent across reboots.
445 455
446 456 ipadm show-prop [[-c] -o field[,field]...] [-p prop[,prop]...] [protocol]
447 457 Display the property values for one or all of the protocols.
448 458
449 459 -c,--parsable
450 460 Print the output in a parsable format.
451 461
452 462 -o,--output
453 463 Select which fields will be shown. The field value can
454 464 be one of the following names:
455 465 ALL Display all fields.
456 466 PROTO The name of the protocol.
457 467 PROPERTY The name of the property.
458 468 PERM If the property is readable ("r") and/or
459 469 writable ("w").
460 470 CURRENT The value of the property.
461 471 PERSISTENT The persistent value of the property.
462 472 DEFAULT The default value of the property.
463 473 POSSIBLE The possible values for the property.
464 474
465 475 -p,--prop
466 476 Specify which properties to display. See the ipadm
467 477 set-prop subcommand for the list of property names.
468 478
469 479 SEE ALSO
470 480 arp(1M), cfgadm(1M), dhcpagent(1M), dladm(1M), if_mpadm(1M),
471 481 ifconfig(1M), ndd(1M), zonecfg(1M), nodename(4), nsswitch.conf(4),
472 482 dhcp(5)
473 483
474 484 illumos February 6, 2018 illumos
|
↓ open down ↓ |
56 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX