https://telecominfraproject.atlassian.net/browse/WIFI-12692

Signed-off-by: stephb9959 <[email protected]>
Telecominfraproject · Oct 19, 2023 · 14f63cb · 14f63cb
1 parent 0962c83
commit 14f63cb
Show file tree

Hide file tree

Showing 7 changed files with 426 additions and 12 deletions.
diff --git a/PROTOCOL.md b/PROTOCOL.md
@@ -861,32 +861,36 @@ The device should answer:
 
 ##### Kick
 ```json
-{     "action" : "kick" ,
+{     
+      "action" : "kick" ,
       "addr" : <mac if the client that shall be kicked> ,
-      "reson": <number>, (default: 5, https://www.cisco.com/assets/sol/sb/WAP371_Emulators/WAP371_Emulator_v1-0-1-5/help/Apx_ReasonCodes2.html)
+      "reason": <number>, (default: 5, https://www.cisco.com/assets/sol/sb/WAP371_Emulators/WAP371_Emulator_v1-0-1-5/help/Apx_ReasonCodes2.html)
       "ban_time": <number> (seconds, optional)
 }
 ```
 
 ##### Channel Switch Announcement
 ```json
-{   "action" : "channel_switch" ,
+{   
+    "action" : "channel_switch" ,
     "bssid" : <mac of the SSID> , (all other SSIDs on the same radio will perform the same action)
     "channel" : <number> (HT/HW mode will be retained upon issuing the CSA)
 }
 ```
 
 ##### Change TX-Power
 ```json
-{   "action" : "tx_power" ,
+{   
+    "action" : "tx_power" ,
     "bssid" : <mac of the SSID> , (all other SSIDs on the same radio will perform the same action)
     "level" : <number> (DBm inside the positive number space)
 }
 ```
 
 ##### Beacon Scan
 ```json
-{   "action" : "beacon_request" ,
+{   
+    "action" : "beacon_request" ,
     "addr" : <mac if the client that shall perform the scan> ,
     "ssid": <string>, (the SSID the client shall scan for on all frequencies),
     "channel": <number> (the channel that shall be scanned)
@@ -895,15 +899,17 @@ The device should answer:
 
 ##### BSS Transition
 ```json
-{   "action" : "bss_transition" ,
+{   
+    "action" : "bss_transition" ,
     "addr" : <mac if the client that shall perform the roam> ,
     "neighbors": [ <string> ], (an array of BSSIDs the client shall consider as roamin candidates)
 }
 ```
 
 ##### Update neighbours
 ```json
-{   "action" : "neighbors" ,
+{   
+    "action" : "neighbors" ,
     "bssid" : <mac of the SSID> , (the SSID of the specific VAP)
     "neighbors": [ [ <BSS>, <ssid>, <neighbor report> ] ]
 }

diff --git a/openapi/owgw.yaml b/openapi/owgw.yaml
@@ -903,6 +903,106 @@ components:
             kafkaClients:
               type: integer
 
+    RRM_Kick:
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+            - kick
+        addr:
+          type: string
+          format: mac
+        reason:
+          type: integer
+          default: 5
+        ban_time:
+          type: integer
+          format: int64
+
+    RRM_channel_switch:
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+            - channel_switch
+        bssid:
+          type: string
+          format: mac
+        channel:
+          type: integer
+
+    RRM_tx_power:
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+            - tx_power
+        bssid:
+          type: string
+          format: mac
+        level:
+          type: integer
+
+    RRM_beacon_request:
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+            - beacon_request
+        addr:
+          type: string
+          format: mac
+        ssid:
+          type: string
+        channel:
+          type: integer
+
+    RRM_bss_transition:
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+            - bss_transition
+        addr:
+          type: string
+          format: mac
+        neighbors:
+          type: array
+          items:
+            type: string
+            format: mac
+
+    RRM_neighbors:
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+            - neighbors
+        bssid:
+          type: string
+          format: mac
+        neighbors:
+          type: array
+          items:
+            type: string
+            format: mac
+
+    RRM_action:
+      type: object
+      oneOf:
+        - $ref: '#/components/schemas/RRM_Kick'
+        - $ref: '#/components/schemas/RRM_channel_switch'
+        - $ref: '#/components/schemas/RRM_tx_power'
+        - $ref: '#/components/schemas/RRM_beacon_request'
+        - $ref: '#/components/schemas/RRM_bss_transition'
+        - $ref: '#/components/schemas/RRM_neighbors'
+
     #########################################################################################
     ##
     ## These are endpoints that all services in the uCentral stack must provide
@@ -1435,6 +1535,28 @@ components:
         userName:
           type: string
 
+    DeviceTransferRequest:
+      type: object
+      properties:
+        serialNumber:
+          type: string
+          format: uuid
+        server:
+          type: string
+          format: hostname
+        port:
+          type: integer
+          format: int32
+
+    DeviceCertificateUpdateRequest:
+      type: object
+      properties:
+        serialNumber:
+          type: string
+          format: uuid
+        encodedCertificate:
+          type: string
+          format: base64
 
 paths:
   /devices:
@@ -2790,6 +2912,90 @@ paths:
         404:
           $ref: '#/components/responses/NotFound'
 
+  /device/{serialNumber}/rrm:
+    post:
+      tags:
+        - Commands
+      summary: Send RRM commands to a device.
+      operationId: sendRRMcommandsForADevice
+      parameters:
+        - in: path
+          name: serialNumber
+          schema:
+            type: string
+          required: true
+      requestBody:
+        description: Commands to send
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/RRM_action'
+      responses:
+        200:
+          $ref: '#/components/responses/Success'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+
+  /device/{serialNumber}/transfer:
+    post:
+      tags:
+        - Commands
+      summary: Transfer a device to a new redirector.
+      operationId: transferDevice
+      parameters:
+        - in: path
+          name: serialNumber
+          schema:
+            type: string
+          required: true
+      requestBody:
+        description: Transfer details
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/DeviceTransferRequest'
+      responses:
+        200:
+          $ref: '#/components/responses/Success'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+
+  /device/{serialNumber}/certupdate:
+    post:
+      tags:
+        - Commands
+      summary: Update the certificates for a device.
+      operationId: updateCertificates
+      parameters:
+        - in: path
+          name: serialNumber
+          schema:
+            type: string
+          required: true
+      requestBody:
+        description: Certificate update details
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '#/components/schemas/DeviceCertificateUpdateRequest'
+      responses:
+        200:
+          $ref: '#/components/responses/Success'
+        403:
+          $ref: '#/components/responses/Unauthorized'
+        404:
+          $ref: '#/components/responses/NotFound'
+
   /ouis:
     get:
       tags:
@@ -3296,8 +3502,6 @@ paths:
         404:
           $ref: '#/components/responses/NotFound'
 
-
-
   /deviceDashboard:
     get:
       tags: