Skip to content

Update docs from fabric@v0.130.2 #345

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

Merged
Frostman merged 1 commit into from
Sep 1, 2026
Merged

Update docs from fabric@v0.130.2 #345

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
26 changes: 23 additions & 3 deletions docs/reference/fabric-api.md.gen
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,8 @@ _Appears in:_
| `interfaces` _object (keys:string, values:[SwitchStateInterface](#switchstateinterface))_ | Switch interfaces state (incl. physical, management and port channels) | | |
| `breakouts` _object (keys:string, values:[SwitchStateBreakout](#switchstatebreakout))_ | Breakout ports state (port -> breakout state) | | |
| `transceivers` _object (keys:string, values:[SwitchStateTransceiver](#switchstatetransceiver))_ | Transceivers state (port -> transceiver state) | | |
| `bgpNeighbors` _object (keys:string, values:[map[string]SwitchStateBGPNeighbor](#switchstatebgpneighbor))_ | State of all BGP neighbors (VRF -> neighbor address -> state) | | |
| `bfdPeers` _object (keys:string, values:[map[string]SwitchStateBFDPeer](#switchstatebfdpeer))_ | State of all BFD peers (VRF -> peer address -> state) | | |
| `bgpNeighbors` _object (keys:string, values:[map[string]SwitchStateBGPNeighbor](#switchstatebgpneighbor))_ | State of all BGP neighbors (VRF -> neighbor address, or port (with .VLAN for TH5) for an unnumbered session -> state) | | |
| `bfdPeers` _object (keys:string, values:[map[string]SwitchStateBFDPeer](#switchstatebfdpeer))_ | State of all BFD peers (VRF -> peer address, or port for an unnumbered session -> state) | | |
| `platform` _[SwitchStatePlatform](#switchstateplatform)_ | State of the switch platform (fans, PSUs, sensors) | | |
| `criticalResources` _[SwitchStateCRM](#switchstatecrm)_ | State of the critical resources (ACLs, routes, etc.) | | |
| `roce` _boolean_ | State of the roce configuration | | |
Expand Down Expand Up @@ -527,15 +527,18 @@ _Appears in:_

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `name` _string_ | | | |
| `chassis` _string_ | | | |
| `sysName` _string_ | | | |
| `sysDescr` _string_ | | | |
| `portID` _string_ | | | |
| `portDescr` _string_ | | | |
| `ttl` _integer_ | TTL advertised by the neighbor, seconds | | |
| `updated` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#time-v1-meta)_ | When the neighbor entry was last updated | | |
| `manuf` _string_ | | | |
| `model` _string_ | | | |
| `serial` _string_ | | | |
| `mac` _string_ | MAC of the neighbor port: the LLDP source MAC, or the port ID if it's a MAC address | | |
| `port` _string_ | Human-readable neighbor port name: the port ID, or the port description if the port ID is a MAC address | | |


#### SwitchStateNOS
Expand Down Expand Up @@ -3079,6 +3082,22 @@ _Appears in:_
| `mtu` _integer_ | MTU is the MTU to be configured on the switch port or port channel | | |


#### ServerInspect



ServerInspect defines the expectations used to check the server against what's observed in the Fabric



_Appears in:_
- [ServerSpec](#serverspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `expectedSysName` _string_ | ExpectedSystemName is the LLDP system name the server advertises, usually its hostname, if it isn't the<br />name of this object, e.g. a server-1 running as server-1.example.com | | |


#### ServerSpec


Expand All @@ -3094,6 +3113,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `description` _string_ | Description is a description of the server | | |
| `profile` _string_ | Profile is the profile of the server, name of the ServerProfile object to be used for this server, currently not used by the Fabric | | |
| `inspect` _[ServerInspect](#serverinspect)_ | Inspect is the expectations used to check the server against what's observed in the Fabric | | |


#### ServerStatus
Expand Down
Loading