Skip to content

Commit ad1593c

Browse files
author
HHDocs
committed
Deployed 5f539ed to dev with MkDocs 1.6.1 and mike 2.1.3
1 parent d284dee commit ad1593c

File tree

4 files changed

+212
-4
lines changed

4 files changed

+212
-4
lines changed

dev/known-limitations/known-limitations/index.html

Lines changed: 105 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1546,6 +1546,48 @@
15461546
</ul>
15471547
</nav>
15481548

1549+
</li>
1550+
1551+
<li class="md-nav__item">
1552+
<a href="#breakout-and-cmis-transceiver-initialization-issues-on-ds5000" class="md-nav__link">
1553+
<span class="md-ellipsis">
1554+
Breakout and CMIS transceiver initialization issues on DS5000
1555+
</span>
1556+
</a>
1557+
1558+
<nav class="md-nav" aria-label="Breakout and CMIS transceiver initialization issues on DS5000">
1559+
<ul class="md-nav__list">
1560+
1561+
<li class="md-nav__item">
1562+
<a href="#diagnosing-the-issue_1" class="md-nav__link">
1563+
<span class="md-ellipsis">
1564+
Diagnosing the issue
1565+
</span>
1566+
</a>
1567+
1568+
</li>
1569+
1570+
<li class="md-nav__item">
1571+
<a href="#resolution" class="md-nav__link">
1572+
<span class="md-ellipsis">
1573+
Resolution
1574+
</span>
1575+
</a>
1576+
1577+
</li>
1578+
1579+
<li class="md-nav__item">
1580+
<a href="#additional-guidance" class="md-nav__link">
1581+
<span class="md-ellipsis">
1582+
Additional guidance
1583+
</span>
1584+
</a>
1585+
1586+
</li>
1587+
1588+
</ul>
1589+
</nav>
1590+
15491591
</li>
15501592

15511593
</ul>
@@ -1829,6 +1871,48 @@
18291871
</ul>
18301872
</nav>
18311873

1874+
</li>
1875+
1876+
<li class="md-nav__item">
1877+
<a href="#breakout-and-cmis-transceiver-initialization-issues-on-ds5000" class="md-nav__link">
1878+
<span class="md-ellipsis">
1879+
Breakout and CMIS transceiver initialization issues on DS5000
1880+
</span>
1881+
</a>
1882+
1883+
<nav class="md-nav" aria-label="Breakout and CMIS transceiver initialization issues on DS5000">
1884+
<ul class="md-nav__list">
1885+
1886+
<li class="md-nav__item">
1887+
<a href="#diagnosing-the-issue_1" class="md-nav__link">
1888+
<span class="md-ellipsis">
1889+
Diagnosing the issue
1890+
</span>
1891+
</a>
1892+
1893+
</li>
1894+
1895+
<li class="md-nav__item">
1896+
<a href="#resolution" class="md-nav__link">
1897+
<span class="md-ellipsis">
1898+
Resolution
1899+
</span>
1900+
</a>
1901+
1902+
</li>
1903+
1904+
<li class="md-nav__item">
1905+
<a href="#additional-guidance" class="md-nav__link">
1906+
<span class="md-ellipsis">
1907+
Additional guidance
1908+
</span>
1909+
</a>
1910+
1911+
</li>
1912+
1913+
</ul>
1914+
</nav>
1915+
18321916
</li>
18331917

18341918
</ul>
@@ -1862,6 +1946,7 @@ <h1 id="known-limitations">Known Limitations</h1>
18621946
<li><a href="#configuration-not-allowed-when-port-is-member-of-portchannel">Configuration not allowed when port is member of PortChannel</a></li>
18631947
<li><a href="#external-peering-over-a-connection-originating-from-an-mclag-switch-can-fail"><abbr title="Definition of the &quot;external system&quot; to peer with (could be one or multiple devices such as edge/provider routers)">External</abbr> peering over a connection originating from an MCLAG switch can fail</a></li>
18641948
<li><a href="#mesh-limitations-on-th5-based-devices">Mesh limitations on TH5-based devices</a></li>
1949+
<li><a href="#breakout-and-cmis-transceiver-initialization-issues-on-ds5000">Breakout and CMIS transceiver initialization issues on DS5000</a></li>
18651950
</ul>
18661951
<h3 id="deleting-a-vpc-and-creating-a-new-one-right-away-can-cause-the-agent-to-fail">Deleting a <abbr title="Virtual Private Cloud, similar to the public cloud VPC it provides an isolated private network for the resources with support for multiple subnets each with user-provided VLANs and on-demand DHCP">VPC</abbr> and creating a new one right away can cause the agent to fail</h3>
18671952
<p>The issue is due to limitations in SONiC's gNMI interface. In this particular case,
@@ -1923,6 +2008,25 @@ <h4 id="known-workarounds_3">Known workarounds</h4>
19232008
<p>None. We recommend avoiding mesh topologies on TH5-based devices for the
19242009
time being, with the exception of 2-node topologies without gateway, where
19252010
the above issues would not apply.</p>
2011+
<h3 id="breakout-and-cmis-transceiver-initialization-issues-on-ds5000">Breakout and CMIS transceiver initialization issues on DS5000</h3>
2012+
<p>On Celestica DS5000 devices, certain transceivers using the Common Management Interface Specification (CMIS) fail to initialize properly under specific conditions.</p>
2013+
<p>CMIS is an open standard for managing high-speed pluggable transceivers, providing a uniform way for the network operating system to interact with and monitor them.</p>
2014+
<h4 id="diagnosing-the-issue_1">Diagnosing the issue</h4>
2015+
<p>If you breakout a port (for example, changing from 1x800G to 2x400G or 8x100G) while no transceiver is present, and then insert a transceiver afterward, initialization may fail and the transceiver may be missing or appear as failed in SONiC.</p>
2016+
<p>This occurs because SONiC did not always correctly reinitialize hardware abstraction for the port after breakout and re-insertion in this scenario, especially affecting CMIS modules.</p>
2017+
<h4 id="resolution">Resolution</h4>
2018+
<ul>
2019+
<li>The Hedgehog Fabric agent now automatically patches <code>/usr/share/sonic/platform/pddf/pddf-device.json</code> as needed after NOS installation (the patch is indicated by <code>-hh1</code> in the description). No user action is required to apply this workaround.</li>
2020+
<li>A full switch reboot is still required after agent deployment for the patch to take effect.</li>
2021+
<li>The <code>REBOOTREQ</code> column for the agent object in <code>kubectl</code> or <code>k9s</code> will indicate if a reboot is needed.</li>
2022+
<li>If you encounter existing transceiver failures (such as after an upgrade), a full power cycle of the switch, sometimes referred as cold boot, may still be required in addition to the reboot.</li>
2023+
</ul>
2024+
<h4 id="additional-guidance">Additional guidance</h4>
2025+
<ul>
2026+
<li>Prefer inserting transceivers before breaking out ports to avoid the issue altogether, if possible.</li>
2027+
<li>Always follow any REBOOTREQ status after upgrades or configuration changes.</li>
2028+
<li>If problems persist, perform a full power cycle as a last resort.</li>
2029+
</ul>
19262030

19272031

19282032

@@ -1945,7 +2049,7 @@ <h4 id="known-workarounds_3">Known workarounds</h4>
19452049
<span class="md-icon" title="Last update">
19462050
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
19472051
</span>
1948-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 20, 2025</span>
2052+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 9, 2025</span>
19492053
</span>
19502054

19512055

dev/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

master/known-limitations/known-limitations/index.html

Lines changed: 105 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1546,6 +1546,48 @@
15461546
</ul>
15471547
</nav>
15481548

1549+
</li>
1550+
1551+
<li class="md-nav__item">
1552+
<a href="#breakout-and-cmis-transceiver-initialization-issues-on-ds5000" class="md-nav__link">
1553+
<span class="md-ellipsis">
1554+
Breakout and CMIS transceiver initialization issues on DS5000
1555+
</span>
1556+
</a>
1557+
1558+
<nav class="md-nav" aria-label="Breakout and CMIS transceiver initialization issues on DS5000">
1559+
<ul class="md-nav__list">
1560+
1561+
<li class="md-nav__item">
1562+
<a href="#diagnosing-the-issue_1" class="md-nav__link">
1563+
<span class="md-ellipsis">
1564+
Diagnosing the issue
1565+
</span>
1566+
</a>
1567+
1568+
</li>
1569+
1570+
<li class="md-nav__item">
1571+
<a href="#resolution" class="md-nav__link">
1572+
<span class="md-ellipsis">
1573+
Resolution
1574+
</span>
1575+
</a>
1576+
1577+
</li>
1578+
1579+
<li class="md-nav__item">
1580+
<a href="#additional-guidance" class="md-nav__link">
1581+
<span class="md-ellipsis">
1582+
Additional guidance
1583+
</span>
1584+
</a>
1585+
1586+
</li>
1587+
1588+
</ul>
1589+
</nav>
1590+
15491591
</li>
15501592

15511593
</ul>
@@ -1829,6 +1871,48 @@
18291871
</ul>
18301872
</nav>
18311873

1874+
</li>
1875+
1876+
<li class="md-nav__item">
1877+
<a href="#breakout-and-cmis-transceiver-initialization-issues-on-ds5000" class="md-nav__link">
1878+
<span class="md-ellipsis">
1879+
Breakout and CMIS transceiver initialization issues on DS5000
1880+
</span>
1881+
</a>
1882+
1883+
<nav class="md-nav" aria-label="Breakout and CMIS transceiver initialization issues on DS5000">
1884+
<ul class="md-nav__list">
1885+
1886+
<li class="md-nav__item">
1887+
<a href="#diagnosing-the-issue_1" class="md-nav__link">
1888+
<span class="md-ellipsis">
1889+
Diagnosing the issue
1890+
</span>
1891+
</a>
1892+
1893+
</li>
1894+
1895+
<li class="md-nav__item">
1896+
<a href="#resolution" class="md-nav__link">
1897+
<span class="md-ellipsis">
1898+
Resolution
1899+
</span>
1900+
</a>
1901+
1902+
</li>
1903+
1904+
<li class="md-nav__item">
1905+
<a href="#additional-guidance" class="md-nav__link">
1906+
<span class="md-ellipsis">
1907+
Additional guidance
1908+
</span>
1909+
</a>
1910+
1911+
</li>
1912+
1913+
</ul>
1914+
</nav>
1915+
18321916
</li>
18331917

18341918
</ul>
@@ -1862,6 +1946,7 @@ <h1 id="known-limitations">Known Limitations</h1>
18621946
<li><a href="#configuration-not-allowed-when-port-is-member-of-portchannel">Configuration not allowed when port is member of PortChannel</a></li>
18631947
<li><a href="#external-peering-over-a-connection-originating-from-an-mclag-switch-can-fail"><abbr title="Definition of the &quot;external system&quot; to peer with (could be one or multiple devices such as edge/provider routers)">External</abbr> peering over a connection originating from an MCLAG switch can fail</a></li>
18641948
<li><a href="#mesh-limitations-on-th5-based-devices">Mesh limitations on TH5-based devices</a></li>
1949+
<li><a href="#breakout-and-cmis-transceiver-initialization-issues-on-ds5000">Breakout and CMIS transceiver initialization issues on DS5000</a></li>
18651950
</ul>
18661951
<h3 id="deleting-a-vpc-and-creating-a-new-one-right-away-can-cause-the-agent-to-fail">Deleting a <abbr title="Virtual Private Cloud, similar to the public cloud VPC it provides an isolated private network for the resources with support for multiple subnets each with user-provided VLANs and on-demand DHCP">VPC</abbr> and creating a new one right away can cause the agent to fail</h3>
18671952
<p>The issue is due to limitations in SONiC's gNMI interface. In this particular case,
@@ -1923,6 +2008,25 @@ <h4 id="known-workarounds_3">Known workarounds</h4>
19232008
<p>None. We recommend avoiding mesh topologies on TH5-based devices for the
19242009
time being, with the exception of 2-node topologies without gateway, where
19252010
the above issues would not apply.</p>
2011+
<h3 id="breakout-and-cmis-transceiver-initialization-issues-on-ds5000">Breakout and CMIS transceiver initialization issues on DS5000</h3>
2012+
<p>On Celestica DS5000 devices, certain transceivers using the Common Management Interface Specification (CMIS) fail to initialize properly under specific conditions.</p>
2013+
<p>CMIS is an open standard for managing high-speed pluggable transceivers, providing a uniform way for the network operating system to interact with and monitor them.</p>
2014+
<h4 id="diagnosing-the-issue_1">Diagnosing the issue</h4>
2015+
<p>If you breakout a port (for example, changing from 1x800G to 2x400G or 8x100G) while no transceiver is present, and then insert a transceiver afterward, initialization may fail and the transceiver may be missing or appear as failed in SONiC.</p>
2016+
<p>This occurs because SONiC did not always correctly reinitialize hardware abstraction for the port after breakout and re-insertion in this scenario, especially affecting CMIS modules.</p>
2017+
<h4 id="resolution">Resolution</h4>
2018+
<ul>
2019+
<li>The Hedgehog Fabric agent now automatically patches <code>/usr/share/sonic/platform/pddf/pddf-device.json</code> as needed after NOS installation (the patch is indicated by <code>-hh1</code> in the description). No user action is required to apply this workaround.</li>
2020+
<li>A full switch reboot is still required after agent deployment for the patch to take effect.</li>
2021+
<li>The <code>REBOOTREQ</code> column for the agent object in <code>kubectl</code> or <code>k9s</code> will indicate if a reboot is needed.</li>
2022+
<li>If you encounter existing transceiver failures (such as after an upgrade), a full power cycle of the switch, sometimes referred as cold boot, may still be required in addition to the reboot.</li>
2023+
</ul>
2024+
<h4 id="additional-guidance">Additional guidance</h4>
2025+
<ul>
2026+
<li>Prefer inserting transceivers before breaking out ports to avoid the issue altogether, if possible.</li>
2027+
<li>Always follow any REBOOTREQ status after upgrades or configuration changes.</li>
2028+
<li>If problems persist, perform a full power cycle as a last resort.</li>
2029+
</ul>
19262030

19272031

19282032

@@ -1945,7 +2049,7 @@ <h4 id="known-workarounds_3">Known workarounds</h4>
19452049
<span class="md-icon" title="Last update">
19462050
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
19472051
</span>
1948-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 20, 2025</span>
2052+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">December 9, 2025</span>
19492053
</span>
19502054

19512055

master/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)