src/plugins/lacp/lacp_doc.rst

   1 LACP Protocol
   2 =============
   3
   4 This document is to describe the usage of VPP Link Aggregation Control
   5 Protocol (LACP) implementation.
   6
   7 LACP
   8 ----
   9
  10 The Link Aggregation Control Protocol (LACP) is an 802.3ad standard
  11 which provides a protocol for exchanging information between Partner
  12 Systems on a link to allow their protocol instances to reach agreement
  13 on the Link Aggregation Group to which the link belongs and enable
  14 transmission and reception for the higher layer. Multiple links may be
  15 bundled to the same Aggregation Group to form a high bandwidth
  16 transmission medium and create a fault-tolerant link.
  17
  18 Configuration
  19 ~~~~~~~~~~~~~
  20
  21 1. Create the bond interface create bond mode lacp [hw-addr ]
  22    [load-balance { l2 \| l23 \| l34 } [numa-only]]
  23
  24 2. Enslave the physical interface to the bond bond add [passive]
  25    [long-timeout]”
  26
  27 3. Delete the bond interface delete bond { \| sw_if_index }
  28
  29 4. Detach the slave interface from the bond bond del
  30
  31 Configuration example
  32 ~~~~~~~~~~~~~~~~~~~~~
  33
  34 ::
  35
  36    create bond mode lacp
  37    set interface state BondEthernet0 up
  38    bond add BondEthernet0 TenGigabitEthernet7/0/0
  39    bond add BondEthernet0 TenGigabitEthernet7/0/1
  40    bond add BondEthernet0 TenGigabitEthernet5/0/0
  41    bond add BondEthernet0 TenGigabitEthernet5/0/1
  42
  43 ::
  44
  45    bond del TenGigabitEthernet5/0/1
  46
  47 ::
  48
  49    delete bond BondEthernet0
  50
  51 Operational data
  52 ~~~~~~~~~~~~~~~~
  53
  54 ::
  55
  56    show lacp [<interface>] [details]
  57
  58 Example:
  59
  60 ::
  61
  62    DBGvpp# show lacp
  63                                                            actor state                      partner state
  64    interface name            sw_if_index  bond interface   exp/def/dis/col/syn/agg/tim/act  exp/def/dis/col/syn/agg/tim/act
  65    GigabitEthernet2/0/1      1            BondEthernet0      0   0   1   1   1   1   1   1    0   0   1   1   1   1   1   1
  66      LAG ID: [(ffff,e4-c7-22-f3-26-71,0000,00ff,0001), (ffff,fc-99-47-4a-0c-8b,0009,00ff,0001)]
  67      RX-state: CURRENT, TX-state: TRANSMIT, MUX-state: COLLECTING_DISTRIBUTING, PTX-state: PERIODIC_TX
  68    TenGigabitEthernet4/0/0   2            BondEthernet1      0   0   1   1   1   1   1   1    0   0   1   1   1   1   0   1
  69      LAG ID: [(ffff,90-e2-ba-76-cf-2d,0001,00ff,0001), (8000,00-2a-6a-e5-50-c1,0140,8000,011d)]
  70      RX-state: CURRENT, TX-state: TRANSMIT, MUX-state: COLLECTING_DISTRIBUTING, PTX-state: PERIODIC_TX
  71    TenGigabitEthernet4/0/1   3            BondEthernet1      0   0   1   1   1   1   1   1    0   0   1   1   1   1   0   1
  72      LAG ID: [(ffff,90-e2-ba-76-cf-2d,0001,00ff,0002), (8000,00-2a-6a-e5-50-c1,0140,8000,011e)]
  73      RX-state: CURRENT, TX-state: TRANSMIT, MUX-state: COLLECTING_DISTRIBUTING, PTX-state: PERIODIC_TX
  74    TenGigabitEthernet8/0/1   7            BondEthernet1      0   0   1   1   1   1   1   1    0   0   1   1   1   1   0   1
  75      LAG ID: [(ffff,90-e2-ba-76-cf-2d,0001,00ff,0003), (8000,00-2a-6a-e5-50-01,007a,8000,0114)]
  76      RX-state: CURRENT, TX-state: TRANSMIT, MUX-state: COLLECTING_DISTRIBUTING, PTX-state: PERIODIC_TX
  77    TenGigabitEthernet8/0/0   6            BondEthernet1      0   0   1   1   1   1   1   1    0   0   1   1   1   1   0   1
  78      LAG ID: [(ffff,90-e2-ba-76-cf-2d,0001,00ff,0004), (8000,00-2a-6a-e5-50-01,007a,8000,0115)]
  79      RX-state: CURRENT, TX-state: TRANSMIT, MUX-state: COLLECTING_DISTRIBUTING, PTX-state: PERIODIC_TX
  80    TenGigabitEthernet6/0/1   5            BondEthernet2      0   0   1   1   1   1   1   1    0   0   1   1   1   1   1   1
  81      LAG ID: [(ffff,90-e2-ba-36-31-21,0002,00ff,0001), (ffff,90-e2-ba-29-f5-31,000f,00ff,0002)]
  82      RX-state: CURRENT, TX-state: TRANSMIT, MUX-state: COLLECTING_DISTRIBUTING, PTX-state: PERIODIC_TX
  83    TenGigabitEthernet6/0/0   4            BondEthernet2      0   0   1   1   1   1   1   1    0   0   1   1   1   1   1   1
  84      LAG ID: [(ffff,90-e2-ba-36-31-21,0002,00ff,0002), (ffff,90-e2-ba-29-f5-31,000f,00ff,0001)]
  85      RX-state: CURRENT, TX-state: TRANSMIT, MUX-state: COLLECTING_DISTRIBUTING, PTX-state: PERIODIC_TX
  86    DBGvpp#
  87
  88 ::
  89
  90    show bond [details]
  91
  92 Example:
  93
  94 ::
  95
  96    DBGvpp# show bond
  97    sh bond
  98    interface name   sw_if_index   mode         load balance  active slaves  slaves
  99    BondEthernet0    10            lacp         l2            1              1
 100    BondEthernet1    11            lacp         l34           4              4
 101    BondEthernet2    12            lacp         l23           2              2
 102    DBGvpp#
 103
 104 Debugging
 105 ~~~~~~~~~
 106
 107 ::
 108
 109    debug lacp [<interface>] <on | off>