Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
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
138 changes: 138 additions & 0 deletions doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1413,6 +1413,10 @@ <h2>Table of Contents</h2>
<a href="#metalstack.api.v2.SwitchReplaceMode"><span class="badge">E</span>SwitchReplaceMode</a>
</li>

<li>
<a href="#metalstack.api.v2.SwitchType"><span class="badge">E</span>SwitchType</a>
</li>



</ul>
Expand Down Expand Up @@ -2030,6 +2034,14 @@ <h2>Table of Contents</h2>
<a href="#metalstack%2finfra%2fv2%2fswitch.proto">metalstack/infra/v2/switch.proto</a>
<ul>

<li>
<a href="#metalstack.infra.v2.BGPRoute"><span class="badge">M</span>BGPRoute</a>
</li>

<li>
<a href="#metalstack.infra.v2.LLDPNeighbor"><span class="badge">M</span>LLDPNeighbor</a>
</li>

<li>
<a href="#metalstack.infra.v2.SwitchServiceGetRequest"><span class="badge">M</span>SwitchServiceGetRequest</a>
</li>
Expand Down Expand Up @@ -11620,6 +11632,13 @@ <h3 id="metalstack.api.v2.Switch">Switch</h3>
<td><p>MachineConnections map machines to the nics they are connected to. </p></td>
</tr>

<tr>
<td>type</td>
<td><a href="#metalstack.api.v2.SwitchType">SwitchType</a></td>
<td></td>
<td><p>Type is the role of the switch. </p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -12021,6 +12040,47 @@ <h3 id="metalstack.api.v2.SwitchReplaceMode">SwitchReplaceMode</h3>
</tbody>
</table>

<h3 id="metalstack.api.v2.SwitchType">SwitchType</h3>
<p>SwitchType represents the role of a switch.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>SWITCH_TYPE_UNSPECIFIED</td>
<td>0</td>
<td><p>SWITCH_TYPE_UNSPECIFIED is not specified.</p></td>
</tr>

<tr>
<td>SWITCH_TYPE_LEAF</td>
<td>1</td>
<td><p>SWITCH_TYPE_LEAF is a leaf switch.</p></td>
</tr>

<tr>
<td>SWITCH_TYPE_EXIT</td>
<td>2</td>
<td><p>SWITCH_TYPE_EXIT is an exit switch.</p></td>
</tr>

<tr>
<td>SWITCH_TYPE_SPINE</td>
<td>3</td>
<td><p>SWITCH_TYPE_SPINE is a spine switch.</p></td>
</tr>

<tr>
<td>SWITCH_TYPE_MGMT</td>
<td>4</td>
<td><p>SWITCH_TYPE_MGMT is a switch used only for management tasks.</p></td>
</tr>

</tbody>
</table>




Expand Down Expand Up @@ -15894,6 +15954,70 @@ <h2 id="metalstack/infra/v2/switch.proto">metalstack/infra/v2/switch.proto</h2><
<p></p>


<h3 id="metalstack.infra.v2.BGPRoute">BGPRoute</h3>
<p>BGPRoute represents the route to a prefix.</p>


<table class="field-table">
<thead>
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>cidr</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>CIDR of the network that is routed to. </p></td>
</tr>

</tbody>
</table>





<h3 id="metalstack.infra.v2.LLDPNeighbor">LLDPNeighbor</h3>
<p>LLDPNeighbor contains details about a neighbor learned via LLDP.</p>


<table class="field-table">
<thead>
<tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>

<tr>
<td>remote_host</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>RemoteHost is the neighbor&#39;s name as given via &#39;System Name TLV&#39; field of a LLDP packet.
Usually this is simply the neighbor&#39;s hostname. </p></td>
</tr>

<tr>
<td>local_port</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>LocalPort is the name of the local port that is connected to the neighbor. </p></td>
</tr>

<tr>
<td>remote_port</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>RemotePort is the neighbor&#39;s port name as sent via `Port Description TLV`.
Don&#39;t mix it up with `Port ID TLV`. </p></td>
</tr>

</tbody>
</table>





<h3 id="metalstack.infra.v2.SwitchServiceGetRequest">SwitchServiceGetRequest</h3>
<p>SwitchServiceGetRequest.</p>

Expand Down Expand Up @@ -15987,6 +16111,20 @@ <h3 id="metalstack.infra.v2.SwitchServiceHeartbeatRequest">SwitchServiceHeartbea
<td><p>BgpPortStates maps port identifiers to the respective port&#39;s BGP state. </p></td>
</tr>

<tr>
<td>bgp_routes</td>
<td><a href="#metalstack.infra.v2.BGPRoute">BGPRoute</a></td>
<td>repeated</td>
<td><p>BGPRoutes collected on the switch. </p></td>
</tr>

<tr>
<td>lldp_neighbors</td>
<td><a href="#metalstack.infra.v2.LLDPNeighbor">LLDPNeighbor</a></td>
<td>repeated</td>
<td><p>LLDPNeighbors known to the switch. </p></td>
</tr>

</tbody>
</table>

Expand Down
Loading
Loading