Print this page
Clearview IPMP manpages
   1 
   2 
   3 
   4 System Administration Commands                       ifconfig(1M)
   5 
   6 
   7 
   8 NAME
   9      ifconfig - configure network interface parameters
  10 
  11 SYNOPSIS
  12      ifconfig interface [address_family] [address  [/prefix_length]
  13      [dest_address]] [addif  address  [/prefix_length]]
  14      [removeif  address  [/prefix_length]] [arp |  -arp]
  15      [auth_algs authentication algorithm] [encr_algs encryption algorithm]
  16      [encr_auth_algs authentication algorithm] [auto-revarp]
  17      [broadcast  address] [deprecated |  -deprecated]
  18      [preferred |  -preferred] [destination  dest_address]
  19      [ether  [address]] [failover |  -failover] [group
  20      [name |  ""]] [index   if_index] [metric  n] [modlist]
  21      [modinsert mod_name@pos] [modremove mod_name@pos]
  22      [mtu  n] [netmask  mask] [plumb] [unplumb] [private
  23      |  -private] [nud |  -nud] [set  [address]  [/netmask]]
  24      [standby |  -standby] [subnet  subnet_address] [tdst
  25      tunnel_dest_address] [token   address/prefix_length]
  26      [tsrc  tunnel_src_address] [trailers |  -trailers]
  27      [up] [down] [usesrc [name |  none]] [xmit |  -xmit]
  28      [encaplimit n |  -encaplimit] [thoplimit n] [router
  29      |  -router] [zone zonename |  -zone |  -all-zones]
  30 
  31 
  32      ifconfig [address_family] interface {auto-dhcp |  dhcp} [primary]
  33      [wait  seconds]  drop |  extend |  inform |  ping
  34      |  release |  start |  status
  35 
  36 
  37 DESCRIPTION
  38      The command ifconfig is used to assign an address to a  net-
  39      work  interface  and  to configure network interface parame-
  40      ters. The ifconfig command must be  used  at  boot  time  to


  64 
  65 
  66 
  67 
  68 
  69 
  70 System Administration Commands                       ifconfig(1M)
  71 
  72 
  73 
  74      address  or characteristics of the interface. If the address
  75      of an interface under DHCP is changed, dhcpagent will remove
  76      the interface from its control.
  77 
  78 OPTIONS
  79      The following options are supported:
  80 
  81      addif address
  82 
  83          Create the next unused logical interface on  the  speci-
  84          fied  physical  interface.  If the physical interface is
  85          part of a multipathing group, the logical interface  can
  86          be  added  to a different physical interface in the same
  87          group.
  88 
  89 
  90      all-zones
  91 
  92          Make the interface available to every shared-IP zone  on
  93          the  system.  The  appropriate  zone to which to deliver
  94          data is determined using the  tnzonecfg  database.  This
  95          option  is  available  only  if the system is configured
  96          with the Solaris Trusted Extensions feature.
  97 
  98          The tnzonecfg database is described in the  tnzonecfg(4)
  99          man  page,  which  is part of the Solaris Trusted Exten-
 100          sions Reference Manual.
 101 
 102 
 103      anycast
 104 
 105          Marks the logical interface as  an  anycast  address  by
 106          setting  the ANYCAST flag. See "INTERFACE FLAGS," below,
 107          for more information on anycast.
 108 
 109 


 123 
 124 
 125 
 126 
 127 
 128 
 129 SunOS 5.11          Last change: 21 Jan 2007                    2
 130 
 131 
 132 
 133 
 134 
 135 
 136 System Administration Commands                       ifconfig(1M)
 137 
 138 
 139 
 140      -arp
 141 
 142          Disable the use of the ARP on a physical interface.

 143 
 144 
 145      auth_algs authentication algorithm
 146 
 147          For a tunnel, enable IPsec AH  with  the  authentication
 148          algorithm  specified.  The  algorithm  can  be  either a
 149          number or an algorithm name, including any to express no
 150          preference  in  algorithm.  All  IPsec tunnel properties
 151          must be specified on the same command line.  To  disable
 152          tunnel security, specify an auth_alg of none.
 153 
 154          It is now preferable to use  the  ipsecconf(1M)  command
 155          when  configuring  a  tunnel's  security  properties. If
 156          ipsecconf was used to set a  tunnel's  security  proper-
 157          ties, this keyword will not affect the tunnel.
 158 
 159 
 160      auto-dhcp
 161 
 162          Use DHCP to automatically acquire an  address  for  this


 462 
 463 
 464 
 465 
 466 System Administration Commands                       ifconfig(1M)
 467 
 468 
 469 
 470          encryption algorithm is not, the default value  for  the
 471          ESP encryption will be null.
 472 
 473          It is now preferable to use  the  ipsecconf(1M)  command
 474          when  configuring  a  tunnel's  security  properties. If
 475          ipsecconf was used to set a  tunnel's  security  proper-
 476          ties, this keyword will not affect the tunnel.
 477 
 478 
 479      ether [ address ]
 480 
 481          If no address is given and the user is root or has  suf-
 482          ficient  privileges  to open the underlying device, then
 483          display the current Ethernet address information.
 484 
 485          Otherwise,  if  the  user  is  root  or  has  sufficient
 486          privileges,  set  the Ethernet address of the interfaces
 487          to  address.  The  address  is   an   Ethernet   address
 488          represented  as  x:x:x:x:x:x  where  x  is a hexadecimal
 489          number between 0 and FF. Similarly, for  the  IPoIB  (IP
 490          over  InfiniBand)  interfaces,  the  address  will be 20
 491          bytes of colon-separated hex numbers between 0 and FF.
 492 
 493          Some, though not  all,  Ethernet  interface  cards  have
 494          their own addresses. To use cards that do not have their
 495          own addresses, refer to section  3.2.3(4)  of  the  IEEE
 496          802.3  specification  for  a  definition  of the locally
 497          administered address  space.  The  use  of  multipathing
 498          groups  should  be  restricted to those cards with their
 499          own addresses (see MULTIPATHING GROUPS).
 500 
 501 
 502      -failover
 503 
 504          Mark the logical interface as a non-failover  interface.
 505          Addresses  assigned  to  non-failover logical interfaces
 506          will not  failover  when  the  interface  fails.  Status
 507          display shows NOFAILOVER as part of flags.


 508 
 509 
 510      failover
 511 
 512          Mark the logical interface as a failover  interface.  An
 513          address assigned to such an interface will failover when
 514          the  interface  fails.  Status  display  does  not  show
 515          NOFAILOVER as part of flags.
 516 
 517 
 518      group [ name |""]
 519 
 520          Insert the logical interface in the  multipathing  group
 521          specified  by name. To delete an interface from a group,






 522 







 523 
 524 
 525 SunOS 5.11          Last change: 21 Jan 2007                    8
 526 
 527 
 528 
 529 
 530 
 531 
 532 System Administration Commands                       ifconfig(1M)
 533 
 534 
 535 
 536          use a null string "". When invoked on the logical inter-
 537          face  with  id  zero, the status display shows the group
 538          name.
 539 
 540 
 541      index n
 542 
 543          Change the interface index for the interface. The  value
 544          of  n  must be an interface index (if_index) that is not
 545          used on another interface. if_index will be  a  non-zero
 546          positive  number  that  uniquely  identifies the network
 547          interface on the system.
 548 
 549 









 550      metric n
 551 
 552          Set the routing metric of the  interface  to  n;  if  no
 553          value is specified, the default is 0. The routing metric
 554          is used by the routing protocol. Higher metrics have the
 555          effect  of  making  a  route less favorable. Metrics are
 556          counted as addition hops to the destination  network  or
 557          host.
 558 
 559 
 560      modinsert mod_name@pos
 561 
 562          Insert a module with name mod_name to the stream of  the
 563          device  at position pos. The position is relative to the
 564          stream head. Position  0  means  directly  under  stream
 565          head.
 566 
 567          Based upon the example in the modlist  option,  use  the
 568          following  command  to  insert  a module with name ipqos
 569          under the ip module and above the firewall module:


 722 
 723 SunOS 5.11          Last change: 21 Jan 2007                   11
 724 
 725 
 726 
 727 
 728 
 729 
 730 System Administration Commands                       ifconfig(1M)
 731 
 732 
 733 
 734      -nud
 735 
 736          Disables the neighbor unreachability detection mechanism
 737          on a point-to-point physical interface.
 738 
 739 
 740      plumb
 741 
 742          Open the device associated with the  physical  interface
 743          name  and  set  up  the streams needed for IP to use the
 744          device. When used with a logical  interface  name,  this
 745          command  is  used  to  create  a  specific named logical
 746          interface. An interface must be separately  plumbed  for
 747          use  by IPv4 and IPv6. The address_family parameter con-
 748          trols whether the ifconfig command applies  to  IPv4  or
 749          IPv6.
 750 
 751          Before an interface has been plumbed, the interface will
 752          not show up in the output of the ifconfig -a command.


 753 



 754 
 755      private
 756 
 757          Tells the in.routed routing daemon that a specified log-
 758          ical interface should not be advertised.
 759 
 760 
 761      -private
 762 
 763          Specify unadvertised interfaces.
 764 
 765 
 766      removeif address
 767 
 768          Remove the logical interface on the  physical  interface
 769          specified  that  matches the address specified. When the
 770          interface is part of a multipathing group,  the  logical
 771          interface will be removed from the physical interface in
 772          the group that holds the address.
 773 
 774 
 775      router
 776 
 777          Enable IP forwarding on the interface. When enabled, the
 778          interface  is  marked ROUTER, and IP packets can be for-
 779          warded to and from the interface.


 780 
 781 
 782      -router
 783 
 784          Disable IP forwarding on the interface. IP  packets  are
 785          not forwarded to and from the interface.


 786 
 787 
 788 
 789 SunOS 5.11          Last change: 21 Jan 2007                   12
 790 
 791 
 792 
 793 
 794 
 795 
 796 System Administration Commands                       ifconfig(1M)
 797 
 798 
 799 
 800      set
 801 
 802          Set the address, prefix_length or both,  for  a  logical
 803          interface.
 804 
 805 
 806      standby
 807 
 808          Marks the physical interface as a standby interface.  If
 809          the  interface is marked STANDBY and is part of the mul-
 810          tipathing group, the interface will not be  selected  to
 811          send  out  packets  unless  some  other interface in the
 812          group has failed and the network access has been  failed
 813          over to this standby interface.


 814 
 815          The status display shows "STANDBY, INACTIVE"  indicating
 816          that  that  the interface is a standby and is also inac-
 817          tive. IFF_INACTIVE  will  be  cleared  when  some  other
 818          interface belonging to the same multipathing group fails
 819          over to this interface.  Once a  failback  happens,  the
 820          status display will return to INACTIVE.
 821 
 822 
 823      -standby
 824 
 825          Turns off standby on this interface.
 826 
 827 
 828      subnet
 829 
 830          Set the subnet address for an interface.
 831 
 832 
 833      tdst tunnel_dest_address
 834 
 835          Set the destination address of  a  tunnel.  The  address
 836          should  not  be the same as the dest_address of the tun-
 837          nel, because no packets leave the  system  over  such  a
 838          tunnel.
 839 
 840 
 841      thoplimit n
 842 
 843          Set the hop limit for a tunnel interface. The hop  limit
 844          value  is  used  as  the  TTL in the IPv4 header for the
 845          IPv6-in-IPv4 and IPv4-in-IPv4 tunnels. For  IPv6-in-IPv6


 877          of IPv4 packets on certain link levels. Drivers supplied
 878          with this release no longer use this flag.  It  is  pro-
 879          vided for compatibility, but is ignored.
 880 
 881 
 882      -trailers
 883 
 884          Disable the use of a "trailer" link level encapsulation.
 885 
 886 
 887      tsrc tunnel_src_address
 888 
 889          Set the source address of a tunnel. This is  the  source
 890          address  on an outer encapsulating IP header. It must be
 891          an address of another interface already configured using
 892          ifconfig.
 893 
 894 
 895      unplumb
 896 
 897          Close the device associated with this physical interface
 898          name  and any streams that ifconfig set up for IP to use
 899          the device. When used with a logical interface name, the
 900          logical interface is removed from the system. After this
 901          command is executed, the  device  name  will  no  longer
 902          appear in the output of ifconfig -a.
 903 




 904 

 905      up
 906 
 907          Mark a logical interface "up".  This  happens  automati-
 908          cally  when  assigning  the  first  address to a logical
 909          interface. The up option enables an interface  after  an
 910          ifconfig down, which reinitializes the hardware.


 911 
 912 
 913      usesrc [ name | none ]
 914 
 915          Specify a physical  interface  to  be  used  for  source
 916          address selection. If the keyword none is used, then any
 917          previous selection is cleared.
 918 
 919 
 920 
 921 SunOS 5.11          Last change: 21 Jan 2007                   14
 922 
 923 
 924 
 925 
 926 
 927 
 928 System Administration Commands                       ifconfig(1M)
 929 
 930 


 956          loopback),  be  aware that you can also specify the vir-
 957          tual IP interface (see vni(7D)). The virtual  IP  inter-
 958          face is not associated with any physical hardware and is
 959          thus immune to hardware failures. You  can  specify  any
 960          number  of physical interfaces to use the source address
 961          hosted on a single virtual  interface.  This  simplifies
 962          the  configuration of routing-based multipathing. If one
 963          of the physical interfaces were to  fail,  communication
 964          would continue through one of the remaining, functioning
 965          physical interfaces.  This  scenario  assumes  that  the
 966          reachability of the address hosted on the virtual inter-
 967          face is advertised in some manner, for example,  through
 968          a routing protocol.
 969 
 970          Because the ifconfig preferred option is applied to  all
 971          interfaces,   it  is  coarser-grained  than  the  usesrc
 972          option. It will  be  overridden  by  usesrc  and  setsrc
 973          (route subcommand), in that order.
 974 
 975          The use of the usesrc option is  mutually  exclusive  of
 976          the IP multipathing ifconfig options, group and standby.
 977          That is, if an interface is already part of  a  IP  mul-
 978          tipathing  group  or  specified  as a standby interface,
 979          then it cannot be specified with a  usesrc  option,  and
 980          vice-versa.  For  more  details  on IP multipathing, see
 981          in.mpathd(1M) and the .
 982 
 983 
 984 
 985 
 986 
 987 SunOS 5.11          Last change: 21 Jan 2007                   15
 988 
 989 
 990 
 991 
 992 
 993 
 994 System Administration Commands                       ifconfig(1M)
 995 
 996 
 997 
 998      xmit
 999 
1000          Enable a logical interface to transmit packets. This  is
1001          the default behavior when the logical interface is up.
1002 
1003 
1004      -xmit
1005 
1006          Disable transmission of packets  on  an  interface.  The


1221 
1222          Indicates an anycast address. An anycast address identi-
1223          fies  the nearest member of a group of systems that pro-
1224          vides a particular type of service. An  anycast  address
1225          is assigned to a group of systems. Packets are delivered
1226          to the nearest group member identified  by  the  anycast
1227          address instead of being delivered to all members of the
1228          group.
1229 
1230 
1231      BROADCAST
1232 
1233          This broadcast address is valid. This flag and  POINTTO-
1234          POINT are mutually exclusive
1235 
1236 
1237      CoS
1238 
1239          This interface supports some form of  Class  of  Service
1240          (CoS)  marking.  An  example is the 802.1D user priority
1241          marking supported on VLAN interfaces.


1242 
1243 
1244      DEPRECATED
1245 
1246          This address is deprecated. This  address  will  not  be
1247          used  as  a  source  address for outbound packets unless
1248 
1249 
1250 
1251 SunOS 5.11          Last change: 21 Jan 2007                   19
1252 
1253 
1254 
1255 
1256 
1257 
1258 System Administration Commands                       ifconfig(1M)
1259 
1260 
1261 
1262          there are no other addresses on  this  interface  or  an
1263          application  has  explicitly  bound  to this address. An
1264          IPv6 deprecated address will eventually be deleted  when
1265          not  used,  whereas  an IPv4 deprecated address is often
1266          used with IP network multipathing IPv4  test  addresses,
1267          which  are  determined  by the setting of the NOFAILOVER
1268          flag. Further, the DEPRECATED flag is part of the  stan-
1269          dard mechanism for renumbering in IPv6.
1270 

1271 
1272      DHCP
1273 
1274          DHCP is used to manage this address.
1275 
1276 
1277      DUPLICATE
1278 
1279          The logical interface has been disabled because  the  IP
1280          address configured on the interface is a duplicate. Some
1281          other node on the network is using this address. If  the
1282          address was configured by DHCP or is temporary, the sys-
1283          tem will choose another automatically, if possible. Oth-
1284          erwise,  the system will attempt to recover this address
1285          periodically and the interface  will  recover  when  the
1286          conflict has been removed from the network. Changing the
1287          address or netmask, or setting the logical interface  to
1288          up  will restart duplicate detection. Setting the inter-
1289          face to down terminates recovery and removes the  DUPLI-
1290          CATE flag.
1291 
1292 
1293      FAILED
1294 
1295          The  interface  has  failed.  New  addresses  cannot  be
1296          created  on this interface. If this interface is part of
1297          an IP network multipathing group, a failover will  occur
1298          to another interface in the group, if possible




1299 
1300 
1301      FIXEDMTU
1302 
1303          The MTU has been set using the -mtu option. This flag is
1304          read-only.  Interfaces  that  have  this flag set have a
1305          fixed MTU  value  that  is  unaffected  by  dynamic  MTU
1306          changes  that  can  occur when drivers notify IP of link
1307          MTU changes.
1308 
1309 
1310      INACTIVE
1311 
1312          Indicates that the interface is not currently being used
1313          for  regular traffic by the system. New addresses cannot





1314 
1315 

1316 
1317 SunOS 5.11          Last change: 21 Jan 2007                   20
1318 
1319 
1320 
1321 
1322 
1323 
1324 System Administration Commands                       ifconfig(1M)
1325 
1326 
1327 
1328          be created on this interface. The flag is set  automati-
1329          cally on standby interfaces. It can also be set when the
1330          system detects that a failed interface has been repaired
1331          and  FAILBACK=no  is  configured in /etc/default/mpathd.
1332          The flag is cleared when the interface fails or  when  a
1333          failover to that interface occurs.
1334 
1335 
1336      LOOPBACK
1337 
1338          Indicates that this is the loopback interface.
1339 
1340 
1341      MIP
1342 
1343          Indicates that mobile IP controls this interface.
1344 
1345 
1346      MULTI_BCAST
1347 
1348          Indicates that the broadcast address is used for  multi-
1349          cast on this interface.
1350 
1351 
1352      MULTICAST
1353 
1354          The interface supports multicast. IP  assumes  that  any
1355          interface that supports hardware broadcast, or that is a
1356          point-to-point link, will support multicast.
1357 
1358 
1359      NOARP
1360 
1361          There is no address resolution protocol (ARP)  for  this
1362          interface  that corresponds to all interfaces for a dev-
1363          ice without a broadcast address. This flag  is  specific
1364          to IPv4.
1365 
1366 
1367      NOFAILOVER
1368 
1369          This address will not failover if the  interface  fails.
1370          IP  network  multipathing  test addresses must be marked
1371          nofailover.
1372 
1373 
1374      NOLOCAL
1375 
1376          The interface has no address , just an on-link subnet.
1377 
1378 
1379 
1380 
1381 
1382 
1383 SunOS 5.11          Last change: 21 Jan 2007                   21
1384 
1385 
1386 
1387 
1388 
1389 
1390 System Administration Commands                       ifconfig(1M)
1391 


1402 
1403 
1404      NORTEXCH
1405 
1406          The interface does not exchange routing information. For
1407          RIP-2, routing packets are not sent over this interface.
1408          Additionally, messages that appear  to  come  over  this
1409          interface  receive no response. The subnet or address of
1410          this interface is not included  in  advertisements  over
1411          other interfaces to other routers.
1412 
1413 
1414      NOXMIT
1415 
1416          Indicates that the address does  not  transmit  packets.
1417          RIP-2 also does not advertise this address.
1418 
1419 
1420      OFFLINE
1421 
1422          Indicates that the  interface  has  been  offlined.  New
1423          addresses  cannot  be  created on this interface. Inter-
1424          faces in an IP network multipathing group  are  offlined
1425          prior  to removal and replacement using dynamic reconfi-
1426          guration.
1427 
1428 
1429      POINTOPOINT
1430 
1431          Indicates that the address  is  a  point-to-point  link.
1432          This flag and BROADCAST are mutually exclusive
1433 
1434 
1435      PREFERRED
1436 
1437          This address is a preferred IPv6  source  address.  This
1438          address  will  be used as a source address for IPv6 com-
1439          munication with all IPv6  destinations,  unless  another
1440          address  on the system is of more appropriate scope. The
1441          DEPRECATED flag  takes  precedence  over  the  PREFERRED
1442          flag.
1443 
1444 
1445 
1446 


1456 System Administration Commands                       ifconfig(1M)
1457 
1458 
1459 
1460      PRIVATE
1461 
1462          Indicates that this address is not advertised. For  RIP-
1463          2,  this  interface is used to send advertisements. How-
1464          ever, neither the subnet nor this address  are  included
1465          in advertisements to other routers.
1466 
1467 
1468      ROUTER
1469 
1470          Indicates that IP packets can be forwarded to  and  from
1471          the interface.
1472 
1473 
1474      RUNNING
1475 
1476          Indicates that the required resources for  an  interface
1477          are  allocated.  For some interfaces this also indicates
1478          that the link is up.


1479 
1480 
1481      STANDBY
1482 
1483          Indicates that this is a standby interface to be used on
1484          failures.  Only interfaces in an IP network multipathing
1485          group should be designated  as  standby  interfaces.  If
1486          this  interface  is  part  of  a IP network multipathing
1487          group, the interface will not be selected  to  send  out
1488          packets  unless  some other interface in the group fails
1489          over to it.
1490 
1491 
1492      TEMPORARY
1493 
1494          Indicates that this  is  a  temporary  IPv6  address  as
1495          defined in RFC 3041.
1496 
1497 
1498      UNNUMBERED
1499 
1500          This flag is set when the local IP address on  the  link
1501          matches the local address of some other link in the sys-
1502          tem
1503 
1504 
1505      UP
1506 
1507          Indicates that the interface is up,  that  is,  all  the
1508          routing  entries  and  the  like for this interface have
1509          been set up.




1510 
1511 
1512 
1513 
1514 
1515 SunOS 5.11          Last change: 21 Jan 2007                   23
1516 
1517 
1518 
1519 
1520 
1521 
1522 System Administration Commands                       ifconfig(1M)
1523 
1524 
1525 
1526      VIRTUAL
1527 
1528          Indicates that the physical interface has no  underlying
1529          hardware.  It  is  not  possible  to transmit or receive
1530          packets through a virtual  interface.  These  interfaces
1531          are  useful  for configuring local addresses that can be
1532          used on  multiple  interfaces.  (See  also  the  -usesrc
1533          option.)
1534 
1535 
1536      XRESOLV
1537 
1538          Indicates that  the  interface  uses  an  IPv6  external
1539          resolver.
1540 
1541 
1542 LOGICAL INTERFACES
1543      Solaris TCP/IP allows  multiple  logical  interfaces  to  be
1544      associated  with a physical network interface. This allows a
1545      single machine to be assigned multiple  IP  addresses,  even
1546      though it may have only one network interface. Physical net-
1547      work  interfaces  have  names  of   the   form   driver-name
1548      physical-unit-number, while logical interfaces have names of
1549      the  form   driver-name   physical-unit-number:logical-unit-
1550      number.  A  physical interface is configured into the system
1551      using the plumb command. For example:
1552 


1583 
1584 
1585 
1586 
1587 
1588 System Administration Commands                       ifconfig(1M)
1589 
1590 
1591 
1592      A logical interface can  be  configured  with  parameters  (
1593      address,prefix_length,  and so on) different from the physi-
1594      cal interface with which it is  associated.  Logical  inter-
1595      faces  that  are associated with the same physical interface
1596      can be given different  parameters  as  well.  Each  logical
1597      interface  must be associated with an existing and "up" phy-
1598      sical interface. So,  for  example,  the  logical  interface
1599      eri0:1  can  only be configured after the physical interface
1600      eri0 has been plumbed.
1601 
1602 
1603      To delete a logical interface, use the -unplumb or -removeif
1604      options. For example,
1605 
1606        example% ifconfig eri0:1 down unplumb
1607 

1608 

1609 










1610 
1611      will delete the logical interface eri0:1.









1612 
1613 MULTIPATHING GROUPS
1614      Physical interfaces that share the same IP broadcast  domain
1615      can  be  collected into a multipathing group using the group
1616      keyword. Interfaces assigned to the same multipathing  group
1617      are  treated  as  equivalent  and outgoing traffic is spread
1618      across the interfaces  on  a  per-IP-destination  basis.  In
1619      addition,  individual interfaces in a multipathing group are
1620      monitored for failures; the addresses associated with failed
1621      interfaces  are automatically transferred to other function-
1622      ing interfaces within the group.
1623 








1624 
1625      For more details on IP multipathing, see  in.mpathd(1M)  and
1626      the . See netstat(1M) for per-IP-destination information.

1627 

























1628 CONFIGURING IPV6 INTERFACES
1629      When an IPv6 physical interface is  plumbed  and  configured
1630      "up"  with  ifconfig,  it  is automatically assigned an IPv6
1631      link-local address for which the last 64 bits are calculated
1632      from the MAC address of the interface.
1633 
1634        example% ifconfig eri0 inet6 plumb up
1635 
1636 
1637 
1638 
1639      The following example shows that the link-local address  has
1640      a prefix of fe80::/10.
1641 
1642        example% ifconfig eri0 inet6
1643        ce0: flags=2000841<UP,RUNNING,MULTICAST,IPv6>
1644 
1645 
1646 
1647 SunOS 5.11          Last change: 21 Jan 2007                   25


2080         inet 1.2.3.4 netmask ffffff00 broadcast 1.2.3.255
2081         ether 0:3:ba:17:4b:e1
2082        vni0: flags=20011100c1<UP,RUNNING,NOARP,NOXMIT,ROUTER,IPv4,VIRTUAL>
2083         mtu 0 index 5
2084         srcof qfe2
2085         inet 3.4.5.6 netmask ffffffff
2086 
2087 
2088 
2089      Observe, above, the usesrc and srcof keywords in the  ifcon-
2090      fig  output.  These  keywords  also  appear  on  the logical
2091      instances of the physical interface, even though this  is  a
2092      per-physical  interface parameter. There is no srcof keyword
2093      in ifconfig for configuring interfaces. This information  is
2094      determined  automatically  from  the  set of interfaces that
2095      have usesrc set on them.
2096 
2097 
2098 
2099      The following command, using the none  keyword,  undoes  the
2100      effect of the preceding ifconfig usersrc command.
2101 
2102 
2103        example% ifconfig qfe2 usesrc none
2104 
2105 
2106 
2107 
2108 
2109 SunOS 5.11          Last change: 21 Jan 2007                   32
2110 
2111 
2112 
2113 
2114 
2115 
2116 System Administration Commands                       ifconfig(1M)
2117 
2118 
2119 
2120      Following this command, ifconfig -a output displays as  fol-


2312 
2313 
2314 System Administration Commands                       ifconfig(1M)
2315 
2316 
2317 
2318      _______________________________________________________________________
2319     |             ATTRIBUTE TYPE            |        ATTRIBUTE VALUE       |
2320     |_______________________________________|______________________________|
2321     | Availability                          |  SUNWcsu                     |
2322     |_______________________________________|______________________________|
2323     | Interface Stability  for  command-line|  Committed                   |
2324     | options                               |                              |
2325     |_______________________________________|______________________________|
2326     | Interface Stability for command output|  Uncommitted                 |
2327     |_______________________________________|______________________________|
2328 
2329 
2330 SEE ALSO
2331      dhcpinfo(1),  dhcpagent(1M),   in.mpathd(1M),   in.ndpd(1M),
2332      in.routed(1M),    ipsecconf(1M),    ndd(1M),    netstat(1M),
2333      zoneadm(1M),          zonecfg(1M),          ethers(3SOCKET),
2334      gethostbyname(3NSL),     getnetbyname(3SOCKET),    hosts(4),
2335      inet_type(4),   ndpd.conf(4),   netmasks(4),    networks(4),
2336      nsswitch.conf(4),  attributes(5),  privileges(5),  zones(5),
2337      arp(7P), ipsecah(7P), ipsecesp(7P), tun(7M)
2338 
2339 
2340 DIAGNOSTICS
2341      ifconfig sends messages that indicate if:
2342 
2343          o    the specified interface does not exist
2344 
2345          o    the requested address is unknown
2346 
2347          o    the user is not privileged and tried  to  alter  an
2348               interface's configuration
2349 
2350 NOTES
2351      Do not select the names broadcast, down, private,  trailers,
2352      up  or  other  possible  option  names  when you choose host





   1 System Administration Commands                       ifconfig(1M)
   2 
   3 
   4 
   5 NAME
   6      ifconfig - configure network interface parameters
   7 
   8 SYNOPSIS
   9      ifconfig interface [address_family] [address  [/prefix_length]
  10      [dest_address]] [addif  address  [/prefix_length]]
  11      [removeif  address  [/prefix_length]] [arp |  -arp]
  12      [auth_algs authentication algorithm] [encr_algs encryption algorithm]
  13      [encr_auth_algs authentication algorithm] [auto-revarp]
  14      [broadcast  address] [deprecated |  -deprecated]
  15      [preferred |  -preferred] [destination  dest_address]
  16      [ether  [address]] [failover |  -failover] [group
  17      [name |  ""]] [index if_index] [ipmp] [metric  n] [modlist]
  18      [modinsert mod_name@pos] [modremove mod_name@pos]
  19      [mtu  n] [netmask  mask] [plumb] [unplumb] [private
  20      |  -private] [nud |  -nud] [set  [address]  [/netmask]]
  21      [standby |  -standby] [subnet  subnet_address] [tdst
  22      tunnel_dest_address] [token   address/prefix_length]
  23      [tsrc  tunnel_src_address] [trailers |  -trailers]
  24      [up] [down] [usesrc [name |  none]] [xmit |  -xmit]
  25      [encaplimit n |  -encaplimit] [thoplimit n] [router
  26      |  -router] [zone zonename |  -zone |  -all-zones]
  27 
  28 
  29      ifconfig [address_family] interface {auto-dhcp |  dhcp} [primary]
  30      [wait  seconds]  drop |  extend |  inform |  ping
  31      |  release |  start |  status
  32 
  33 
  34 DESCRIPTION
  35      The command ifconfig is used to assign an address to a  net-
  36      work  interface  and  to configure network interface parame-
  37      ters. The ifconfig command must be  used  at  boot  time  to


  61 
  62 
  63 
  64 
  65 
  66 
  67 System Administration Commands                       ifconfig(1M)
  68 
  69 
  70 
  71      address  or characteristics of the interface. If the address
  72      of an interface under DHCP is changed, dhcpagent will remove
  73      the interface from its control.
  74 
  75 OPTIONS
  76      The following options are supported:
  77 
  78      addif address
  79 
  80          Create the next unused logical interface on  the  speci-
  81          fied  physical  interface.



  82 

  83      all-zones
  84 
  85          Make the interface available to every shared-IP zone  on
  86          the  system.  The  appropriate  zone to which to deliver
  87          data is determined using the  tnzonecfg  database.  This
  88          option  is  available  only  if the system is configured
  89          with the Solaris Trusted Extensions feature.
  90 
  91          The tnzonecfg database is described in the  tnzonecfg(4)
  92          man  page,  which  is part of the Solaris Trusted Exten-
  93          sions Reference Manual.
  94 
  95 
  96      anycast
  97 
  98          Marks the logical interface as  an  anycast  address  by
  99          setting  the ANYCAST flag. See "INTERFACE FLAGS," below,
 100          for more information on anycast.
 101 
 102 


 116 
 117 
 118 
 119 
 120 
 121 
 122 SunOS 5.11          Last change: 21 Jan 2007                    2
 123 
 124 
 125 
 126 
 127 
 128 
 129 System Administration Commands                       ifconfig(1M)
 130 
 131 
 132 
 133      -arp
 134 
 135          Disable the use of the ARP on a physical interface.
 136          ARP cannot be disabled on an IPMP IP interface.
 137 
 138 
 139      auth_algs authentication algorithm
 140 
 141          For a tunnel, enable IPsec AH  with  the  authentication
 142          algorithm  specified.  The  algorithm  can  be  either a
 143          number or an algorithm name, including any to express no
 144          preference  in  algorithm.  All  IPsec tunnel properties
 145          must be specified on the same command line.  To  disable
 146          tunnel security, specify an auth_alg of none.
 147 
 148          It is now preferable to use  the  ipsecconf(1M)  command
 149          when  configuring  a  tunnel's  security  properties. If
 150          ipsecconf was used to set a  tunnel's  security  proper-
 151          ties, this keyword will not affect the tunnel.
 152 
 153 
 154      auto-dhcp
 155 
 156          Use DHCP to automatically acquire an  address  for  this


 456 
 457 
 458 
 459 
 460 System Administration Commands                       ifconfig(1M)
 461 
 462 
 463 
 464          encryption algorithm is not, the default value  for  the
 465          ESP encryption will be null.
 466 
 467          It is now preferable to use  the  ipsecconf(1M)  command
 468          when  configuring  a  tunnel's  security  properties. If
 469          ipsecconf was used to set a  tunnel's  security  proper-
 470          ties, this keyword will not affect the tunnel.
 471 
 472 
 473      ether [ address ]
 474 
 475          If no address is given and the user is root or has  suf-
 476          ficient privileges to open the underlying datalink, then
 477          display the current Ethernet address information.
 478 
 479          Otherwise,  if  the  user  is  root  or  has  sufficient
 480          privileges,  set  the Ethernet address of the interfaces
 481          to  address.  The  address  is   an   Ethernet   address
 482          represented  as  x:x:x:x:x:x  where  x  is a hexadecimal
 483          number between 0 and FF. Similarly, for  the  IPoIB  (IP
 484          over  InfiniBand)  interfaces,  the  address  will be 20
 485          bytes of colon-separated hex numbers between 0 and FF.
 486 
 487          Some,   though not  all,  Ethernet  interface cards have
 488          their own addresses. To use cards that do not have their
 489          own  addresses, refer  to  section 3.2.3(4) of the  IEEE
 490          802.3  specification  for  a  definition  of the locally
 491          administered address space.  Note that all IP interfaces
 492          in an  IPMP  group must have unique  hardware addresses;
 493          see *in.mpathd(1M)*.
 494 
 495 
 496      -failover
 497 
 498          Set *NOFAILOVER*  on the logical interface.   This makes
 499          the associated address available for use  by *in.mpathd*
 500          to  perform    probe-based failure   detection  for  the
 501          associated  physical IP  interface.   As  a side effect,
 502          *DEPRECATED* will also be  set on the logical interface.
 503          This operation is not permitted on an IPMP IP interface.
 504 
 505 
 506      failover
 507 
 508          Clear *NOFAILOVER*  on  the logical interface.  This  is
 509          the default.   These  logical interfaces  are subject to
 510          migration when brought up (see IP MULTIPATHING GROUPS).

 511 
 512 
 513      group [ name | "" ]
 514 
 515          When  applied  to a  physical interface,  it  places the
 516          interface  into the named  group.  If the group does not
 517          exist, it will be  created, along with  one or more IPMP
 518          IP interfaces   (for  IPv4, IPv6,  or both).    Any *UP*
 519          addresses that are   not also  marked *NOFAILOVER*   are
 520          subject to  migration to the  IPMP  IP interface (see IP
 521          MULTIPATHING GROUPS).   Specifying a group  name of *""*
 522          removes the physical IP interface from the group.
 523 
 524          When applied to a physical IPMP IP interface, it renames
 525          the   IPMP group  to have  the  new name.   If  the name
 526          already   exists,  or a name   of  *""* is specified, it
 527          fails.  Renaming  IPMP  groups is discouraged.  Instead,
 528          the IPMP IP interface should  be given a meaningful name
 529          when it is created via the  *ipmp* subcommand, which the
 530          system will also use as the IPMP group name.
 531 
 532 
















 533      index n
 534 
 535          Change the interface index for the interface. The  value
 536          of  n  must be an interface index (if_index) that is not
 537          used on another interface. if_index will be  a  non-zero
 538          positive  number  that  uniquely  identifies the network
 539          interface on the system.
 540 
 541 
 542      ipmp
 543 
 544          Create an IPMP IP interface with the specified name.  An
 545          interface must be separately created for use by IPv4 and
 546          IPv6.  The  *address_family* parameter  controls whether
 547          the   command  applies  to   IPv4   or  IPv6  (IPv4   if
 548          unspecified).  All  IPMP IP  interfaces have  the *IPMP*
 549          flag set.
 550 
 551      metric n
 552 
 553          Set the routing metric of the  interface  to  n;  if  no
 554          value is specified, the default is 0. The routing metric
 555          is used by the routing protocol. Higher metrics have the
 556          effect  of  making  a  route less favorable. Metrics are
 557          counted as addition hops to the destination  network  or
 558          host.
 559 
 560 
 561      modinsert mod_name@pos
 562 
 563          Insert a module with name mod_name to the stream of  the
 564          device  at position pos. The position is relative to the
 565          stream head. Position  0  means  directly  under  stream
 566          head.
 567 
 568          Based upon the example in the modlist  option,  use  the
 569          following  command  to  insert  a module with name ipqos
 570          under the ip module and above the firewall module:


 723 
 724 SunOS 5.11          Last change: 21 Jan 2007                   11
 725 
 726 
 727 
 728 
 729 
 730 
 731 System Administration Commands                       ifconfig(1M)
 732 
 733 
 734 
 735      -nud
 736 
 737          Disables the neighbor unreachability detection mechanism
 738          on a point-to-point physical interface.
 739 
 740 
 741      plumb
 742 
 743          For   a  physical   IP    interface, open the   datalink
 744          associated with the physical  interface name and  set up
 745          the plumbing needed for IP   to use the datalink.   When
 746          used with a logical interface name, this command is used
 747          to create  a specific   named  logical interface  on  an
 748          existing physical IP interface.


 749 
 750          An interface  must be  separately plumbed for   IPv4 and
 751          IPv6 according  to the *address_family*  parameter (IPv4
 752          if unspecified).  Before  an interface has been plumbed,
 753          it will not be shown by *ifconfig -a*.
 754 
 755          Note that IPMP IP interfaces are not  tied to a specific
 756          datalink    and  are instead  created   with  the *ipmp*
 757          subcommand.
 758 
 759      private
 760 
 761          Tells the in.routed routing daemon that a specified log-
 762          ical interface should not be advertised.
 763 
 764 
 765      -private
 766 
 767          Specify unadvertised interfaces.
 768 
 769 
 770      removeif address
 771 
 772          Remove the logical interface on the  physical  interface
 773          specified  that  matches the address specified.



 774 

 775      router
 776 
 777          Enable IP forwarding on the interface. When enabled, the
 778          interface is marked *ROUTER*, and IP packets can be for-
 779          warded to and from the  interface.  Enabling *ROUTER* on
 780          any IP  interface in an IPMP group  applies the  flag to
 781          all IP interfaces in that IPMP group.
 782 
 783 
 784      -router
 785 
 786          Disable IP forwarding on  the interface. IP packets  are
 787          not  forwarded to  and  from the  interface.   Disabling
 788          *ROUTER* on  any IP interface  in an IPMP group disables
 789          it on all IP interfaces in that IPMP group.
 790 
 791 
 792 
 793 SunOS 5.11          Last change: 21 Jan 2007                   12
 794 
 795 
 796 
 797 
 798 
 799 
 800 System Administration Commands                       ifconfig(1M)
 801 
 802 
 803 
 804      set
 805 
 806          Set the address, prefix_length or both,  for  a  logical
 807          interface.
 808 
 809 
 810      standby
 811 
 812          Mark the physical IP interface as a *STANDBY* interface.
 813          If an interface  is marked *STANDBY* and  is part of  an
 814          IPMP  group, the interface   will  not be used for  data
 815          traffic unless   another  interface  in the  IPMP  group
 816          becomes    unusable.   When  a   *STANDBY*  interface is
 817          functional but not being  used for data traffic, it will
 818          also be marked   *INACTIVE*.   This  operation   is  not
 819          permitted on an IPMP IP interface.
 820 






 821 

 822      -standby
 823 
 824          Clear *STANDBY* on this interface.  This is the default.
 825 
 826 
 827      subnet
 828 
 829          Set the subnet address for an interface.
 830 
 831 
 832      tdst tunnel_dest_address
 833 
 834          Set the destination address of  a  tunnel.  The  address
 835          should  not  be the same as the dest_address of the tun-
 836          nel, because no packets leave the  system  over  such  a
 837          tunnel.
 838 
 839 
 840      thoplimit n
 841 
 842          Set the hop limit for a tunnel interface. The hop  limit
 843          value  is  used  as  the  TTL in the IPv4 header for the
 844          IPv6-in-IPv4 and IPv4-in-IPv4 tunnels. For  IPv6-in-IPv6


 876          of IPv4 packets on certain link levels. Drivers supplied
 877          with this release no longer use this flag.  It  is  pro-
 878          vided for compatibility, but is ignored.
 879 
 880 
 881      -trailers
 882 
 883          Disable the use of a "trailer" link level encapsulation.
 884 
 885 
 886      tsrc tunnel_src_address
 887 
 888          Set the source address of a tunnel. This is  the  source
 889          address  on an outer encapsulating IP header. It must be
 890          an address of another interface already configured using
 891          ifconfig.
 892 
 893 
 894      unplumb
 895 
 896          For a physical or  IPMP interface, remove all associated
 897          logical IP interfaces and tear  down any plumbing needed
 898          for IP to use the interface.   For an IPMP IP interface,
 899          this command will fail if the group is not empty.  For a
 900          logical interface, the logical interface is removed.

 901 
 902          An interface must be separately  unplumbed for IPv4  and
 903          IPv6  according to the  *address_family* parameter (IPv4
 904          if unspecified).  Upon success,  the interface name will
 905          no longer appear in the output of *ifconfig -a*.
 906 
 907 
 908      up
 909 
 910          Mark a  logical  interface *UP*.   As  a result, the  IP
 911          module will  accept packets  destined to  the associated
 912          address  (unless the  address is  zero), along with  any
 913          associated  multicast   and broadcast   IP    addresses.
 914          Similarly, the  IP module will  allow packets to be sent
 915          with the associated address as a source address.
 916 
 917 
 918      usesrc [ name | none ]
 919 
 920          Specify a physical  interface  to  be  used  for  source
 921          address selection. If the keyword none is used, then any
 922          previous selection is cleared.
 923 
 924 
 925 
 926 SunOS 5.11          Last change: 21 Jan 2007                   14
 927 
 928 
 929 
 930 
 931 
 932 
 933 System Administration Commands                       ifconfig(1M)
 934 
 935 


 961          loopback),  be  aware that you can also specify the vir-
 962          tual IP interface (see vni(7D)). The virtual  IP  inter-
 963          face is not associated with any physical hardware and is
 964          thus immune to hardware failures. You  can  specify  any
 965          number  of physical interfaces to use the source address
 966          hosted on a single virtual  interface.  This  simplifies
 967          the  configuration of routing-based multipathing. If one
 968          of the physical interfaces were to  fail,  communication
 969          would continue through one of the remaining, functioning
 970          physical interfaces.  This  scenario  assumes  that  the
 971          reachability of the address hosted on the virtual inter-
 972          face is advertised in some manner, for example,  through
 973          a routing protocol.
 974 
 975          Because the ifconfig preferred option is applied to  all
 976          interfaces,   it  is  coarser-grained  than  the  usesrc
 977          option. It will  be  overridden  by  usesrc  and  setsrc
 978          (route subcommand), in that order.
 979 
 980          The use of the usesrc option is  mutually  exclusive  of
 981          the IPMP *group* and *standby* subcommands.  That is, if
 982          an interface  is   already  part of  a  IPMP  group   or
 983          specified as a  *STANDBY*  interface, then it  cannot be
 984          specified with a usesrc option, and vice-versa.


 985 
 986 
 987 


 988 SunOS 5.11          Last change: 21 Jan 2007                   15
 989 
 990 
 991 
 992 
 993 
 994 
 995 System Administration Commands                       ifconfig(1M)
 996 
 997 
 998 
 999      xmit
1000 
1001          Enable a logical interface to transmit packets. This  is
1002          the default behavior when the logical interface is up.
1003 
1004 
1005      -xmit
1006 
1007          Disable transmission of packets  on  an  interface.  The


1222 
1223          Indicates an anycast address. An anycast address identi-
1224          fies  the nearest member of a group of systems that pro-
1225          vides a particular type of service. An  anycast  address
1226          is assigned to a group of systems. Packets are delivered
1227          to the nearest group member identified  by  the  anycast
1228          address instead of being delivered to all members of the
1229          group.
1230 
1231 
1232      BROADCAST
1233 
1234          This broadcast address is valid. This flag and  POINTTO-
1235          POINT are mutually exclusive
1236 
1237 
1238      CoS
1239 
1240          This interface supports some form of  Class  of  Service
1241          (CoS)  marking.  An  example is the 802.1D user priority
1242          marking  supported   on  VLAN interfaces.   For  IPMP IP
1243          interfaces, this will  only be set  if all interfaces in
1244          the group have CoS set.
1245 
1246 
1247      DEPRECATED
1248 
1249          This address is deprecated. This  address  will  not  be
1250          used  as  a  source  address for outbound packets unless














1251          there are no other addresses on  this  interface  or  an
1252          application has explicitly  bound  to  this address.  An
1253          IPv6   deprecated  address   is  part   of  the standard
1254          mechanism for renumbering in IPv6 and will eventually be
1255          deleted when   not   used.   For both  IPv4   and  IPv6,
1256          *DEPRECATED* is also  set on all *NOFAILOVER* addresses,
1257          though this may change in a future release.

1258 
1259      DHCPRUNNING
1260 
1261          The logical interface is managed by *dhcpagent(1M)*.
1262 

1263 

1264      DUPLICATE
1265 
1266          The logical interface has been disabled because  the  IP
1267          address configured on the interface is a duplicate. Some
1268          other node on the network is using this address. If  the
1269          address was configured by DHCP or is temporary, the sys-
1270          tem will choose another automatically, if possible. Oth-
1271          erwise,  the system will attempt to recover this address
1272          periodically and the interface  will  recover  when  the
1273          conflict has been removed from the network. Changing the
1274          address or netmask, or setting the logical interface  to
1275          up  will restart duplicate detection. Setting the inter-
1276          face to down terminates recovery and removes the  DUPLI-
1277          CATE flag.
1278 
1279 
1280      FAILED
1281 
1282          The *in.mpathd* daemon has determined that the interface
1283          has  failed.  *FAILED*  interfaces will  not be used  to
1284          send or receive  IP data traffic.   If this is  set on a
1285          physical IP interface in  an IPMP group, IP data traffic
1286          will continue to flow over other usable IP interfaces in
1287          the IPMP group.  If this is set on an IPMP IP interface,
1288          the entire  group has failed and  no data traffic can be
1289          sent or received over any interfaces in that group.
1290 
1291 
1292      FIXEDMTU
1293 
1294          The MTU has been set using the -mtu option. This flag is
1295          read-only.  Interfaces  that  have  this flag set have a
1296          fixed MTU  value  that  is  unaffected  by  dynamic  MTU
1297          changes  that  can  occur when drivers notify IP of link
1298          MTU changes.
1299 
1300 
1301      INACTIVE
1302 
1303          The physical interface is functioning but is not used to
1304          send or receive data traffic according to administrative
1305          policy.  This flag  is  initially set by  the  *standby*
1306          subcommand   and   is     subsequently     controlled by
1307          *in.mpathd*.   It also  set  when  *FAILBACK=no* mode is
1308          enabled (see  *in.mpathd(1M)*) to  indicate that  the IP
1309          interface has repaired but is not being used.
1310 
1311 
1312      IPMP
1313 
1314          Indicates that this is an IPMP IP interface.
1315 
1316 
















1317      LOOPBACK
1318 
1319          Indicates that this is the loopback interface.
1320 
1321 





1322      MULTI_BCAST
1323 
1324          Indicates that the broadcast address is used for  multi-
1325          cast on this interface.
1326 
1327 
1328      MULTICAST
1329 
1330          The interface supports multicast. IP  assumes  that  any
1331          interface that supports hardware broadcast, or that is a
1332          point-to-point link, will support multicast.
1333 
1334 
1335      NOARP
1336 
1337          There is no address resolution protocol (ARP)  for  this
1338          interface  that corresponds to all interfaces for a dev-
1339          ice without a broadcast address. This flag  is  specific
1340          to IPv4.
1341 
1342 
1343      NOFAILOVER
1344 
1345          The address associated  with  this logical  interface is
1346          available     to  *in.mpathd*  for   probe-based failure
1347          detection of the associated physical IP interface.
1348 
1349 
1350      NOLOCAL
1351 
1352          The interface has no address , just an on-link subnet.
1353 
1354 
1355 
1356 
1357 
1358 
1359 SunOS 5.11          Last change: 21 Jan 2007                   21
1360 
1361 
1362 
1363 
1364 
1365 
1366 System Administration Commands                       ifconfig(1M)
1367 


1378 
1379 
1380      NORTEXCH
1381 
1382          The interface does not exchange routing information. For
1383          RIP-2, routing packets are not sent over this interface.
1384          Additionally, messages that appear  to  come  over  this
1385          interface  receive no response. The subnet or address of
1386          this interface is not included  in  advertisements  over
1387          other interfaces to other routers.
1388 
1389 
1390      NOXMIT
1391 
1392          Indicates that the address does  not  transmit  packets.
1393          RIP-2 also does not advertise this address.
1394 
1395 
1396      OFFLINE
1397 
1398          The interface is offline and thus cannot send or receive
1399          IP  data traffic.  This is  only set on IP interfaces in
1400          an IPMP group.  See *if_mpadm(1M)* and *cfgadm(1M)*.


1401 
1402 
1403      POINTOPOINT
1404 
1405          Indicates that the address  is  a  point-to-point  link.
1406          This flag and BROADCAST are mutually exclusive
1407 
1408 
1409      PREFERRED
1410 
1411          This address is a preferred IPv6  source  address.  This
1412          address  will  be used as a source address for IPv6 com-
1413          munication with all IPv6  destinations,  unless  another
1414          address  on the system is of more appropriate scope. The
1415          DEPRECATED flag  takes  precedence  over  the  PREFERRED
1416          flag.
1417 
1418 
1419 
1420 


1430 System Administration Commands                       ifconfig(1M)
1431 
1432 
1433 
1434      PRIVATE
1435 
1436          Indicates that this address is not advertised. For  RIP-
1437          2,  this  interface is used to send advertisements. How-
1438          ever, neither the subnet nor this address  are  included
1439          in advertisements to other routers.
1440 
1441 
1442      ROUTER
1443 
1444          Indicates that IP packets can be forwarded to  and  from
1445          the interface.
1446 
1447 
1448      RUNNING
1449 
1450          Indicates that the required resources for  an i nterface
1451          are  allocated.  For some interfaces this also indicates
1452          that the link is  up.  For IPMP IP interfaces, *RUNNING*
1453          is set as  long  as one IP   interface in the   group is
1454          active.
1455 
1456 
1457      STANDBY
1458 
1459          Indicates that this physical  interface will not be used
1460          for data  traffic  unless another interface in  the IPMP
1461          group  becomes unusable.   The  *INACTIVE* and  *FAILED*
1462          flags indicate whether it is actively being used.



1463 
1464 
1465      TEMPORARY
1466 
1467          Indicates that this  is  a  temporary  IPv6  address  as
1468          defined in RFC 3041.
1469 
1470 
1471      UNNUMBERED
1472 
1473          This flag is set when the local IP address on  the  link
1474          matches the local address of some other link in the sys-
1475          tem
1476 
1477 
1478      UP
1479 
1480          Indicates that the logical interface (and the associated
1481          physical interface)  is up.  The  IP  module will accept
1482          packets destined to UP addresses  (unless the address is
1483          zero), along with any associated multicast and broadcast
1484          IP  addresses.   Similarly, the  IP  module  will  allow
1485          packets   to  be sent with an    UP address as  a source
1486          address.
1487 
1488 



1489 SunOS 5.11          Last change: 21 Jan 2007                   23
1490 
1491 
1492 
1493 
1494 
1495 
1496 System Administration Commands                       ifconfig(1M)
1497 
1498 
1499 
1500      VIRTUAL
1501 
1502          Indicates that the physical interface has no  underlying
1503          hardware.  It  is  not  possible  to transmit or receive
1504          packets through a virtual  interface.  These  interfaces
1505          are  useful  for configuring local addresses that can be
1506          used on  multiple  interfaces.  (See  also  the *usesrc*
1507          option.)
1508 
1509 
1510      XRESOLV
1511 
1512          Indicates that  the  interface  uses  an  IPv6  external
1513          resolver.
1514 
1515 
1516 LOGICAL INTERFACES
1517      Solaris TCP/IP allows  multiple  logical  interfaces  to  be
1518      associated  with a physical network interface. This allows a
1519      single machine to be assigned multiple  IP  addresses,  even
1520      though it may have only one network interface. Physical net-
1521      work  interfaces  have  names  of   the   form   driver-name
1522      physical-unit-number, while logical interfaces have names of
1523      the  form   driver-name   physical-unit-number:logical-unit-
1524      number.  A  physical interface is configured into the system
1525      using the plumb command. For example:
1526 


1557 
1558 
1559 
1560 
1561 
1562 System Administration Commands                       ifconfig(1M)
1563 
1564 
1565 
1566      A logical interface can  be  configured  with  parameters  (
1567      address,prefix_length,  and so on) different from the physi-
1568      cal interface with which it is  associated.  Logical  inter-
1569      faces  that  are associated with the same physical interface
1570      can be given different  parameters  as  well.  Each  logical
1571      interface  must be associated with an existing and "up" phy-
1572      sical interface. So,  for  example,  the  logical  interface
1573      eri0:1  can  only be configured after the physical interface
1574      eri0 has been plumbed.
1575 
1576 
1577      To  delete  a logical   interface,   use the  *unplumb*   or
1578      *removeif* options. For example,
1579 
1580        example% ifconfig eri0:1 down unplumb
1581 
1582      will delete the logical interface *eri0:1*.
1583 
1584 IP MULTIPATHING GROUPS
1585 
1586      Physical interfaces that  share the same IP broadcast domain
1587      _must_ be  collected into  a  single IP  Multipathing (IPMP)
1588      group using the *group*  subcommand.  Each IPMP group has an
1589      associated IPMP IP interface, which can either be explicitly
1590      created  (the   preferred  method)   by using    the  *ipmp*
1591      subcommand or implicitly created  by *ifconfig* in  response
1592      to  placing  an  IP   interface into    a  new  IPMP  group.
1593      Implicitly-created IPMP interfaces   will be named   ipmp_N_
1594      where  _N_ is the  lowest integer that doesn't conflict with
1595      an existing IP interface name or IPMP group name.
1596 
1597      Each IPMP IP interface is created with a matching IPMP group
1598      name, though it can be changed using the *group* subcommand.
1599      Each  IPMP IP interface hosts a   set of highly-available IP
1600      addresses.  These addresses will remain reachable so long as
1601      at   least  one interface   in   the group  is active, where
1602      "active" is  defined as having  at least one  UP address and
1603      having   *INACTIVE*,  *FAILED*,   and   *OFFLINE* clear.  IP
1604      addresses   hosted on the IPMP   IP  interface may either be
1605      configured  statically or   configured through DHCP  via the
1606      *dhcp* subcommand.
1607 
1608      Interfaces assigned  to the same  IPMP  group are treated as
1609      equivalent and   monitored  for   failure    by *in.mpathd*.
1610      Provided   that active interfaces in    the group remain, IP
1611      interface failures (and any  subsequent repairs) are handled
1612      transparently  to  sockets-based applications.  IPMP is also
1613      integrated with  the  Dynamic Reconfiguration framework (see
1614      *cfgadm(1M)*), which enables network adapters to be replaced
1615      transparently to sockets-based applications.


1616      
1617      The IP    module  automatically  load-spreads   all outbound
1618      traffic across  all   active interfaces in an    IPMP group.
1619      Similarly,   all  *UP* addresses   hosted   on the  IPMP  IP
1620      interface and   will   be distributed   across the    active
1621      interfaces   to  promote    inbound  load-spreading.     The
1622      *ipmpstat(1M)*  utility  allows  many  aspects  of  the IPMP
1623      subsystem  to be observed,  including the current binding of
1624      IP data addresses to IP interfaces.
1625 
1626      When an  interface is placed   into an IPMP group,  any *UP*
1627      logical interfaces are "migrated"  to the IPMP IP  interface
1628      for use by the group, unless:
1629 
1630          * The logical interface is marked *NOFAILOVER*
1631          * The logical interface hosts an IPv6 link-local address.
1632          * The logical interface hosts an IPv4 0.0.0.0 address.
1633 
1634      Likewise, once an interface is  in  a group, if changes  are
1635      made to a  logical  interface such  that it is  *UP* and not
1636      exempted  by one   of the  conditions  above, it  will  also
1637      migrate  to the associated   IPMP  IP   interface.   Logical
1638      interfaces  never  migrate   back,  even  if  the   physical
1639      interface that contributed  the address is removed from  the
1640      group.
1641 
1642      Each interface placed into  an IPMP group may  be optionally
1643      configured with a "test"  address that *in.mpathd* will  use
1644      for probe-based   failure detection;  see   *in.mpathd(1M)*.
1645      These   addresses must be   marked  *NOFAILOVER* (using  the
1646      *-failover* subcommand)  prior to being  marked  *UP*.  Test
1647      addresses may also be  acquired through DHCP via  the *dhcp*
1648      subcommand.
1649      
1650      For   more  background  on   IPMP,   please see   the  "IPMP
1651      Administrative  Overview"  and  "IPMP Configuration   Tasks"
1652      chapters of the administrator documentation.
1653 
1654 
1655 CONFIGURING IPV6 INTERFACES
1656      When an IPv6 physical interface is  plumbed  and  configured
1657      "up"  with  ifconfig,  it  is automatically assigned an IPv6
1658      link-local address for which the last 64 bits are calculated
1659      from the MAC address of the interface.
1660 
1661        example% ifconfig eri0 inet6 plumb up
1662 
1663 
1664 
1665 
1666      The following example shows that the link-local address  has
1667      a prefix of fe80::/10.
1668 
1669        example% ifconfig eri0 inet6
1670        ce0: flags=2000841<UP,RUNNING,MULTICAST,IPv6>
1671 
1672 
1673 
1674 SunOS 5.11          Last change: 21 Jan 2007                   25


2107         inet 1.2.3.4 netmask ffffff00 broadcast 1.2.3.255
2108         ether 0:3:ba:17:4b:e1
2109        vni0: flags=20011100c1<UP,RUNNING,NOARP,NOXMIT,ROUTER,IPv4,VIRTUAL>
2110         mtu 0 index 5
2111         srcof qfe2
2112         inet 3.4.5.6 netmask ffffffff
2113 
2114 
2115 
2116      Observe, above, the usesrc and srcof keywords in the  ifcon-
2117      fig  output.  These  keywords  also  appear  on  the logical
2118      instances of the physical interface, even though this  is  a
2119      per-physical  interface parameter. There is no srcof keyword
2120      in ifconfig for configuring interfaces. This information  is
2121      determined  automatically  from  the  set of interfaces that
2122      have usesrc set on them.
2123 
2124 
2125 
2126      The following command, using the none  keyword,  undoes  the
2127      effect of the preceding *ifconfig* *usesrc* command.
2128 
2129 
2130        example% ifconfig qfe2 usesrc none
2131 
2132 
2133 
2134 
2135 
2136 SunOS 5.11          Last change: 21 Jan 2007                   32
2137 
2138 
2139 
2140 
2141 
2142 
2143 System Administration Commands                       ifconfig(1M)
2144 
2145 
2146 
2147      Following this command, ifconfig -a output displays as  fol-


2339 
2340 
2341 System Administration Commands                       ifconfig(1M)
2342 
2343 
2344 
2345      _______________________________________________________________________
2346     |             ATTRIBUTE TYPE            |        ATTRIBUTE VALUE       |
2347     |_______________________________________|______________________________|
2348     | Availability                          |  SUNWcsu                     |
2349     |_______________________________________|______________________________|
2350     | Interface Stability  for  command-line|  Committed                   |
2351     | options                               |                              |
2352     |_______________________________________|______________________________|
2353     | Interface Stability for command output|  Uncommitted                 |
2354     |_______________________________________|______________________________|
2355 
2356 
2357 SEE ALSO
2358      dhcpinfo(1),  dhcpagent(1M),   in.mpathd(1M),   in.ndpd(1M),
2359      in.routed(1M), ipmpstat(1M), ipsecconf(1M),  netstat(1M),
2360      zoneadm(1M),          zonecfg(1M),          ethers(3SOCKET),
2361      gethostbyname(3NSL),     getnetbyname(3SOCKET),    hosts(4),
2362      inet_type(4),   ndpd.conf(4),   netmasks(4),    networks(4),
2363      nsswitch.conf(4),  attributes(5),  privileges(5),  zones(5),
2364      arp(7P), ipsecah(7P), ipsecesp(7P), tun(7M)
2365 
2366 
2367 DIAGNOSTICS
2368      ifconfig sends messages that indicate if:
2369 
2370          o    the specified interface does not exist
2371 
2372          o    the requested address is unknown
2373 
2374          o    the user is not privileged and tried  to  alter  an
2375               interface's configuration
2376 
2377 NOTES
2378      Do not select the names broadcast, down, private,  trailers,
2379      up  or  other  possible  option  names  when you choose host