Skip to content

Manually override HW switchover for planned operation #2210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Manually override HW switchover for planned operation #2210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a78c1c9
Manually override HW switchover for planned operation
chikkaiah-work Sep 22, 2025
52a66a8
change name from bacup to standby
chikkaiah-work Oct 1, 2025
04ced2f
fixes
chikkaiah-work Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions doc/SAI-Proposal-FRR.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,22 @@ typedef enum _sai_next_hop_group_type_t

} sai_next_hop_group_type_t;

+/**
+ * @brief Next hop group admin role to manually control switching between primary and backup, overriding hardware switchover
+ */
+typedef enum _sai_next_hop_group_admin_role_t
+{
+ /** Auto mode - hardware controlled switching (default) */
+ SAI_NEXT_HOP_GROUP_ADMIN_ROLE_AUTO,
+
+ /** Force primary role - manual override to primary */
+ SAI_NEXT_HOP_GROUP_ADMIN_ROLE_PRIMARY,
+
+ /** Force backup role - manual override to standby */
+ SAI_NEXT_HOP_GROUP_ADMIN_ROLE_STANDBY,
+
+} sai_next_hop_group_admin_role_t;

/**
* @brief Attribute id for next hop
*/
Expand Down Expand Up @@ -273,6 +289,20 @@ typedef enum _sai_next_hop_group_attr_t
+ * @validonly SAI_NEXT_HOP_GROUP_ATTR_TYPE == SAI_NEXT_HOP_GROUP_TYPE_PROTECTION
+ */
+ SAI_NEXT_HOP_GROUP_ATTR_SET_SWITCHOVER,
+
+ /**
+ * @brief Admin role to manually control switching between primary and backup
+ *
+ * This attribute allows manual switching between primary and standby roles,
+ * overriding hardware-controlled switching when not set to auto mode.
+ * Enables planned operations without any traffic loss.
+ *
+ * @type sai_next_hop_group_admin_role_t
+ * @flags CREATE_AND_SET
+ * @default SAI_NEXT_HOP_GROUP_ADMIN_ROLE_AUTO
+ * @validonly SAI_NEXT_HOP_GROUP_ATTR_TYPE == SAI_NEXT_HOP_GROUP_TYPE_HW_PROTECTION
+ */
+ SAI_NEXT_HOP_GROUP_ATTR_ADMIN_ROLE,

/**
* @brief End of attributes
Expand Down Expand Up @@ -560,6 +590,64 @@ for (attr_id = 0; attr_id < attr_count; attr_id++) {

```

## Manual Admin Role Control

### Force primary role
```
// Force the next hop group to use primary path regardless of hardware state
nhg_entry_attrs[1].id = SAI_NEXT_HOP_GROUP_ATTR_ADMIN_ROLE;
nhg_entry_attrs[1].value.u32 = SAI_NEXT_HOP_GROUP_ADMIN_ROLE_PRIMARY;
saistatus = sai_set_next_hop_group_attribute_fn(nhg_id, nhg_entry_attrs);
if (saistatus != SAI_STATUS_SUCCESS) {
return saistatus;
}

```

### Force standby role
```
// Force the next hop group to use backup path regardless of hardware state
nhg_entry_attrs[1].id = SAI_NEXT_HOP_GROUP_ATTR_ADMIN_ROLE;
nhg_entry_attrs[1].value.u32 = SAI_NEXT_HOP_GROUP_ADMIN_ROLE_STANDBY;
saistatus = sai_set_next_hop_group_attribute_fn(nhg_id, nhg_entry_attrs);
if (saistatus != SAI_STATUS_SUCCESS) {
return saistatus;
}

```

### Reset to auto mode
```
// Return control back to hardware-based switching
nhg_entry_attrs[1].id = SAI_NEXT_HOP_GROUP_ATTR_ADMIN_ROLE;
nhg_entry_attrs[1].value.u32 = SAI_NEXT_HOP_GROUP_ADMIN_ROLE_AUTO;
saistatus = sai_set_next_hop_group_attribute_fn(nhg_id, nhg_entry_attrs);
if (saistatus != SAI_STATUS_SUCCESS) {
return saistatus;
}

```

### Query current admin role
```
// Get the current admin role setting
nhg_entry_attrs[0].id = SAI_NEXT_HOP_GROUP_ATTR_ADMIN_ROLE;
saistatus = sai_get_next_hop_group_attribute_fn(nhg_id, 1, nhg_entry_attrs);
if (saistatus != SAI_STATUS_SUCCESS) {
return saistatus;
}

// Check the current admin role
if (nhg_entry_attrs[0].value.u32 == SAI_NEXT_HOP_GROUP_ADMIN_ROLE_AUTO) {
// Hardware-controlled switching is active
} else if (nhg_entry_attrs[0].value.u32 == SAI_NEXT_HOP_GROUP_ADMIN_ROLE_PRIMARY) {
// Forced to use primary path
} else if (nhg_entry_attrs[0].value.u32 == SAI_NEXT_HOP_GROUP_ADMIN_ROLE_STANDBY) {
// Forced to use backup path
}

```

# Pipeline

TBD
32 changes: 31 additions & 1 deletion inc/sainexthopgroup.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,22 @@ typedef enum _sai_next_hop_group_member_observed_role_t

} sai_next_hop_group_member_observed_role_t;

/**
* @brief Next hop group admin role to manually switch between primary and standby, overriding hardware switchover
*/
typedef enum _sai_next_hop_group_admin_role_t
{
/** Auto mode - hardware controlled switching (default) */
SAI_NEXT_HOP_GROUP_ADMIN_ROLE_AUTO,

/** Force primary role - manual override to primary */
SAI_NEXT_HOP_GROUP_ADMIN_ROLE_PRIMARY,

/** Force standby role - manual override to standby */
SAI_NEXT_HOP_GROUP_ADMIN_ROLE_STANDBY,

} sai_next_hop_group_admin_role_t;

/**
* @brief Attribute id for next hop
*/
Expand Down Expand Up @@ -143,6 +159,20 @@ typedef enum _sai_next_hop_group_attr_t
*/
SAI_NEXT_HOP_GROUP_ATTR_SET_SWITCHOVER,

/**
* @brief Admin role to manually control switching between primary and backup
*
* This attribute allows manual switching between primary and backup roles,
* overriding hardware-controlled switching.
* Enables planned operations without any traffic loss.
*
* @type sai_next_hop_group_admin_role_t
* @flags CREATE_AND_SET
* @default SAI_NEXT_HOP_GROUP_ADMIN_ROLE_AUTO
* @validonly SAI_NEXT_HOP_GROUP_ATTR_TYPE == SAI_NEXT_HOP_GROUP_TYPE_HW_PROTECTION
*/
SAI_NEXT_HOP_GROUP_ATTR_ADMIN_ROLE,

/**
* @brief Attach a counter
*
Expand Down Expand Up @@ -363,7 +393,7 @@ typedef enum _sai_next_hop_group_member_attr_t
/**
* @brief The actual role in protection group
*
* Should only be used if the type of owning group is SAI_NEXT_HOP_GROUP_TYPE_PROTECTION
* Should only be used if the type of owning group is SAI_NEXT_HOP_GROUP_TYPE_PROTECTION or SAI_NEXT_HOP_GROUP_TYPE_HW_PROTECTION
*
* @type sai_next_hop_group_member_observed_role_t
* @flags READ_ONLY
Expand Down