blob: 88349b387750f28b2779b5a5025cede49debf77d [file] [log] [blame]
Charles Chancaebcf32021-09-20 22:17:52 -07001Component Configuration
2=======================
Wailok Shum2f05cd32021-09-30 22:18:19 +08003
4Different from network configurations,
5component configurations are attributes and feature flags specific to ONOS components.
6
7For more details, please read ONOS Wiki `Component Configuration <https://wiki.onosproject.org/display/ONOS/Component+Configuration>`_
8
9Enable/Disable Phased Recovery
10------------------------------
Charles Chan0bc8bf52021-10-07 12:53:55 -070011Phased recovery is an experimental feature that ensure a
12recovering switch are programmed before pointing traffic from other switches towards it.
13
Wailok Shum2f05cd32021-09-30 22:18:19 +080014To 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
22We can see that the default value of phased recovery is false.
23Which means it is disabled by default.
24
25To 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
33Now the value is true and we have successfully enable phased recovery.
34
35To 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.