sonic-spanning-tree YANG

概要

• module: sonic-spanning-tree
• namespace: http://github.com/sonic-net/sonic-stp
• revision: 2025-03-15
• import: sonic-extension
• top container: sonic-spanning-tree

PVST / RSTP / MSTP のグローバル・VLAN 別・ポート別・MST instance/port 別の設定を保持する¹。

データフロー (自動生成)

flowchart LR
  Y["sonic-spanning-tree"]
  C1[("CONFIG_DB<br/>STP")]
  Y --> C1
  D1["stpmgrd"]
  C1 --> D1
  C2[("CONFIG_DB<br/>STP_VLAN")]
  Y --> C2
  C2 --> D1
  C3[("CONFIG_DB<br/>STP_VLAN_PORT")]
  Y --> C3
  C3 --> D1
  C4[("CONFIG_DB<br/>STP_PORT")]
  Y --> C4
  C4 --> D1

凡例

YANG モジュールから CONFIG_DB テーブル経由で subscribe する daemon/orch までを docs/reference/config-db-orch-map.md から機械生成したミニ図。詳細・例外は本ページ本文を参照。

ツリー

module: sonic-spanning-tree
  +--rw sonic-spanning-tree
     +--rw STP
     |  +--rw STP_LIST* [keyleaf]
     |     +--rw keyleaf              enumeration
     |     +--rw mode                 enumeration
     |     +--rw rootguard_timeout?   uint16
     |     +--rw forward_delay?       uint8
     |     +--rw hello_time?          uint8
     |     +--rw max_age?             uint8
     |     +--rw priority?            uint16
     +--rw STP_VLAN
     |  +--rw STP_VLAN_LIST* [name]
     |     +--rw name             string
     |     +--rw vlanid?          uint16
     |     +--rw enabled          boolean
     |     +--rw forward_delay?   uint8
     |     +--rw hello_time?      uint8
     |     +--rw max_age?         uint8
     |     +--rw priority?        uint16
     +--rw STP_VLAN_PORT
     |  +--rw STP_VLAN_PORT_LIST* [vlan-name ifname]
     |     +--rw vlan-name    -> ../../../STP_VLAN/STP_VLAN_LIST/name
     |     +--rw ifname       -> ../../../STP_PORT/STP_PORT_LIST/ifname
     |     +--rw path_cost?   uint64
     |     +--rw priority?    uint8
     +--rw STP_PORT
     |  +--rw STP_PORT_LIST* [ifname]
     |     +--rw ifname                   string
     |     +--rw enabled                  boolean
     |     +--rw root_guard?              boolean
     |     +--rw bpdu_guard?              boolean
     |     +--rw bpdu_guard_do_disable?   boolean
     |     +--rw uplink_fast?             boolean
     |     +--rw portfast?                boolean
     |     +--rw path_cost?               uint64
     |     +--rw priority?                uint8
     |     +--rw edge_port?               boolean
     |     +--rw link_type?               enumeration
     +--rw STP_MST
     |  +--rw STP_MST_LIST* [keyleaf]
     |     +--rw keyleaf          enumeration
     |     +--rw name?            string
     |     +--rw revision?        uint32
     |     +--rw max_hops?        uint8
     |     +--rw max_age?         uint8
     |     +--rw hello_time?      uint8
     |     +--rw forward_delay?   uint8
     |     +--rw hold_count?      uint8
     +--rw STP_MST_INST
     |  +--rw STP_MST_INST_LIST* [instance]
     |     +--rw instance           uint16
     |     +--rw vlan*              string
     |     +--rw bridge_priority?   uint16
     +--rw STP_MST_PORT
        +--rw STP_MST_PORT_LIST* [inst_id ifname]
           +--rw inst_id      -> ../../../STP_MST_INST/STP_MST_INST_LIST/instance
           +--rw ifname       -> ../../../STP_PORT/STP_PORT_LIST/ifname
           +--rw path_cost?   uint64
           +--rw priority?    uint8

leaf 一覧

leaf	パス	型	必須	デフォルト	enum / 範囲 / leafref	説明
keyleaf	sonic-spanning-tree/STP/STP_LIST/keyleaf	enumeration	yes		GLOBAL	Singleton key for STP global container
mode	sonic-spanning-tree/STP/STP_LIST/mode	enumeration	yes		pvst, rapid-pvst, mst	Spanning tree protocol mode
rootguard_timeout	sonic-spanning-tree/STP/STP_LIST/rootguard_timeout	uint16			range 5..600	Root guard recovery timeout (seconds)
forward_delay	sonic-spanning-tree/STP/STP_LIST/forward_delay	uint8		15	range 4..30	Global forward delay
hello_time	sonic-spanning-tree/STP/STP_LIST/hello_time	uint8		2	range 1..10	Global hello time
max_age	sonic-spanning-tree/STP/STP_LIST/max_age	uint8		20	range 6..40	Global max age
priority	sonic-spanning-tree/STP/STP_LIST/priority	uint16		32768	range 0..61440 (step 4096)	Bridge priority
name	sonic-spanning-tree/STP_VLAN/STP_VLAN_LIST/name	string	yes		"Vlan<id>"	VLAN identifier in format 'Vlan'
vlanid	sonic-spanning-tree/STP_VLAN/STP_VLAN_LIST/vlanid	uint16			range 1..4094	VLAN ID
enabled	sonic-spanning-tree/STP_VLAN/STP_VLAN_LIST/enabled	boolean	yes			Spanning tree enabled on VLAN
forward_delay	sonic-spanning-tree/STP_VLAN/STP_VLAN_LIST/forward_delay	uint8			range 4..30	Per-VLAN forward delay
hello_time	sonic-spanning-tree/STP_VLAN/STP_VLAN_LIST/hello_time	uint8			range 1..10	Per-VLAN hello time
max_age	sonic-spanning-tree/STP_VLAN/STP_VLAN_LIST/max_age	uint8			range 6..40	Per-VLAN max age
priority	sonic-spanning-tree/STP_VLAN/STP_VLAN_LIST/priority	uint16			range 0..61440	Per-VLAN bridge priority
vlan-name	sonic-spanning-tree/STP_VLAN_PORT/STP_VLAN_PORT_LIST/vlan-name	leafref	yes		../../../STP_VLAN/STP_VLAN_LIST/name	Reference to VLAN
ifname	sonic-spanning-tree/STP_VLAN_PORT/STP_VLAN_PORT_LIST/ifname	leafref	yes		../../../STP_PORT/STP_PORT_LIST/ifname	Reference to Ethernet interface or PortChannel
path_cost	sonic-spanning-tree/STP_VLAN_PORT/STP_VLAN_PORT_LIST/path_cost	uint64			range 1..200000000	Path cost per VLAN per port
priority	sonic-spanning-tree/STP_VLAN_PORT/STP_VLAN_PORT_LIST/priority	uint8			range 0..240 (step 16)	Port priority per VLAN
ifname	sonic-spanning-tree/STP_PORT/STP_PORT_LIST/ifname	leafref	yes		Ethernet/PortChannel	Reference to Ethernet interface or PortChannel
enabled	sonic-spanning-tree/STP_PORT/STP_PORT_LIST/enabled	boolean	yes			Spanning tree enabled on interface
root_guard	sonic-spanning-tree/STP_PORT/STP_PORT_LIST/root_guard	boolean				Root guard on port
bpdu_guard	sonic-spanning-tree/STP_PORT/STP_PORT_LIST/bpdu_guard	boolean				BPDU guard on port
bpdu_guard_do_disable	sonic-spanning-tree/STP_PORT/STP_PORT_LIST/bpdu_guard_do_disable	boolean				Disable port when BPDU is received
uplink_fast	sonic-spanning-tree/STP_PORT/STP_PORT_LIST/uplink_fast	boolean				Uplink-fast on port
portfast	sonic-spanning-tree/STP_PORT/STP_PORT_LIST/portfast	boolean				Portfast (PVST only)
path_cost	sonic-spanning-tree/STP_PORT/STP_PORT_LIST/path_cost	uint64			range 1..200000000	Port path cost
priority	sonic-spanning-tree/STP_PORT/STP_PORT_LIST/priority	uint8			range 0..240 (step 16)	Port priority
edge_port	sonic-spanning-tree/STP_PORT/STP_PORT_LIST/edge_port	boolean				Edge port designation
link_type	sonic-spanning-tree/STP_PORT/STP_PORT_LIST/link_type	enumeration			point-to-point, shared	Port link type
keyleaf	sonic-spanning-tree/STP_MST/STP_MST_LIST/keyleaf	enumeration	yes		GLOBAL	Singleton key for MST global container
name	sonic-spanning-tree/STP_MST/STP_MST_LIST/name	string				MST region name
revision	sonic-spanning-tree/STP_MST/STP_MST_LIST/revision	uint32				MST revision number
max_hops	sonic-spanning-tree/STP_MST/STP_MST_LIST/max_hops	uint8				MST max hops
max_age	sonic-spanning-tree/STP_MST/STP_MST_LIST/max_age	uint8				MST max age (seconds)
hello_time	sonic-spanning-tree/STP_MST/STP_MST_LIST/hello_time	uint8				MST hello time (seconds)
forward_delay	sonic-spanning-tree/STP_MST/STP_MST_LIST/forward_delay	uint8				MST forward delay (seconds)
hold_count	sonic-spanning-tree/STP_MST/STP_MST_LIST/hold_count	uint8				MST hold count
instance	sonic-spanning-tree/STP_MST_INST/STP_MST_INST_LIST/instance	uint16	yes			MST instance identifier
vlan	sonic-spanning-tree/STP_MST_INST/STP_MST_INST_LIST/vlan	leaf-list string				VLAN list assigned to MST instance
bridge_priority	sonic-spanning-tree/STP_MST_INST/STP_MST_INST_LIST/bridge_priority	uint16				Bridge priority per MST instance
inst_id	sonic-spanning-tree/STP_MST_PORT/STP_MST_PORT_LIST/inst_id	leafref	yes		../../../STP_MST_INST/STP_MST_INST_LIST/instance	Reference to MST instance
ifname	sonic-spanning-tree/STP_MST_PORT/STP_MST_PORT_LIST/ifname	leafref	yes		../../../STP_PORT/STP_PORT_LIST/ifname	Reference to Ethernet interface or PortChannel
path_cost	sonic-spanning-tree/STP_MST_PORT/STP_MST_PORT_LIST/path_cost	uint64				Path cost per MST instance per port
priority	sonic-spanning-tree/STP_MST_PORT/STP_MST_PORT_LIST/priority	uint8				Port priority per MST instance

leafref / 依存

• sonic-spanning-tree/STP_VLAN_PORT/STP_VLAN_PORT_LIST/vlan-name → ../../../STP_VLAN/STP_VLAN_LIST/name
• sonic-spanning-tree/STP_VLAN_PORT/STP_VLAN_PORT_LIST/ifname → ../../../STP_PORT/STP_PORT_LIST/ifname
• sonic-spanning-tree/STP_MST_PORT/STP_MST_PORT_LIST/inst_id → ../../../STP_MST_INST/STP_MST_INST_LIST/instance
• sonic-spanning-tree/STP_MST_PORT/STP_MST_PORT_LIST/ifname → ../../../STP_PORT/STP_PORT_LIST/ifname

augment / deviation

• なし

関連 CONFIG_DB / CLI

• CONFIG_DB: STP, STP_VLAN, STP_VLAN_PORT, STP_PORT, STP_MST, STP_MST_INST, STP_MST_PORT
• CLI: config spanning-tree, show spanning-tree

関連 YANG モジュール

意味的に関連する SONiC YANG モジュール (slug prefix / curated group / frontmatter related.yang から自動抽出):

• sonic-vlan
• sonic-port
• sonic-portchannel
• sonic-mclag
• sonic-storm-control

関連リファレンス

• CONFIG_DB: STP / STP_VLAN / STP_VLAN_PORT / STP_PORT / STP_MST / STP_MST_INST / STP_MST_PORT
• CLI: config spanning-tree / show spanning-tree

運用ヒント

典型的なデプロイ位置

• STP / RSTP / PVST 設定。STP / STP_PORT / STP_VLAN* を stpmgr / stpd が処理。

よくある落とし穴

• mode (pvst ↔ mst) を runtime で切替えるとポート単位設定が一部リセットされる。事前にバックアップ推奨。

関連する config / show コマンド

sonic-db-cli CONFIG_DB hgetall 'STP|GLOBAL'
show spanning_tree

引用元

---

1. sonic-net/sonic-buildimage src/sonic-yang-models/yang-models/sonic-spanning-tree.yang @ 9ea932ec2e18f35e58268ec2e4456b1d4afd65cd ↩