IS-IS Graceful Support #423

SuryyaKrJana · 2025-04-21T07:26:43Z

IS-IS Graceful Restart Support

Requirement: https://github.com/openconfig/featureprofiles/blob/8e63f5ff745d0a05e0b971c5ef4934da44c1ae82/feature/isis/otg_tests/graceful_restart_helper/README.md
Redocly reference:
https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/isis-gr/artifacts/openapi.yaml&nocors#tag/Configuration/operation/set_config
Phase-I: Unplanned Restart.

Example Test configuration and Graceful Restart Trigger on IS-IS router on Port-1 and whereas IS-IS Router is configured as Restarter Helper:

// Config Creation
func IsisGRConfig(client *api.ApiClient) gosnappi.Config {
	config := gosnappi.NewConfig()
	port1 := config.Ports().Add().SetName("port1").SetLocation(opts.IxiaCPorts()[0])
	port2 := config.Ports().Add().SetName("port2").SetLocation(opts.IxiaCPorts()[1])

	// port 1 device 1
	p1d1 := config.Devices().Add().SetName("p1d1")
	// port 1 device 1 ethernet
	p1d1Eth := p1d1.Ethernets().Add().
		SetName("p1d1Eth").
		SetMac("00:00:01:01:01:01").
		SetMtu(1500)
	p1d1Eth.Connection().SetPortName(port1.Name())

	// port 1 device 1 ipv4
	p1d1Ipv4 := p1d1Eth.Ipv4Addresses().
		Add().
		SetAddress("1.1.1.2").
		SetGateway("1.1.1.1").
		SetName("p1d1Ipv4").
		SetPrefix(24)

	// port 1 device 1 isis
	p1d1Isis := p1d1.Isis().SetName("p1d1Isis").SetSystemId("640000000001")

	// port 1 device 1 isis basic
	p1d1Isis.Basic().SetIpv4TeRouterId(p1d1Ipv4.Address())
	p1d1Isis.Basic().SetHostname("ixia-c-port1")
	p1d1Isis.Basic().SetLearnedLspFilter(true)

	// port 1 device 1 isis advance
	p1d1Isis.Advanced().SetAreaAddresses([]string{"490001"})
	p1d1Isis.Advanced().SetEnableAttachedBit(false)

	// Enable Graceful restarting mode only on IS-IS Router on Port1.
	p1d1Isis.GracefulRestart().SetHelperMode(false)

	// port 1 device 1 isis interface
	p1d1IsisIntf := p1d1Isis.Interfaces().Add().
		SetEthName(p1d1Eth.Name()).
		SetNetworkType("point_to_point").
		SetLevelType(gosnappi.IsisInterfaceLevelType.LEVEL_2).
		SetMetric(10).
		SetName("p1d1IsisIntf")

	// l2 settings
	p1d1IsisIntf.L2Settings().
		SetDeadInterval(30).
		SetHelloInterval(10).
		SetPriority(0)
	p1d1IsisIntf.
		Advanced().SetAutoAdjustSupportedProtocols(true)

	// port 1 device 1 isis v4 routes
	p1d1Isisv4routes := p1d1Isis.
		V4Routes().
		Add().
		SetName("p1d1IsisIpv4").
		SetLinkMetric(10).
		SetOriginType(gosnappi.IsisV4RouteRangeOriginType.INTERNAL)
	p1d1Isisv4routes.Addresses().Add().
		SetAddress("10.10.10.1").
		SetPrefix(32).
		SetCount(1).
		SetStep(1)

	// port 2 device 1
	p2d1 := config.Devices().Add().SetName("p2d1")
	// port 2 device 1 ethernet
	p2d1Eth := p2d1.Ethernets().Add().
		SetName("p2d1Eth").
		SetMac("00:00:02:03:03:03").
		SetMtu(1500)
	p2d1Eth.Connection().SetPortName(port2.Name())

	// port 2 device 1 ipv4
	p2d1Ipv4 := p2d1Eth.Ipv4Addresses().
		Add().
		SetAddress("2.2.1.2").
		SetGateway("2.2.1.1").
		SetName("p2d1Ipv4").
		SetPrefix(24)

	// port 2 device 1 isis
	p2d1Isis := p2d1.Isis().SetName("p2d1Isis").SetSystemId("650000000001")

	// port 2 device 1 isis basic
	p2d1Isis.Basic().SetIpv4TeRouterId(p2d1Ipv4.Address())
	p2d1Isis.Basic().SetHostname("ixia-c-port2")
	p2d1Isis.Basic().SetLearnedLspFilter(true)

	// port 2 device 1 isis advance
	p2d1Isis.Advanced().SetAreaAddresses([]string{"490001"})
	p2d1Isis.Advanced().SetEnableAttachedBit(false)

	// Enable Graceful restart & helper mode on IS-IS Router on Port2.
	p1d1Isis.GracefulRestart().SetHelperMode(true)

	// port 2 device 1 isis interface
	p2d1IsisIntf := p2d1Isis.Interfaces().Add().
		SetEthName(p2d1Eth.Name()).
		SetNetworkType("point_to_point").
		SetLevelType(gosnappi.IsisInterfaceLevelType.LEVEL_2).
		SetMetric(10).
		SetName("p2d1IsisIntf")

	//l2 Settings
	p2d1IsisIntf.L2Settings().
		SetDeadInterval(30).
		SetHelloInterval(10).
		SetPriority(0)
	p2d1IsisIntf.
		Advanced().SetAutoAdjustSupportedProtocols(true)

	// port 2 device 1 isis v4 routes
	p2d1Isisv4routes := p2d1Isis.
		V4Routes().
		Add().
		SetName("p2d1IsisIpv4").
		SetLinkMetric(10).
		SetOriginType(gosnappi.IsisV4RouteRangeOriginType.INTERNAL)
	p2d1Isisv4routes.Addresses().Add().
		SetAddress("20.20.20.1").
		SetPrefix(32).
		SetCount(1).
		SetStep(1)

	// P1 ---> P2
	f1 := config.Flows().Add().SetName("f1:p1->p2")
	f1.Metrics().SetEnable(true)
	f1.Size().SetFixed(300)
	f1.Rate().SetPps(100)
	f1.Duration().FixedPackets().SetPackets(1000)
	f1.
		TxRx().Device().
		SetTxNames([]string{p1d1Isisv4routes.Name()}).
		SetRxNames([]string{p2d1Isisv4routes.Name()})

	f1Eth := f1.Packet().Add().Ethernet()
	f1Eth.Src().SetValue(p1d1Eth.Mac())
	f1Eth.Dst().Auto()

	f1Ip := f1.Packet().Add().Ipv4()
	f1Ip.Src().SetValue("10.10.10.1")
	f1Ip.Dst().SetValue("20.20.20.1")

	// // P2 ---> P1
	f2 := config.Flows().Add().SetName("f2:p2->p1")
	f2.Metrics().SetEnable(true)
	f2.Size().SetFixed(300)
	f2.Rate().SetPps(100)
	f2.Duration().FixedPackets().SetPackets(1000)
	f2.
		TxRx().Device().
		SetTxNames([]string{p2d1Isisv4routes.Name()}).
		SetRxNames([]string{p1d1Isisv4routes.Name()})

	f2Eth := f2.Packet().Add().Ethernet()
	f2Eth.Src().SetValue(p2d1Eth.Mac())
	f2Eth.Dst().Auto()

	f2Ip := f2.Packet().Add().Ipv4()
	f2Ip.Src().SetValue("20.20.20.1")
	f2Ip.Dst().SetValue("10.10.10.1")

	return config
}

// Go test function showing Graceful Restart Trigger
func TestPdpIsisGR(t *testing.T) {
	
        .................................................
       ...................................................
	grAction := gosnappi.NewControlAction()
	isisRestart := grAction.Protocol().Isis().InitiateRestart()
	routerName := []string{"p1d1Isis"}
	isisRestart.SetRouterNames(routerName)
	unplanned := isisRestart.Unplanned()
	unplanned.SetHoldingTime(30)
	unplanned.SetRestartAfter(20)

	if _, err := client.Api().SetControlAction(grAction); err != nil {
		t.Fatal(err)
	}
       .................................................
       ...................................................
}

…odels into isis-gr

apratimmukherjee

In general , looks as per last discussion.
Some more clarifications esp. in descriptions might be needed.

control/isis.yaml

result/isisiihs.yaml

apratimmukherjee · 2025-05-05T04:55:49Z

result/isisiihs.yaml

+              x-field-uid: 3
+        last_lsdb_syncup_time:
+          description: >-
+            The time is taken to sync up the LSDB. 


Good to specify that this means and unit of time. e.g might be time taken from adjacency being declared to be in Up state till all LSPs or CSNPs have been acknowledged ? Not sure , what is the exact thing an implementation will be measuring here is needed for clarity in the description. Otherwise not clear on what needs to be done for publishing this information.

result/isisiihs.yaml

…odels into isis-gr

apratimmukherjee · 2025-05-06T10:57:19Z

control/isis.yaml

+        unplanned:
+          $ref: "#/components/schemas/Isis.Action.Protocol.Isis.UnplannedRestart"
+          x-field-uid: 3
+        supress_adjacency:


apratimmukherjee · 2025-05-06T10:57:27Z

control/isis.yaml

+          $ref: "#/components/schemas/Isis.Action.Protocol.Isis.UnplannedRestart"
+          x-field-uid: 3
+        supress_adjacency:
+          $ref: "#/components/schemas/Isis.Action.Protocol.Isis.SupressAdjacency"


apratimmukherjee · 2025-05-06T11:06:24Z

control/isis.yaml

+          x-field-uid: 1
+        restart_after:
+          description: >-
+            Time (in seconds) after which the actually restart will be initiated in IIH with Restart Tlv having RR bit set.


This should result in IIH to be Txed indicating restart is Completed , not started i.e. RR bit is cleared and hold_timer is reset to normal.

apratimmukherjee · 2025-05-06T11:08:09Z

control/isis.yaml

+        Initiates IS-IS Unplanned Graceful Restart process for the selected IS-IS routers.
+        If no name is specified then Graceful Restart will be sent to all configured IS-IS routers.
+        When an emulated IS-IS router is in the unplanned "Restarting" mode,
+        it sends to the neighbor router (DUT) an IIH containing a Restart TLV with the RR (Restart Request) bit set.


sit and hold_time updated to as specified by user to indicate the maximum time within which this router or routers will complete the graceful restart.

apratimmukherjee · 2025-05-08T12:58:28Z

control/isis.yaml

+        Container of the configuration for the initiation of IS-IS Graceful Restart.
+        Timers T1 and T2 are used both by a restarting router and a starting router. Timer T3 is used only by a restarting router.
+        - Timer T1 is maintained per interface and indicates the time after which an unacknowledged (re)start attempt will be repeated. Its value is 3 seconds.
+        - Timer T2 is maintained for each LSP database (LSPDB) for Level 1 and Level 2. Default value is 60 seconds.


LSPDB -> LSDB

If this expired, what should the impl. do ?

apratimmukherjee · 2025-05-08T13:50:08Z

result/isisiihs.yaml

+      description: >-
+        This object contains the status of the last attempted Graceful Restart status of this router.
+      type: object
+      properties:


choice:
pass
pass.l1sync ( 0 or value = CSNP + LSP done )
.l2sync
. adj_bringup_time
fail
. reason ( sync ... no adj)
not_applicable ( GR trigger not given or GR is still in progress )

apratimmukherjee · 2025-05-08T13:50:42Z

result/isisiihs.yaml

+        l1_lsdb_syncup_time:
+          description: >-
+            The actual value of T2 timer (in second) is taken to synchronize the L1 LSDB by this Restarting router.
+            By this time, router deletes the T1 timers on all the interfaces and the CSNP list is cleared and all LSPs are collected.


T2 and T1 references not needed.

apratimmukherjee · 2025-05-08T13:53:08Z

result/isisiihs.yaml

+            The time (in second) is taken to bring up adjacency by the Restarting Neighbor.
+            The time is counted by a Helper router when the Restart TLV with RR bit set in a IIH PDU is received
+            and till it receives the Restart TLV with RR bit unset in a IIH PDU from the Neighbor Router.
+          type: integer


The time is measured from when the Restart TLV with RR bit set in a IIH PDU is received up to the time when it receives the Restart TLV with RR bit and SA bit unset in a IIH PDU from the Neighbor Router.

apratimmukherjee · 2025-05-08T13:58:44Z

result/isisiihs.yaml

+      properties:
+        l1_lsdb_syncup_time:
+          description: >-
+            The minimum time in second is taken to sync up the L1 LSDB by the Restarting Neighbor.


This is not as accurate as for local so better to remove these.

apratimmukherjee · 2025-05-08T14:00:31Z

result/states.yaml

+          x-field-uid: 13
+        isis_iihs:


isis_adjacencies

SuryyaKrJana and others added 4 commits April 21, 2025 12:55

IS-IS Graceful Support

97ab9a0

Update auto generated content

3f71708

changing towards open config

1b6e286

Update auto generated content

18aca5d

SuryyaKrJana self-assigned this Apr 22, 2025

SuryyaKrJana added the enhancement New feature or request label Apr 22, 2025

SuryyaKrJana requested review from alakendu, apratimmukherjee and Azharkuntoji April 22, 2025 07:25

SuryyaKrJana and others added 12 commits April 22, 2025 16:46

adding starting trigger

6bb1ee6

Merge branch 'isis-gr' of https://github.com/open-traffic-generator/m…

6af7c4c

…odels into isis-gr

Update auto generated content

503fe79

updating after changing the model in configuration and get state

94b6561

Update auto generated content

515ea84

minor reference correction in Get state IIH

b9d7a63

Merge branch 'isis-gr' of https://github.com/open-traffic-generator/m…

f71ec60

…odels into isis-gr

Update auto generated content

72d6707

isis IIH Get state name change

4fb74dd

Update auto generated content

91ad035

merging from master

d5f6404

Update auto generated content

b31c4c3

apratimmukherjee reviewed May 5, 2025

View reviewed changes

SuryyaKrJana and others added 8 commits May 6, 2025 11:33

more clarify on get gracefull restart get state

fc218c3

Update auto generated content

93a9bdf

cleanup

7e13610

Merge branch 'isis-gr' of https://github.com/open-traffic-generator/m…

bb50993

…odels into isis-gr

Update auto generated content

633fdc6

further improvement of the model

1308161

Merge branch 'isis-gr' of https://github.com/open-traffic-generator/m…

72ba9a9

…odels into isis-gr

Update auto generated content

d886383

SuryyaKrJana and others added 9 commits May 7, 2025 12:27

adding stats for gr

d48fd13

Merge branch 'isis-gr' of https://github.com/open-traffic-generator/m…

1d0f9ad

…odels into isis-gr

Update auto generated content

363573b

updated get stats

45b03be

Merge branch 'isis-gr' of https://github.com/open-traffic-generator/m…

eee7ab2

…odels into isis-gr

Update auto generated content

f23f839

updated some description

de68ca2

Merge branch 'isis-gr' of https://github.com/open-traffic-generator/m…

c007e21

…odels into isis-gr

Update auto generated content

b3513ea

apratimmukherjee reviewed May 8, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IS-IS Graceful Support #423

IS-IS Graceful Support #423

SuryyaKrJana commented Apr 21, 2025 •

edited

Loading

apratimmukherjee left a comment

apratimmukherjee May 5, 2025

apratimmukherjee May 6, 2025

apratimmukherjee May 6, 2025

apratimmukherjee May 6, 2025

apratimmukherjee May 6, 2025

apratimmukherjee May 8, 2025

apratimmukherjee May 8, 2025

apratimmukherjee May 8, 2025

apratimmukherjee May 8, 2025

apratimmukherjee May 8, 2025

apratimmukherjee May 8, 2025

apratimmukherjee May 8, 2025

IS-IS Graceful Support #423

Are you sure you want to change the base?

IS-IS Graceful Support #423

Conversation

SuryyaKrJana commented Apr 21, 2025 • edited Loading

apratimmukherjee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SuryyaKrJana commented Apr 21, 2025 •

edited

Loading