Skip to content

Narrow down switch API. #193

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

Draft
Gerrit91 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Narrow down switch API. #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
126 changes: 101 additions & 25 deletions doc/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2843,6 +2843,10 @@ <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.SwitchRegisterNic"><span class="badge">M</span>SwitchRegisterNic</a>
</li>

<li>
<a href="#metalstack.infra.v2.SwitchServiceGetRequest"><span class="badge">M</span>SwitchServiceGetRequest</a>
</li>
Expand Down Expand Up @@ -18655,14 +18659,6 @@ <h3 id="metalstack.admin.v2.SwitchServiceUpdateRequest">SwitchServiceUpdateReque
<td><p>UpdateMeta contains the timestamp and strategy to be used in this update request. </p></td>
</tr>

<tr>
<td>updated_at</td>
<td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
<td><p>UpdatedAt is the date when this entity was updated.
Must be part of the update request to ensure optimistic locking. </p></td>
</tr>

<tr>
<td>description</td>
<td><a href="#string">string</a></td>
Expand Down Expand Up @@ -18698,20 +18694,6 @@ <h3 id="metalstack.admin.v2.SwitchServiceUpdateRequest">SwitchServiceUpdateReque
<td><p>ConsoleCommand is the command for accessing the switch&#39;s console. </p></td>
</tr>

<tr>
<td>nics</td>
<td><a href="#metalstack.api.v2.SwitchNic">metalstack.api.v2.SwitchNic</a></td>
<td>repeated</td>
<td><p>Nics are the front panel ports of the switch. </p></td>
</tr>

<tr>
<td>os</td>
<td><a href="#metalstack.api.v2.SwitchOS">metalstack.api.v2.SwitchOS</a></td>
<td>optional</td>
<td><p>SwitchOs is the OS running on the switch. </p></td>
</tr>

</tbody>
</table>

Expand Down Expand Up @@ -22675,6 +22657,44 @@ <h2 id="metalstack/infra/v2/switch.proto">metalstack/infra/v2/switch.proto</h2><
<p></p>


<h3 id="metalstack.infra.v2.SwitchRegisterNic">SwitchRegisterNic</h3>
<p>SwitchRegisterNic is the switch nic used when registering a switch at the api.</p>


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

<tr>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>Name of the switch port. </p></td>
</tr>

<tr>
<td>identifier</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>Identifier of the port. </p></td>
</tr>

<tr>
<td>state</td>
<td><a href="#metalstack.api.v2.NicState">metalstack.api.v2.NicState</a></td>
<td></td>
<td><p>NicState describes the current state of the switch port. </p></td>
</tr>

</tbody>
</table>





<h3 id="metalstack.infra.v2.SwitchServiceGetRequest">SwitchServiceGetRequest</h3>
<p>SwitchServiceGetRequest is the request payload for getting a switch.</p>

Expand Down Expand Up @@ -22886,10 +22906,66 @@ <h3 id="metalstack.infra.v2.SwitchServiceRegisterRequest">SwitchServiceRegisterR
<tbody>

<tr>
<td>switch</td>
<td><a href="#metalstack.api.v2.Switch">metalstack.api.v2.Switch</a></td>
<td>id</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>Switch to register. </p></td>
<td><p>Id of the switch. </p></td>
</tr>

<tr>
<td>meta</td>
<td><a href="#metalstack.api.v2.Meta">metalstack.api.v2.Meta</a></td>
<td></td>
<td><p>Meta for this switch. </p></td>
</tr>

<tr>
<td>rack</td>
<td><a href="#string">string</a></td>
<td>optional</td>
<td><p>Rack ID if the switch resides in a rack. </p></td>
</tr>

<tr>
<td>room</td>
<td><a href="#string">string</a></td>
<td>optional</td>
<td><p>Room ID if the switch resides in a room. </p></td>
</tr>

<tr>
<td>partition</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>Partition the switch belongs to. </p></td>
</tr>

<tr>
<td>management_ip</td>
<td><a href="#string">string</a></td>
<td></td>
<td><p>ManagementIp is the switch&#39;s IP for management access. </p></td>
</tr>

<tr>
<td>management_user</td>
<td><a href="#string">string</a></td>
<td>optional</td>
<td><p>ManagementUser is the user name to use for management access. </p></td>
</tr>

<tr>
<td>nics</td>
<td><a href="#metalstack.infra.v2.SwitchRegisterNic">SwitchRegisterNic</a></td>
<td>repeated</td>
<td><p>Nics are the front panel ports of the switch. </p></td>
</tr>

<tr>
<td>os</td>
<td><a href="#metalstack.api.v2.SwitchOS">metalstack.api.v2.SwitchOS</a></td>
<td></td>
<td><p>SwitchOs is the OS running on the switch. </p></td>
</tr>

</tbody>
Expand Down
Loading
Loading