Print this page 
Clearview IPMP manpages
Split Close
Expand all
Collapse all
          --- old/./ifconfig.txt
          +++ new/./ifconfig.txt
   1      -
   2      -
   3      -
   4    1  System Administration Commands                       ifconfig(1M)
   5    2  
   6    3  
   7    4  
   8    5  NAME
   9    6       ifconfig - configure network interface parameters
  10    7  
  11    8  SYNOPSIS
  12    9       ifconfig interface [address_family] [address  [/prefix_length]
  13   10       [dest_address]] [addif  address  [/prefix_length]]
  14   11       [removeif  address  [/prefix_length]] [arp |  -arp]
  15   12       [auth_algs authentication algorithm] [encr_algs encryption algorithm]
  16   13       [encr_auth_algs authentication algorithm] [auto-revarp]
  17   14       [broadcast  address] [deprecated |  -deprecated]
  18   15       [preferred |  -preferred] [destination  dest_address]
  19   16       [ether  [address]] [failover |  -failover] [group
  20      -     [name |  ""]] [index   if_index] [metric  n] [modlist]
       17 +     [name |  ""]] [index if_index] [ipmp] [metric  n] [modlist]
  21   18       [modinsert mod_name@pos] [modremove mod_name@pos]
  22   19       [mtu  n] [netmask  mask] [plumb] [unplumb] [private
  23   20       |  -private] [nud |  -nud] [set  [address]  [/netmask]]
  24   21       [standby |  -standby] [subnet  subnet_address] [tdst
  25   22       tunnel_dest_address] [token   address/prefix_length]
  26   23       [tsrc  tunnel_src_address] [trailers |  -trailers]
  27   24       [up] [down] [usesrc [name |  none]] [xmit |  -xmit]
  28   25       [encaplimit n |  -encaplimit] [thoplimit n] [router
  29   26       |  -router] [zone zonename |  -zone |  -all-zones]
  30   27
↓ open down ↓ 43 lines elided ↑ open up ↑ 
  74   71       address  or characteristics of the interface. If the address
  75   72       of an interface under DHCP is changed, dhcpagent will remove
  76   73       the interface from its control.
  77   74  
  78   75  OPTIONS
  79   76       The following options are supported:
  80   77  
  81   78       addif address
  82   79  
  83   80           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.
       81 +         fied  physical  interface.
  88   82  
  89      -
  90   83       all-zones
  91   84  
  92   85           Make the interface available to every shared-IP zone  on
  93   86           the  system.  The  appropriate  zone to which to deliver
  94   87           data is determined using the  tnzonecfg  database.  This
  95   88           option  is  available  only  if the system is configured
  96   89           with the Solaris Trusted Extensions feature.
  97   90  
  98   91           The tnzonecfg database is described in the  tnzonecfg(4)
  99   92           man  page,  which  is part of the Solaris Trusted Exten-
↓ open down ↓ 33 lines elided ↑ open up ↑ 
 133  126  
 134  127  
 135  128  
 136  129  System Administration Commands                       ifconfig(1M)
 137  130  
 138  131  
 139  132  
 140  133       -arp
 141  134  
 142  135           Disable the use of the ARP on a physical interface.
      136 +         ARP cannot be disabled on an IPMP IP interface.
 143  137  
 144  138  
 145  139       auth_algs authentication algorithm
 146  140  
 147  141           For a tunnel, enable IPsec AH  with  the  authentication
 148  142           algorithm  specified.  The  algorithm  can  be  either a
 149  143           number or an algorithm name, including any to express no
 150  144           preference  in  algorithm.  All  IPsec tunnel properties
 151  145           must be specified on the same command line.  To  disable
 152  146           tunnel security, specify an auth_alg of none.
↓ open down ↓ 319 lines elided ↑ open up ↑ 
 472  466  
 473  467           It is now preferable to use  the  ipsecconf(1M)  command
 474  468           when  configuring  a  tunnel's  security  properties. If
 475  469           ipsecconf was used to set a  tunnel's  security  proper-
 476  470           ties, this keyword will not affect the tunnel.
 477  471  
 478  472  
 479  473       ether [ address ]
 480  474  
 481  475           If no address is given and the user is root or has  suf-
 482      -         ficient  privileges  to open the underlying device, then
      476 +         ficient privileges to open the underlying datalink, then
 483  477           display the current Ethernet address information.
 484  478  
 485  479           Otherwise,  if  the  user  is  root  or  has  sufficient
 486  480           privileges,  set  the Ethernet address of the interfaces
 487  481           to  address.  The  address  is   an   Ethernet   address
 488  482           represented  as  x:x:x:x:x:x  where  x  is a hexadecimal
 489  483           number between 0 and FF. Similarly, for  the  IPoIB  (IP
 490  484           over  InfiniBand)  interfaces,  the  address  will be 20
 491  485           bytes of colon-separated hex numbers between 0 and FF.
 492  486  
 493      -         Some, though not  all,  Ethernet  interface  cards  have
      487 +         Some,   though not  all,  Ethernet  interface cards have
 494  488           their own addresses. To use cards that do not have their
 495      -         own addresses, refer to section  3.2.3(4)  of  the  IEEE
      489 +         own  addresses, refer  to  section 3.2.3(4) of the  IEEE
 496  490           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).
      491 +         administered address space.  Note that all IP interfaces
      492 +         in an  IPMP  group must have unique  hardware addresses;
      493 +         see *in.mpathd(1M)*.
 500  494  
 501  495  
 502  496       -failover
 503  497  
 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.
      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.
 508  504  
 509  505  
 510  506       failover
 511  507  
 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.
      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).
 516  511  
 517  512  
 518      -     group [ name |""]
      513 +     group [ name | "" ]
 519  514  
 520      -         Insert the logical interface in the  multipathing  group
 521      -         specified  by name. To delete an interface from a group,
      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.
 522  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.
 523  531  
 524  532  
 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  533       index n
 542  534  
 543  535           Change the interface index for the interface. The  value
 544  536           of  n  must be an interface index (if_index) that is not
 545  537           used on another interface. if_index will be  a  non-zero
 546  538           positive  number  that  uniquely  identifies the network
 547  539           interface on the system.
 548  540  
 549  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 +
 550  551       metric n
 551  552  
 552  553           Set the routing metric of the  interface  to  n;  if  no
 553  554           value is specified, the default is 0. The routing metric
 554  555           is used by the routing protocol. Higher metrics have the
 555  556           effect  of  making  a  route less favorable. Metrics are
 556  557           counted as addition hops to the destination  network  or
 557  558           host.
 558  559  
 559  560
↓ open down ↓ 172 lines elided ↑ open up ↑ 
 732  733  
 733  734  
 734  735       -nud
 735  736  
 736  737           Disables the neighbor unreachability detection mechanism
 737  738           on a point-to-point physical interface.
 738  739  
 739  740  
 740  741       plumb
 741  742  
 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.
      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.
 750  749  
 751      -         Before an interface has been plumbed, the interface will
 752      -         not show up in the output of the ifconfig -a command.
      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*.
 753  754  
      755 +         Note that IPMP IP interfaces are not  tied to a specific
      756 +         datalink    and  are instead  created   with  the *ipmp*
      757 +         subcommand.
 754  758  
 755  759       private
 756  760  
 757  761           Tells the in.routed routing daemon that a specified log-
 758  762           ical interface should not be advertised.
 759  763  
 760  764  
 761  765       -private
 762  766  
 763  767           Specify unadvertised interfaces.
 764  768  
 765  769  
 766  770       removeif address
 767  771  
 768  772           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 +         specified  that  matches the address specified.
 773  774  
 774      -
 775  775       router
 776  776  
 777  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.
      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.
 780  782  
 781  783  
 782  784       -router
 783  785  
 784      -         Disable IP forwarding on the interface. IP  packets  are
 785      -         not forwarded to and from the interface.
      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.
 786  790  
 787  791  
 788  792  
 789  793  SunOS 5.11          Last change: 21 Jan 2007                   12
 790  794  
 791  795  
 792  796  
 793  797  
 794  798  
 795  799
↓ open down ↓ 2 lines elided ↑ open up ↑ 
 798  802  
 799  803  
 800  804       set
 801  805  
 802  806           Set the address, prefix_length or both,  for  a  logical
 803  807           interface.
 804  808  
 805  809  
 806  810       standby
 807  811  
 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.
      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.
 814  820  
 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  821  
 822      -
 823  822       -standby
 824  823  
 825      -         Turns off standby on this interface.
      824 +         Clear *STANDBY* on this interface.  This is the default.
 826  825  
 827  826  
 828  827       subnet
 829  828  
 830  829           Set the subnet address for an interface.
 831  830  
 832  831  
 833  832       tdst tunnel_dest_address
 834  833  
 835  834           Set the destination address of  a  tunnel.  The  address
↓ open down ↓ 51 lines elided ↑ open up ↑ 
 887  886       tsrc tunnel_src_address
 888  887  
 889  888           Set the source address of a tunnel. This is  the  source
 890  889           address  on an outer encapsulating IP header. It must be
 891  890           an address of another interface already configured using
 892  891           ifconfig.
 893  892  
 894  893  
 895  894       unplumb
 896  895  
 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.
      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.
 903  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*.
 904  906  
      907 +
 905  908       up
 906  909  
 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.
      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.
 911  916  
 912  917  
 913  918       usesrc [ name | none ]
 914  919  
 915  920           Specify a physical  interface  to  be  used  for  source
 916  921           address selection. If the keyword none is used, then any
 917  922           previous selection is cleared.
 918  923  
 919  924  
 920  925
↓ open down ↓ 45 lines elided ↑ open up ↑ 
 966  971           reachability of the address hosted on the virtual inter-
 967  972           face is advertised in some manner, for example,  through
 968  973           a routing protocol.
 969  974  
 970  975           Because the ifconfig preferred option is applied to  all
 971  976           interfaces,   it  is  coarser-grained  than  the  usesrc
 972  977           option. It will  be  overridden  by  usesrc  and  setsrc
 973  978           (route subcommand), in that order.
 974  979  
 975  980           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 .
      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.
 982  985  
 983  986  
 984  987  
 985      -
 986      -
 987  988  SunOS 5.11          Last change: 21 Jan 2007                   15
 988  989  
 989  990  
 990  991  
 991  992  
 992  993  
 993  994  
 994  995  System Administration Commands                       ifconfig(1M)
 995  996  
 996  997
↓ open down ↓ 234 lines elided ↑ open up ↑ 
1231 1232       BROADCAST
1232 1233  
1233 1234           This broadcast address is valid. This flag and  POINTTO-
1234 1235           POINT are mutually exclusive
1235 1236  
1236 1237  
1237 1238       CoS
1238 1239  
1239 1240           This interface supports some form of  Class  of  Service
1240 1241           (CoS)  marking.  An  example is the 802.1D user priority
1241      -         marking supported on VLAN interfaces.
     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.
1242 1245  
1243 1246  
1244 1247       DEPRECATED
1245 1248  
1246 1249           This address is deprecated. This  address  will  not  be
1247 1250           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 1251           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.
     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.
1270 1258  
     1259 +     DHCPRUNNING
1271 1260  
1272      -     DHCP
     1261 +         The logical interface is managed by *dhcpagent(1M)*.
1273 1262  
1274      -         DHCP is used to manage this address.
1275 1263  
1276      -
1277 1264       DUPLICATE
1278 1265  
1279 1266           The logical interface has been disabled because  the  IP
1280 1267           address configured on the interface is a duplicate. Some
1281 1268           other node on the network is using this address. If  the
1282 1269           address was configured by DHCP or is temporary, the sys-
1283 1270           tem will choose another automatically, if possible. Oth-
1284 1271           erwise,  the system will attempt to recover this address
1285 1272           periodically and the interface  will  recover  when  the
1286 1273           conflict has been removed from the network. Changing the
1287 1274           address or netmask, or setting the logical interface  to
1288 1275           up  will restart duplicate detection. Setting the inter-
1289 1276           face to down terminates recovery and removes the  DUPLI-
1290 1277           CATE flag.
1291 1278  
1292 1279  
1293 1280       FAILED
1294 1281  
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
     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.
1299 1290  
1300 1291  
1301 1292       FIXEDMTU
1302 1293  
1303 1294           The MTU has been set using the -mtu option. This flag is
1304 1295           read-only.  Interfaces  that  have  this flag set have a
1305 1296           fixed MTU  value  that  is  unaffected  by  dynamic  MTU
1306 1297           changes  that  can  occur when drivers notify IP of link
1307 1298           MTU changes.
1308 1299  
1309 1300  
1310 1301       INACTIVE
1311 1302  
1312      -         Indicates that the interface is not currently being used
1313      -         for  regular traffic by the system. New addresses cannot
     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.
1314 1310  
1315 1311  
     1312 +     IPMP
1316 1313  
1317      -SunOS 5.11          Last change: 21 Jan 2007                   20
     1314 +         Indicates that this is an IPMP IP interface.
1318 1315  
1319 1316  
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 1317       LOOPBACK
1337 1318  
1338 1319           Indicates that this is the loopback interface.
1339 1320  
1340 1321  
1341      -     MIP
1342      -
1343      -         Indicates that mobile IP controls this interface.
1344      -
1345      -
1346 1322       MULTI_BCAST
1347 1323  
1348 1324           Indicates that the broadcast address is used for  multi-
1349 1325           cast on this interface.
1350 1326  
1351 1327  
1352 1328       MULTICAST
1353 1329  
1354 1330           The interface supports multicast. IP  assumes  that  any
1355 1331           interface that supports hardware broadcast, or that is a
↓ open down ↓ 3 lines elided ↑ open up ↑ 
1359 1335       NOARP
1360 1336  
1361 1337           There is no address resolution protocol (ARP)  for  this
1362 1338           interface  that corresponds to all interfaces for a dev-
1363 1339           ice without a broadcast address. This flag  is  specific
1364 1340           to IPv4.
1365 1341  
1366 1342  
1367 1343       NOFAILOVER
1368 1344  
1369      -         This address will not failover if the  interface  fails.
1370      -         IP  network  multipathing  test addresses must be marked
1371      -         nofailover.
     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.
1372 1348  
1373 1349  
1374 1350       NOLOCAL
1375 1351  
1376 1352           The interface has no address , just an on-link subnet.
1377 1353  
1378 1354  
1379 1355  
1380 1356  
1381 1357
↓ open down ↓ 30 lines elided ↑ open up ↑ 
1412 1388  
1413 1389  
1414 1390       NOXMIT
1415 1391  
1416 1392           Indicates that the address does  not  transmit  packets.
1417 1393           RIP-2 also does not advertise this address.
1418 1394  
1419 1395  
1420 1396       OFFLINE
1421 1397  
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.
     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)*.
1427 1401  
1428 1402  
1429 1403       POINTOPOINT
1430 1404  
1431 1405           Indicates that the address  is  a  point-to-point  link.
1432 1406           This flag and BROADCAST are mutually exclusive
1433 1407  
1434 1408  
1435 1409       PREFERRED
1436 1410
↓ open down ↓ 29 lines elided ↑ open up ↑ 
1466 1440  
1467 1441  
1468 1442       ROUTER
1469 1443  
1470 1444           Indicates that IP packets can be forwarded to  and  from
1471 1445           the interface.
1472 1446  
1473 1447  
1474 1448       RUNNING
1475 1449  
1476      -         Indicates that the required resources for  an  interface
     1450 +         Indicates that the required resources for  an i nterface
1477 1451           are  allocated.  For some interfaces this also indicates
1478      -         that the link is up.
     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.
1479 1455  
1480 1456  
1481 1457       STANDBY
1482 1458  
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.
     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.
1490 1463  
1491 1464  
1492 1465       TEMPORARY
1493 1466  
1494 1467           Indicates that this  is  a  temporary  IPv6  address  as
1495 1468           defined in RFC 3041.
1496 1469  
1497 1470  
1498 1471       UNNUMBERED
1499 1472  
1500 1473           This flag is set when the local IP address on  the  link
1501 1474           matches the local address of some other link in the sys-
1502 1475           tem
1503 1476  
1504 1477  
1505 1478       UP
1506 1479  
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.
     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.
1510 1487  
1511 1488  
1512      -
1513      -
1514      -
1515 1489  SunOS 5.11          Last change: 21 Jan 2007                   23
1516 1490  
1517 1491  
1518 1492  
1519 1493  
1520 1494  
1521 1495  
1522 1496  System Administration Commands                       ifconfig(1M)
1523 1497  
1524 1498  
1525 1499  
1526 1500       VIRTUAL
1527 1501  
1528 1502           Indicates that the physical interface has no  underlying
1529 1503           hardware.  It  is  not  possible  to transmit or receive
1530 1504           packets through a virtual  interface.  These  interfaces
1531 1505           are  useful  for configuring local addresses that can be
1532      -         used on  multiple  interfaces.  (See  also  the  -usesrc
     1506 +         used on  multiple  interfaces.  (See  also  the *usesrc*
1533 1507           option.)
1534 1508  
1535 1509  
1536 1510       XRESOLV
1537 1511  
1538 1512           Indicates that  the  interface  uses  an  IPv6  external
1539 1513           resolver.
1540 1514  
1541 1515  
1542 1516  LOGICAL INTERFACES
↓ open down ↓ 50 lines elided ↑ open up ↑ 
1593 1567       address,prefix_length,  and so on) different from the physi-
1594 1568       cal interface with which it is  associated.  Logical  inter-
1595 1569       faces  that  are associated with the same physical interface
1596 1570       can be given different  parameters  as  well.  Each  logical
1597 1571       interface  must be associated with an existing and "up" phy-
1598 1572       sical interface. So,  for  example,  the  logical  interface
1599 1573       eri0:1  can  only be configured after the physical interface
1600 1574       eri0 has been plumbed.
1601 1575  
1602 1576  
1603      -     To delete a logical interface, use the -unplumb or -removeif
1604      -     options. For example,
     1577 +     To  delete  a logical   interface,   use the  *unplumb*   or
     1578 +     *removeif* options. For example,
1605 1579  
1606 1580         example% ifconfig eri0:1 down unplumb
1607 1581  
     1582 +     will delete the logical interface *eri0:1*.
1608 1583  
     1584 +IP MULTIPATHING GROUPS
1609 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.
1610 1596  
1611      -     will delete the logical interface eri0:1.
     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.
1612 1607  
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.
     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.
1623 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:
1624 1629  
1625      -     For more details on IP multipathing, see  in.mpathd(1M)  and
1626      -     the . See netstat(1M) for per-IP-destination information.
     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.
1627 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 +
1628 1655  CONFIGURING IPV6 INTERFACES
1629 1656       When an IPv6 physical interface is  plumbed  and  configured
1630 1657       "up"  with  ifconfig,  it  is automatically assigned an IPv6
1631 1658       link-local address for which the last 64 bits are calculated
1632 1659       from the MAC address of the interface.
1633 1660  
1634 1661         example% ifconfig eri0 inet6 plumb up
1635 1662  
1636 1663  
1637 1664
↓ open down ↓ 452 lines elided ↑ open up ↑ 
2090 2117       fig  output.  These  keywords  also  appear  on  the logical
2091 2118       instances of the physical interface, even though this  is  a
2092 2119       per-physical  interface parameter. There is no srcof keyword
2093 2120       in ifconfig for configuring interfaces. This information  is
2094 2121       determined  automatically  from  the  set of interfaces that
2095 2122       have usesrc set on them.
2096 2123  
2097 2124  
2098 2125  
2099 2126       The following command, using the none  keyword,  undoes  the
2100      -     effect of the preceding ifconfig usersrc command.
     2127 +     effect of the preceding *ifconfig* *usesrc* command.
2101 2128  
2102 2129  
2103 2130         example% ifconfig qfe2 usesrc none
2104 2131  
2105 2132  
2106 2133  
2107 2134  
2108 2135  
2109 2136  SunOS 5.11          Last change: 21 Jan 2007                   32
2110 2137
↓ open down ↓ 211 lines elided ↑ open up ↑ 
2322 2349      |_______________________________________|______________________________|
2323 2350      | Interface Stability  for  command-line|  Committed                   |
2324 2351      | options                               |                              |
2325 2352      |_______________________________________|______________________________|
2326 2353      | Interface Stability for command output|  Uncommitted                 |
2327 2354      |_______________________________________|______________________________|
2328 2355  
2329 2356  
2330 2357  SEE ALSO
2331 2358       dhcpinfo(1),  dhcpagent(1M),   in.mpathd(1M),   in.ndpd(1M),
2332      -     in.routed(1M),    ipsecconf(1M),    ndd(1M),    netstat(1M),
     2359 +     in.routed(1M), ipmpstat(1M), ipsecconf(1M),  netstat(1M),
2333 2360       zoneadm(1M),          zonecfg(1M),          ethers(3SOCKET),
2334 2361       gethostbyname(3NSL),     getnetbyname(3SOCKET),    hosts(4),
2335 2362       inet_type(4),   ndpd.conf(4),   netmasks(4),    networks(4),
2336 2363       nsswitch.conf(4),  attributes(5),  privileges(5),  zones(5),
2337 2364       arp(7P), ipsecah(7P), ipsecesp(7P), tun(7M)
2338 2365  
2339 2366  
2340 2367  DIAGNOSTICS
2341 2368       ifconfig sends messages that indicate if:
2342 2369
↓ open down ↓ 34 lines elided ↑ open up ↑ 
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX