| Charles Chan | caebcf3 | 2021-09-20 22:17:52 -0700 | [diff] [blame] | 1 | Component Configuration |
| 2 | ======================= |
| Wailok Shum | 2f05cd3 | 2021-09-30 22:18:19 +0800 | [diff] [blame] | 3 | |
| 4 | Different from network configurations, |
| 5 | component configurations are attributes and feature flags specific to ONOS components. |
| 6 | |
| 7 | For more details, please read ONOS Wiki `Component Configuration <https://wiki.onosproject.org/display/ONOS/Component+Configuration>`_ |
| 8 | |
| 9 | Enable/Disable Phased Recovery |
| 10 | ------------------------------ |
| Charles Chan | 0bc8bf5 | 2021-10-07 12:53:55 -0700 | [diff] [blame] | 11 | Phased recovery is an experimental feature that ensure a |
| 12 | recovering switch are programmed before pointing traffic from other switches towards it. |
| 13 | |
| Wailok Shum | 2f05cd3 | 2021-09-30 22:18:19 +0800 | [diff] [blame] | 14 | To check current status: |
| 15 | |
| 16 | .. code-block:: console |
| 17 | |
| 18 | onos > cfg get org.onosproject.segmentrouting.phasedrecovery.impl.PhasedRecoveryManager phasedRecovery |
| 19 | name=phasedRecovery, type=boolean, value=false, defaultValue=false, description=Enabling phased recovery. |
| 20 | |
| 21 | |
| 22 | We can see that the default value of phased recovery is false. |
| 23 | Which means it is disabled by default. |
| 24 | |
| 25 | To enable phased recovery: |
| 26 | |
| 27 | .. code-block:: console |
| 28 | |
| 29 | onos > cfg set org.onosproject.segmentrouting.phasedrecovery.impl.PhasedRecoveryManager phasedRecovery true |
| 30 | onos > cfg get org.onosproject.segmentrouting.phasedrecovery.impl.PhasedRecoveryManager phasedRecovery |
| 31 | name=phasedRecovery, type=boolean, value=true, defaultValue=false, description=Enabling phased recovery. |
| 32 | |
| 33 | Now the value is true and we have successfully enable phased recovery. |
| 34 | |
| 35 | To disable phased recovery, change the value to ``false``. |
| 36 | |
| 37 | |
| 38 | .. tip:: |
| 39 | Simply run ``cfg get`` in ONOS CLI to view all available component configurations supported by ONOS. |
| 40 | The default values are fine-tuned for SD-Fabric, and therefore we use them for most of the cases. |