ListNodes

Author: majst01

doc/index.html

@@ -1782,6 +1782,21 @@ <h2>Table of Contents</h2>
           </li>
 
 
+          <li>
+            <a href="#metalstack%2fapi%2fv2%2fvpn.proto">metalstack/api/v2/vpn.proto</a>
+            <ul>
+              
+                <li>
+                  <a href="#metalstack.api.v2.VPNNode"><span class="badge">M</span>VPNNode</a>
+                </li>
+              
+              
+              
+              
+            </ul>
+          </li>
+        
+          
           <li>
             <a href="#metalstack%2fadmin%2fv2%2fvpn.proto">metalstack/admin/v2/vpn.proto</a>
             <ul>
@@ -1794,6 +1809,14 @@ <h2>Table of Contents</h2>
                   <a href="#metalstack.admin.v2.VPNServiceAuthkeyResponse"><span class="badge">M</span>VPNServiceAuthkeyResponse</a>
                 </li>
 
+                <li>
+                  <a href="#metalstack.admin.v2.VPNServiceListNodesRequest"><span class="badge">M</span>VPNServiceListNodesRequest</a>
+                </li>
+              
+                <li>
+                  <a href="#metalstack.admin.v2.VPNServiceListNodesResponse"><span class="badge">M</span>VPNServiceListNodesResponse</a>
+                </li>
+              
 
 
 
@@ -14633,6 +14656,79 @@ <h3 id="metalstack.admin.v2.TokenService">TokenService</h3>
 
 
 
+      <div class="file-heading">
+        <h2 id="metalstack/api/v2/vpn.proto">metalstack/api/v2/vpn.proto</h2><a href="#title">Top</a>
+      </div>
+      <p></p>
+
+      
+        <h3 id="metalstack.api.v2.VPNNode">VPNNode</h3>
+        <p>VPNNode is a machine connected to the vpn</p>
+
+        
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+              
+                <tr>
+                  <td>id</td>
+                  <td><a href="#uint64">uint64</a></td>
+                  <td></td>
+                  <td><p>Id of this node </p></td>
+                </tr>
+              
+                <tr>
+                  <td>name</td>
+                  <td><a href="#string">string</a></td>
+                  <td></td>
+                  <td><p>Name of this node </p></td>
+                </tr>
+              
+                <tr>
+                  <td>user</td>
+                  <td><a href="#string">string</a></td>
+                  <td>optional</td>
+                  <td><p>User of this node, maps to a project </p></td>
+                </tr>
+              
+                <tr>
+                  <td>ip_addresses</td>
+                  <td><a href="#string">string</a></td>
+                  <td>repeated</td>
+                  <td><p>IPAddresses of this node in the vpn </p></td>
+                </tr>
+              
+                <tr>
+                  <td>last_seen</td>
+                  <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+                  <td></td>
+                  <td><p>LastSeen timestamp when this node reached out the the control plane </p></td>
+                </tr>
+              
+                <tr>
+                  <td>online</td>
+                  <td><a href="#bool">bool</a></td>
+                  <td></td>
+                  <td><p>Online indicates if this node is online </p></td>
+                </tr>
+              
+            </tbody>
+          </table>
+
+          
+
+        
+      
+
+      
+
+      
+
+      
+    
+      
       <div class="file-heading">
         <h2 id="metalstack/admin/v2/vpn.proto">metalstack/admin/v2/vpn.proto</h2><a href="#title">Top</a>
       </div>
@@ -14709,6 +14805,54 @@ <h3 id="metalstack.admin.v2.VPNServiceAuthkeyResponse">VPNServiceAuthkeyResponse
 
 
 
+        <h3 id="metalstack.admin.v2.VPNServiceListNodesRequest">VPNServiceListNodesRequest</h3>
+        <p>VPNServiceListNodesRequest is the request payload for a vpn list nodes request</p>
+
+        
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+              
+                <tr>
+                  <td>user</td>
+                  <td><a href="#string">string</a></td>
+                  <td>optional</td>
+                  <td><p>User if given only nodes of this user are returned </p></td>
+                </tr>
+              
+            </tbody>
+          </table>
+
+          
+
+        
+      
+        <h3 id="metalstack.admin.v2.VPNServiceListNodesResponse">VPNServiceListNodesResponse</h3>
+        <p>VPNServiceListNodesResponse is the response payload for a vpn list nodes request</p>
+
+        
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+              
+                <tr>
+                  <td>nodes</td>
+                  <td><a href="#metalstack.api.v2.VPNNode">metalstack.api.v2.VPNNode</a></td>
+                  <td>repeated</td>
+                  <td><p>Nodes connected to the vpn </p></td>
+                </tr>
+              
+            </tbody>
+          </table>
+
+          
+
+        
+      
 
 
 
@@ -14730,6 +14874,13 @@ <h3 id="metalstack.admin.v2.VPNService">VPNService</h3>
                 <td><p>AuthKey generates a authkey for a project to join a machine to the project vpn</p></td>
               </tr>
 
+              <tr>
+                <td>ListNodes</td>
+                <td><a href="#metalstack.admin.v2.VPNServiceListNodesRequest">VPNServiceListNodesRequest</a></td>
+                <td><a href="#metalstack.admin.v2.VPNServiceListNodesResponse">VPNServiceListNodesResponse</a></td>
+                <td><p>ListNodes returns a list of machines actually connected to the vpn</p></td>
+              </tr>
+            
           </tbody>
         </table>