Damien/fabric-orchestrator
1
0
Fork 0
Code Issues 16 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: format markdown tables in yang-paths.md

Browse Source 
Improve table readability by aligning columns with consistent
spacing and proper markdown table formatting throughout the
YANG paths reference documentation.
This commit is contained in:
darnodo
2025-12-31 17:18:01 +01:00
parent e355cce4c8
commit 8e460225c2
1 changed files with 79 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/yang-paths.md
View File

@@ -9,7 +9,7 @@ This document provides the complete reference of validated gNMI YANG paths for m
## Quick Reference ## Quick Reference
| Feature | Model Type | Config | State | Subscribe ON_CHANGE | | Feature | Model Type | Config | State | Subscribe ON_CHANGE |
|---------|------------|--------|-------|---------------------| | ---------- | ---------- | ------ | ----- | ------------------- |
| Interfaces | OpenConfig | ✅ | ✅ | ✅ | | Interfaces | OpenConfig | ✅ | ✅ | ✅ |
| Loopbacks | OpenConfig | ✅ | ✅ | ✅ | | Loopbacks | OpenConfig | ✅ | ✅ | ✅ |
| VLANs | OpenConfig | ✅ | ✅ | ✅ | | VLANs | OpenConfig | ✅ | ✅ | ✅ |
@@ -25,7 +25,7 @@ This document provides the complete reference of validated gNMI YANG paths for m
**Model**: `openconfig-interfaces` **Model**: `openconfig-interfaces`
| Operation | Path | | Operation | Path |
|-----------|------| | ------------------ | ---------------------------------------------------------- |
| All interfaces | `/interfaces/interface` | | All interfaces | `/interfaces/interface` |
| Specific interface | `/interfaces/interface[name=Ethernet1]` | | Specific interface | `/interfaces/interface[name=Ethernet1]` |
| Interface config | `/interfaces/interface[name=Ethernet1]/config` | | Interface config | `/interfaces/interface[name=Ethernet1]/config` |
@@ -56,7 +56,7 @@ gnmic -a 172.16.0.50:6030 -u admin -p admin --insecure \
**Model**: `openconfig-interfaces` **Model**: `openconfig-interfaces`
| Operation | Path | | Operation | Path |
|-----------|------| | ---------------- | ---------------------------------------------- |
| Loopback0 | `/interfaces/interface[name=Loopback0]` | | Loopback0 | `/interfaces/interface[name=Loopback0]` |
| Loopback1 (VTEP) | `/interfaces/interface[name=Loopback1]` | | Loopback1 (VTEP) | `/interfaces/interface[name=Loopback1]` |
| Loopback config | `/interfaces/interface[name=Loopback0]/config` | | Loopback config | `/interfaces/interface[name=Loopback0]/config` |
@@ -68,7 +68,7 @@ gnmic -a 172.16.0.50:6030 -u admin -p admin --insecure \
**Model**: `openconfig-network-instance`, `openconfig-vlan` **Model**: `openconfig-network-instance`, `openconfig-vlan`
| Operation | Path | | Operation | Path |
|-----------|------| | ------------- | --------------------------------------------------------------------------------- |
| All VLANs | `/network-instances/network-instance[name=default]/vlans/vlan` | | All VLANs | `/network-instances/network-instance[name=default]/vlans/vlan` |
| Specific VLAN | `/network-instances/network-instance[name=default]/vlans/vlan[vlan-id=40]` | | Specific VLAN | `/network-instances/network-instance[name=default]/vlans/vlan[vlan-id=40]` |
| VLAN config | `/network-instances/network-instance[name=default]/vlans/vlan[vlan-id=40]/config` | | VLAN config | `/network-instances/network-instance[name=default]/vlans/vlan[vlan-id=40]/config` |
@@ -89,7 +89,7 @@ gnmic -a 172.16.0.50:6030 -u admin -p admin --insecure \
### Paths ### Paths
| Operation | Path (relative to base) | | Operation | Path (relative to base) |
|-----------|-------------------------| | ---------------------- | ----------------------------------------------------------------------------------------------- |
| BGP global config | `/global/config` | | BGP global config | `/global/config` |
| BGP global state | `/global/state` | | BGP global state | `/global/state` |
| Router ID | `/global/config/router-id` | | Router ID | `/global/config/router-id` |
@@ -124,7 +124,7 @@ gnmic -a 172.16.0.50:6030 -u admin -p admin --insecure \
**Model**: `arista-exp-eos-vxlan` (augments `openconfig-interfaces`) **Model**: `arista-exp-eos-vxlan` (augments `openconfig-interfaces`)
| Operation | Path | | Operation | Path |
|-----------|------| | ------------------------ | ----------------------------------------------------------------------------------- |
| VXLAN interface | `/interfaces/interface[name=Vxlan1]` | | VXLAN interface | `/interfaces/interface[name=Vxlan1]` |
| VXLAN augment | `/interfaces/interface[name=Vxlan1]/arista-vxlan` | | VXLAN augment | `/interfaces/interface[name=Vxlan1]/arista-vxlan` |
| VXLAN config | `/interfaces/interface[name=Vxlan1]/arista-vxlan/config` | | VXLAN config | `/interfaces/interface[name=Vxlan1]/arista-vxlan/config` |
@@ -160,14 +160,14 @@ gnmic -a 172.16.0.50:6030 -u admin -p admin --insecure \
> ⚠️ **Limitation**: Only configuration is exposed via gNMI. Operational state (peer status, role, negotiation) requires eAPI. > ⚠️ **Limitation**: Only configuration is exposed via gNMI. Operational state (peer status, role, negotiation) requires eAPI.
| Operation | Path | | Operation | Path |
|-----------|------| | ----------- | ------------------------- |
| Full MLAG | `/arista/eos/mlag` | | Full MLAG | `/arista/eos/mlag` |
| MLAG config | `/arista/eos/mlag/config` | | MLAG config | `/arista/eos/mlag/config` |
### Config Fields ### Config Fields
| Field | Description | | Field | Description |
|-------|-------------| | ------------------------------ | ------------------------------------- |
| `domain-id` | MLAG domain identifier | | `domain-id` | MLAG domain identifier |
| `local-intf` | Local VLAN interface (e.g., Vlan4090) | | `local-intf` | Local VLAN interface (e.g., Vlan4090) |
| `peer-address` | MLAG peer IP address | | `peer-address` | MLAG peer IP address |
@@ -201,7 +201,7 @@ curl -X POST https://switch/command-api \
> ⚠️ **Limitation**: Only configuration is exposed via gNMI. Learned routes and MACs require eAPI. > ⚠️ **Limitation**: Only configuration is exposed via gNMI. Learned routes and MACs require eAPI.
| Operation | Path | | Operation | Path |
|-----------|------| | ----------------- | -------------------------------------------------------- |
| All EVPN | `/arista/eos/evpn` | | All EVPN | `/arista/eos/evpn` |
| EVPN instances | `/arista/eos/evpn/evpn-instances` | | EVPN instances | `/arista/eos/evpn/evpn-instances` |
| Specific instance | `/arista/eos/evpn/evpn-instances/evpn-instance[name=40]` | | Specific instance | `/arista/eos/evpn/evpn-instances/evpn-instance[name=40]` |
@@ -209,7 +209,7 @@ curl -X POST https://switch/command-api \
### Config Fields ### Config Fields
| Field | Path | | Field | Path |
|-------|------| | ------------------- | ------------------------------------------------------ |
| Name | `.../evpn-instance[name=X]/config/name` | | Name | `.../evpn-instance[name=X]/config/name` |
| Route Distinguisher | `.../evpn-instance[name=X]/config/route-distinguisher` | | Route Distinguisher | `.../evpn-instance[name=X]/config/route-distinguisher` |
| Redistribute | `.../evpn-instance[name=X]/config/redistribute` | | Redistribute | `.../evpn-instance[name=X]/config/redistribute` |
@@ -231,7 +231,7 @@ gnmic -a 172.16.0.50:6030 -u admin -p admin --insecure \
**Model**: `openconfig-interfaces`, `openconfig-if-aggregate` **Model**: `openconfig-interfaces`, `openconfig-if-aggregate`
| Operation | Path | | Operation | Path |
|-----------|------| | ---------------------- | -------------------------------------------------------------------- |
| Port-Channel interface | `/interfaces/interface[name=Port-Channel999]` | | Port-Channel interface | `/interfaces/interface[name=Port-Channel999]` |
| LAG config | `/interfaces/interface[name=Port-Channel999]/aggregation/config` | | LAG config | `/interfaces/interface[name=Port-Channel999]/aggregation/config` |
| LAG state | `/interfaces/interface[name=Port-Channel999]/aggregation/state` | | LAG state | `/interfaces/interface[name=Port-Channel999]/aggregation/state` |