裏取りステータス: code-verified（メタドキュメント）

元文書はユーザマニュアル全体（41KB）。このページは 読者の入口 として SONiC の運用 CLI 群と章構成を整理するインデックス。コマンド体系（show / config Click 群、sonic-cli KLISH、generate_dump/techsupport、minigraph 関連）の存在は sonic-utilities/{show,config}/、sonic-utilities/scripts/generate_dump、sonic-utilities/tests/db_migrator_input/minigraph.xml で確認済み。コマンド単位の詳細は別ページ（docs/reference/cli/...）を参照。

SONiC User Manual の位置づけと SONiC CLI / 運用フローの全体像¶

概要¶

SONiC のユーザマニュアルは「日常運用と機能設定を一冊で把握する」ことを目的とした包括ガイド¹。このページでは、HLD やリファレンスとマニュアルの 役割境界 を明確にし、利用者が次に読むべき場所を案内する。

種類	何が書いてあるか	このサイトでの居場所
User Manual	コマンド使い方・設定例・運用 tips	個別機能ページ + reference/cli
HLD	設計意図・内部 daemon 構成・SAI 期待値	architecture / area 別ページ
Reference	機械抽出した CLI ツリー / YANG / CONFIG_DB	`docs/reference/...`

動作仕様（CLI 系統の二重化）¶

SONiC は歴史的に 2 系統の CLI が共存する:

flowchart LR
    USER[管理者] --> SH[bash shell]
    SH --> CLICK["sonic-utilities\n(click ベース)\nshow / config / sudo systemctl ..."]
    SH --> KLISH["sonic-cli\n(KLISH ベース\nmgmt-framework 経由)"]
    CLICK --> CDB[("CONFIG_DB / 直接")]
    KLISH --> MF[mgmt-framework]
    MF --> CDB

show / config 系（sonic-utilities）: Python click + 直接 Redis 操作。歴史が長く、機能カバレッジが広い
sonic-cli (KLISH): モデル駆動。openconfig YANG への 1:1 マッピングが厚い

User Manual は両者の併用前提で書かれており、機能によって主に使う系統が異なる。

主要な運用フロー¶

flowchart LR
    INIT["初期構成\nminigraph / config_db.json"] --> RELOAD[config reload]
    RELOAD --> SHOW[show running-configuration]
    SHOW --> EDIT[個別 config command]
    EDIT --> SAVE[config save]
    SAVE --> REB["warm/cold reboot"]
    REB --> SHOW

初期投入: minigraph.xml（旧）または config_db.json（推奨）を /etc/sonic/ に配置 → config load_minigraph / config reload
永続化: config save -y で /etc/sonic/config_db.json に書き戻す（save-on-set 系の自動保存もある）
trouble shoot: show techsupport でログ・running config・SAI dump を一括収集

制限事項¶

マニュアル単独で完結しない: 細部は HLD / 実コードを併読する前提
更新ペースが機能追加に追いつかない: 新機能は HLD と CLI helptext が一次情報になることが多い
2 系統 CLI の差: 同じ機能でも config xxx と sonic-cli で表現が違う（覚え分けが必要）

干渉する機能¶

Management Framework: KLISH CLI を成立させる土台。同 area の別ページ参照
GCU / JSON patch ordering: 大規模変更を config reload ではなく apply-patch で行うパスがあるため、運用に影響
Application Extension: install した拡張がそれぞれ独自の config / show サブコマンドを足す

トラブルシューティング¶

どっちの CLI を使うべきか分からない → 機能ページ（このドキュメントサイトの当該 area）の「関連 CLI」を最初に見る
config reload 時に長時間止まる → GCU apply-patch への置き換えを検討
show techsupport が膨大 → 個別 show コマンド + journalctl で特定コンテナ単位に絞る

確認コマンド例:

# CLI / 設定パイプライン状態確認
show runningconfiguration all | head
config save -y
diff /etc/sonic/config_db.json <(show runningconfiguration all)

引用元¶

運用入口¶

この HLD に対応する運用面の入口（CLI / CONFIG_DB / YANG / Runbook）を以下にまとめる。