1 IPADM(1M) Maintenance Commands IPADM(1M)
2
3 NAME
4 ipadm - configure IP interfaces, addresses and protocols
5
6 SYNOPSIS
7 ipadm create-if [-t] interface
8 ipadm disable-if -t interface
9 ipadm enable-if -t interface
10 ipadm delete-if interface
11 ipadm show-if [[-p] -o field[,field]...] [interface]
12 ipadm set-ifprop [-t] -p prop=value[,value]... -m protocol interface
13 ipadm reset-ifprop [-t] -p prop -m protocol interface
14 ipadm show-ifprop [[-c] -o field[,value]...] [-p prop[,prop]...]
15 [-m protocol] [interface]
16 ipadm create-addr [-t] -T static [-d]
17 -a [local|remote=]addr[/prefixlen]... addrobj
18 ipadm create-addr [-t] -T dhcp [-w seconds|forever] addrobj
19 ipadm create-addr [-t] -T addrconf [-i interface-id]
20 [-p {stateful|stateless}={yes|no}]... addrobj
21 ipadm down-addr [-t] addrobj
22 ipadm up-addr [-t] addrobj
23 ipadm disable-addr [-t] addrobj
24 ipadm enable-addr [-t] addrobj
25 ipadm refresh-addr [-i] addrobj
26 ipadm delete-addr [-r] addrobj
27 ipadm show-addr [[-p] -o field[,field]...] [addrobj]
28 ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
29 ipadm reset-addrprop [-t] -p prop addrobj
30 ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
31 [addrobj]
32 ipadm set-prop [-t] -p prop[+|-]=value[,value]... protocol
33 ipadm reset-prop [-t] -p prop protocol
34 ipadm show-prop [[-c] -o field[,field]...] [-p prop[,prop]...] [protocol]
35
36 DESCRIPTION
37 The ipadm command is a stable replacement for the ifconfig(1M) and
38 ndd(1M) commands. It is used to create IP interfaces and to configure IP
159
160 -o,--output
161 Select which fields will be shown. The field value can be one of the
162 following names:
163 ALL Display all fields.
164 IFNAME The name of the interface.
165 PROPERTY The name of the property.
166 PROTO The name of the protocol.
167 PERM If the property is readable ("r") and/or writable ("w").
168 CURRENT The value of the property.
169 PERSISTENT The persistent value of the property.
170 DEFAULT The default value of the property.
171 POSSIBLE The possible values for the property.
172
173 -p,--prop
174 Specify which properties to display. See the ipadm set-ifprop
175 subcommand for the list of property names.
176
177 ipadm create-addr [-t] -T static [-d] -a
178 [local|remote=]addr[/prefixlen]... addrobj
179 ipadm create-addr [-t] -T dhcp [-w seconds|forever] addrobj
180 ipadm create-addr [-t] -T addrconf [-i interface-id] [-p
181 {stateful|stateless}={yes|no}]... addrobj
182 Create an address on an IP interface. The address will be enabled but
183 can disabled using the ipadm disable-addr subcommand. This subcommand
184 has three different forms, depending on the value of the -T option.
185
186 -T static
187 Create a static addrobj. Note that addrconf address configured on an
188 interface is required to configure static IPv6 address on the same
189 interface. This takes the following options:
190
191 -a,--address
192 Specify the address. The local or remote prefix can be used for a
193 point-to-point interface. In this case, both addresses must be
194 given. Otherwise, the equal sign ("=") should be omitted and the
195 address should be provided by itself without second address.
196
197 -d,--down
198 The address is down.
199
200 -T dhcp
201 Obtain the address via DHCP. This takes the following options:
202
203 -w,--wait
204 Specify the time, in seconds, that the command should wait to
205 obtain an address.
206
207 -T addrconf
208 Create an auto-configured address. This takes the following options:
209
210 -i,--interface-id
211 Specify the interface ID to be used.
212
213 -p,--prop
214 Specify which method of auto-configuration should be used.
215
216 -t,--temporary
217 Temporary, not persistent across reboots.
218
219 ipadm down-addr [-t] addrobj
220 Down the address. This will stop packets from being sent or received.
221
222 -t,--temporary
223 Temporary, not persistent across reboots.
224
225 ipadm up-addr [-t] addrobj
226 Up the address. This will enable packets to be sent and received.
280 PERSISTENT A set of single character flags showing the configuration
281 which will be used when the address is enabled.
282 U up
283 p private, not advertised to routing
284 d deprecated (not used for outgoing packets)
285 ADDR The address.
286
287 -p,--parsable
288 Print the output in a parsable format.
289
290 ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
291 Set a property's value(s) on the addrobj.
292
293 -p,--prop
294 Specify the property name and value(s). The property name can be one
295 of the following:
296 broadcast The broadcast address (read-only).
297 deprecated The address should not be used to send packets but can
298 still receive packets (on/off).
299 prefixlen The number of bits in the IPv4 netmask or IPv6 prefix.
300 private The address is not advertised to routing (on/off).
301 transmit Packets can be transmitted (on/off).
302 zone The zone the addrobj is in.
303
304 -t,--temporary
305 Temporary, not persistent across reboots.
306
307 ipadm reset-addrprop [-t] -p prop addrobj
308 Reset an addrobj's property value to the default.
309
310 -p,--prop
311 Specify the property name. See the ipadm set-addrprop subcommand for
312 the list of property names.
313
314 -t,--temporary
315 Temporary, not persistent across reboots.
316
317 ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
318 [addrobj]
319 Display the property values for one or all of the addrobjs.
320
321 -c,--parsable
322 Print the output in a parsable format.
387 Print the output in a parsable format.
388
389 -o,--output
390 Select which fields will be shown. The field value can be one of the
391 following names:
392 ALL Display all fields.
393 PROTO The name of the protocol.
394 PROPERTY The name of the property.
395 PERM If the property is readable ("r") and/or writable ("w").
396 CURRENT The value of the property.
397 PERSISTENT The persistent value of the property.
398 DEFAULT The default value of the property.
399 POSSIBLE The possible values for the property.
400
401 -p,--prop
402 Specify which properties to display. See the ipadm set-prop
403 subcommand for the list of property names.
404
405 SEE ALSO
406 arp(1M), cfgadm(1M), dladm(1M), if_mpadm(1M), ifconfig(1M), ndd(1M),
407 zonecfg(1M), nsswitch.conf(4), dhcp(5)
408
409 illumos April 9, 2016 illumos
|
1 IPADM(1M) Maintenance Commands IPADM(1M)
2
3 NAME
4 ipadm - configure IP interfaces, addresses and protocols
5
6 SYNOPSIS
7 ipadm create-if [-t] interface
8 ipadm disable-if -t interface
9 ipadm enable-if -t interface
10 ipadm delete-if interface
11 ipadm show-if [[-p] -o field[,field]...] [interface]
12 ipadm set-ifprop [-t] -p prop=value[,value]... -m protocol interface
13 ipadm reset-ifprop [-t] -p prop -m protocol interface
14 ipadm show-ifprop [[-c] -o field[,value]...] [-p prop[,prop]...]
15 [-m protocol] [interface]
16 ipadm create-addr [-t] -T static [-d]
17 -a [local|remote=]addr[/prefixlen]... addrobj
18 ipadm create-addr [-t] -T dhcp [-w seconds|forever] [-1] [-h hostname]
19 addrobj
20 ipadm create-addr [-t] -T addrconf [-i interface-id]
21 [-p {stateful|stateless}={yes|no}]... addrobj
22 ipadm down-addr [-t] addrobj
23 ipadm up-addr [-t] addrobj
24 ipadm disable-addr [-t] addrobj
25 ipadm enable-addr [-t] addrobj
26 ipadm refresh-addr [-i] addrobj
27 ipadm delete-addr [-r] addrobj
28 ipadm show-addr [[-p] -o field[,field]...] [addrobj]
29 ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
30 ipadm reset-addrprop [-t] -p prop addrobj
31 ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
32 [addrobj]
33 ipadm set-prop [-t] -p prop[+|-]=value[,value]... protocol
34 ipadm reset-prop [-t] -p prop protocol
35 ipadm show-prop [[-c] -o field[,field]...] [-p prop[,prop]...] [protocol]
36
37 DESCRIPTION
38 The ipadm command is a stable replacement for the ifconfig(1M) and
39 ndd(1M) commands. It is used to create IP interfaces and to configure IP
160
161 -o,--output
162 Select which fields will be shown. The field value can be one of the
163 following names:
164 ALL Display all fields.
165 IFNAME The name of the interface.
166 PROPERTY The name of the property.
167 PROTO The name of the protocol.
168 PERM If the property is readable ("r") and/or writable ("w").
169 CURRENT The value of the property.
170 PERSISTENT The persistent value of the property.
171 DEFAULT The default value of the property.
172 POSSIBLE The possible values for the property.
173
174 -p,--prop
175 Specify which properties to display. See the ipadm set-ifprop
176 subcommand for the list of property names.
177
178 ipadm create-addr [-t] -T static [-d] -a
179 [local|remote=]addr[/prefixlen]... addrobj
180 ipadm create-addr [-t] -T dhcp [-w seconds|forever] [-1] [-h hostname]
181 addrobj
182 ipadm create-addr [-t] -T addrconf [-i interface-id] [-p
183 {stateful|stateless}={yes|no}]... addrobj
184 Create an address on an IP interface. The address will be enabled but
185 can disabled using the ipadm disable-addr subcommand. This subcommand
186 has three different forms, depending on the value of the -T option.
187
188 -T static
189 Create a static addrobj. Note that addrconf address configured on an
190 interface is required to configure static IPv6 address on the same
191 interface. This takes the following options:
192
193 -a,--address
194 Specify the address. The local or remote prefix can be used for a
195 point-to-point interface. In this case, both addresses must be
196 given. Otherwise, the equal sign ("=") should be omitted and the
197 address should be provided by itself without second address.
198
199 -d,--down
200 The address is down.
201
202 -T dhcp
203 Obtain the address via DHCP. This takes the following options:
204
205 -w,--wait
206 Specify the time, in seconds, that the command should wait to
207 obtain an address; or specify forever to wait without interruption.
208 The default value is 120.
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
225 -T addrconf
226 Create an auto-configured address. This takes the following options:
227
228 -i,--interface-id
229 Specify the interface ID to be used.
230
231 -p,--prop
232 Specify which method of auto-configuration should be used.
233
234 -t,--temporary
235 Temporary, not persistent across reboots.
236
237 ipadm down-addr [-t] addrobj
238 Down the address. This will stop packets from being sent or received.
239
240 -t,--temporary
241 Temporary, not persistent across reboots.
242
243 ipadm up-addr [-t] addrobj
244 Up the address. This will enable packets to be sent and received.
298 PERSISTENT A set of single character flags showing the configuration
299 which will be used when the address is enabled.
300 U up
301 p private, not advertised to routing
302 d deprecated (not used for outgoing packets)
303 ADDR The address.
304
305 -p,--parsable
306 Print the output in a parsable format.
307
308 ipadm set-addrprop [-t] -p prop=value[,value]... addrobj
309 Set a property's value(s) on the addrobj.
310
311 -p,--prop
312 Specify the property name and value(s). The property name can be one
313 of the following:
314 broadcast The broadcast address (read-only).
315 deprecated The address should not be used to send packets but can
316 still receive packets (on/off).
317 prefixlen The number of bits in the IPv4 netmask or IPv6 prefix.
318 primary The DHCP primary interface flag (read-only).
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.
326 transmit Packets can be transmitted (on/off).
327 zone The zone the addrobj is in. (temporary-only. Use
328 zonecfg(1M) to make persistent).
329
330 -t,--temporary
331 Temporary, not persistent across reboots.
332
333 ipadm reset-addrprop [-t] -p prop addrobj
334 Reset an addrobj's property value to the default.
335
336 -p,--prop
337 Specify the property name. See the ipadm set-addrprop subcommand for
338 the list of property names.
339
340 -t,--temporary
341 Temporary, not persistent across reboots.
342
343 ipadm show-addrprop [[-c] -o field[,field]...] [-p prop[,prop]...]
344 [addrobj]
345 Display the property values for one or all of the addrobjs.
346
347 -c,--parsable
348 Print the output in a parsable format.
413 Print the output in a parsable format.
414
415 -o,--output
416 Select which fields will be shown. The field value can be one of the
417 following names:
418 ALL Display all fields.
419 PROTO The name of the protocol.
420 PROPERTY The name of the property.
421 PERM If the property is readable ("r") and/or writable ("w").
422 CURRENT The value of the property.
423 PERSISTENT The persistent value of the property.
424 DEFAULT The default value of the property.
425 POSSIBLE The possible values for the property.
426
427 -p,--prop
428 Specify which properties to display. See the ipadm set-prop
429 subcommand for the list of property names.
430
431 SEE ALSO
432 arp(1M), cfgadm(1M), dladm(1M), if_mpadm(1M), ifconfig(1M), ndd(1M),
433 zonecfg(1M), defaultdomain(4), nodename(4), nsswitch.conf(4),
434 resolv.conf(4), dhcp(5)
435
436 illumos November 7, 2016 illumos
|