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