Skip to content

Commit

Permalink
Update API docs and profiles
Browse files Browse the repository at this point in the history
(cherry picked from commit 6498844)
  • Loading branch information
Frostman committed Aug 14, 2024
1 parent 6c32973 commit 42bc89f
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 48 deletions.
3 changes: 3 additions & 0 deletions docs/reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1960,6 +1960,8 @@ _Appears in:_
| --- | --- | --- | --- |
| `speed` _[SwitchProfilePortProfileSpeed](#switchprofileportprofilespeed)_ | Speed defines the speed configuration for the profile, exclusive with breakout | | |
| `breakout` _[SwitchProfilePortProfileBreakout](#switchprofileportprofilebreakout)_ | Breakout defines the breakout configuration for the profile, exclusive with speed | | |
| `autoNegAllowed` _boolean_ | AutoNegAllowed defines if configuring auto-negotiation is allowed for the port | | |
| `autoNegDefault` _boolean_ | AutoNegDefault defines the default auto-negotiation state for the port | | |


#### SwitchProfilePortProfileBreakout
Expand Down Expand Up @@ -2112,6 +2114,7 @@ _Appears in:_
| `portGroupSpeeds` _object (keys:string, values:string)_ | PortGroupSpeeds is a map of port group speeds, key is the port group name, value is the speed, such as '"2": 10G' | | |
| `portSpeeds` _object (keys:string, values:string)_ | PortSpeeds is a map of port speeds, key is the port name, value is the speed | | |
| `portBreakouts` _object (keys:string, values:string)_ | PortBreakouts is a map of port breakouts, key is the port name, value is the breakout configuration, such as "1/55: 4x25G" | | |
| `portAutoNegs` _object (keys:string, values:boolean)_ | PortAutoNegs is a map of port auto negotiation, key is the port name, value is true or false | | |


#### SwitchStatus
Expand Down
96 changes: 48 additions & 48 deletions docs/reference/profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -439,54 +439,54 @@ Label column is a port label on a physical switch.
| Port | Label | Type | Group | Default | Supported |
|------|-------|------|-------|---------|-----------|
| M1 | | Management | | | |
| E1/1 | 1 | Direct | | 2.5G | 1G, 2.5G |
| E1/2 | 2 | Direct | | 2.5G | 1G, 2.5G |
| E1/3 | 3 | Direct | | 2.5G | 1G, 2.5G |
| E1/4 | 4 | Direct | | 2.5G | 1G, 2.5G |
| E1/5 | 5 | Direct | | 2.5G | 1G, 2.5G |
| E1/6 | 6 | Direct | | 2.5G | 1G, 2.5G |
| E1/7 | 7 | Direct | | 2.5G | 1G, 2.5G |
| E1/8 | 8 | Direct | | 2.5G | 1G, 2.5G |
| E1/9 | 9 | Direct | | 2.5G | 1G, 2.5G |
| E1/10 | 10 | Direct | | 2.5G | 1G, 2.5G |
| E1/11 | 11 | Direct | | 2.5G | 1G, 2.5G |
| E1/12 | 12 | Direct | | 2.5G | 1G, 2.5G |
| E1/13 | 13 | Direct | | 2.5G | 1G, 2.5G |
| E1/14 | 14 | Direct | | 2.5G | 1G, 2.5G |
| E1/15 | 15 | Direct | | 2.5G | 1G, 2.5G |
| E1/16 | 16 | Direct | | 2.5G | 1G, 2.5G |
| E1/17 | 17 | Direct | | 2.5G | 1G, 2.5G |
| E1/18 | 18 | Direct | | 2.5G | 1G, 2.5G |
| E1/19 | 19 | Direct | | 2.5G | 1G, 2.5G |
| E1/20 | 20 | Direct | | 2.5G | 1G, 2.5G |
| E1/21 | 21 | Direct | | 2.5G | 1G, 2.5G |
| E1/22 | 22 | Direct | | 2.5G | 1G, 2.5G |
| E1/23 | 23 | Direct | | 2.5G | 1G, 2.5G |
| E1/24 | 24 | Direct | | 2.5G | 1G, 2.5G |
| E1/25 | 25 | Direct | | 2.5G | 1G, 2.5G |
| E1/26 | 26 | Direct | | 2.5G | 1G, 2.5G |
| E1/27 | 27 | Direct | | 2.5G | 1G, 2.5G |
| E1/28 | 28 | Direct | | 2.5G | 1G, 2.5G |
| E1/29 | 29 | Direct | | 2.5G | 1G, 2.5G |
| E1/30 | 30 | Direct | | 2.5G | 1G, 2.5G |
| E1/31 | 31 | Direct | | 2.5G | 1G, 2.5G |
| E1/32 | 32 | Direct | | 2.5G | 1G, 2.5G |
| E1/33 | 33 | Direct | | 2.5G | 1G, 2.5G |
| E1/34 | 34 | Direct | | 2.5G | 1G, 2.5G |
| E1/35 | 35 | Direct | | 2.5G | 1G, 2.5G |
| E1/36 | 36 | Direct | | 2.5G | 1G, 2.5G |
| E1/37 | 37 | Direct | | 10G | 1G, 10G |
| E1/38 | 38 | Direct | | 10G | 1G, 10G |
| E1/39 | 39 | Direct | | 10G | 1G, 10G |
| E1/40 | 40 | Direct | | 10G | 1G, 10G |
| E1/41 | 41 | Direct | | 10G | 1G, 10G |
| E1/42 | 42 | Direct | | 10G | 1G, 10G |
| E1/43 | 43 | Direct | | 10G | 1G, 10G |
| E1/44 | 44 | Direct | | 10G | 1G, 10G |
| E1/45 | 45 | Direct | | 10G | 1G, 10G |
| E1/46 | 46 | Direct | | 10G | 1G, 10G |
| E1/47 | 47 | Direct | | 10G | 1G, 10G |
| E1/48 | 48 | Direct | | 10G | 1G, 10G |
| E1/1 | 1 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/2 | 2 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/3 | 3 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/4 | 4 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/5 | 5 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/6 | 6 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/7 | 7 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/8 | 8 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/9 | 9 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/10 | 10 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/11 | 11 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/12 | 12 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/13 | 13 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/14 | 14 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/15 | 15 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/16 | 16 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/17 | 17 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/18 | 18 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/19 | 19 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/20 | 20 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/21 | 21 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/22 | 22 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/23 | 23 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/24 | 24 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/25 | 25 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/26 | 26 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/27 | 27 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/28 | 28 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/29 | 29 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/30 | 30 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/31 | 31 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/32 | 32 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/33 | 33 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/34 | 34 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/35 | 35 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/36 | 36 | Direct | | 2.5G | 1G, 2.5G, AutoNeg supported (default: true) |
| E1/37 | 37 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/38 | 38 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/39 | 39 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/40 | 40 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/41 | 41 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/42 | 42 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/43 | 43 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/44 | 44 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/45 | 45 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/46 | 46 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/47 | 47 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/48 | 48 | Direct | | 10G | 1G, 10G, AutoNeg supported (default: true) |
| E1/49 | 49 | Direct | | 25G | 1G, 10G, 25G |
| E1/50 | 50 | Direct | | 25G | 1G, 10G, 25G |
| E1/51 | 51 | Direct | | 25G | 1G, 10G, 25G |
Expand Down

0 comments on commit 42bc89f

Please sign in to comment.