コンテンツにスキップ

config banner サブコマンド

概要

config banner はシステムバナー（ログイン前/後メッセージ、MOTD）を CONFIG_DB の BANNER_MESSAGE|global テーブルに書き込む CLI グループ1。SONiC では hostcfgd 系がこのテーブル変更を監視し、/etc/issue.net / /etc/motd などを再生成する。

コマンド一覧

コマンド 用途
config banner state <enabled\|disabled> バナー機能の有効/無効
config banner login <message> ログイン前メッセージ設定
config banner logout <message> ログアウト時メッセージ設定
config banner motd <message> Message of the day を設定

各コマンドの詳細

config banner state <enabled|disabled>

用法:

config banner state {enabled|disabled}

引数:

  • state ... enabled / disabled のいずれか（click.Choice）

動作: CONFIG_DB の BANNER_MESSAGE|global の state フィールドを更新2。

📋 検証エビデンス: sonic-net/sonic-utilities/config/main.py#L10012-L10020 (sha: 39732bceb8bdefe706518ab40623bbbba6ff33b9)

出典:

sonic-net/sonic-utilities/config/main.py#L10012-L10020 (sha: 39732bceb8bdefe706518ab40623bbbba6ff33b9)

抜粋:

@banner.command()
@click.argument('state', type=click.Choice(['enabled', 'disabled']))
def state(state):
    config_db.mod_entry(swsscommon.CFG_BANNER_MESSAGE_TABLE_NAME, 'global',
                        {'state': state})

config banner login <message>

動作: BANNER_MESSAGE|global の login フィールドを更新。SSH/console ログイン前に表示されるバナー文字列。

config banner logout <message>

動作: BANNER_MESSAGE|global の logout フィールドを更新。

config banner motd <message>

動作: BANNER_MESSAGE|global の motd フィールドを更新。ログイン後に表示される MOTD (Message Of The Day)。

関連する CONFIG_DB

テーブル キー フィールド
BANNER_MESSAGE global state, login, logout, motd

注意

  • state が disabled の場合、login / logout / motd の文字列が設定されていても表示されない（hostcfgd 側のテンプレート分岐）。
  • <message> は単一文字列の click argument のため、複数語のメッセージは引用符でくくる必要がある。

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

flowchart LR
  CLI["config banner"]
  SC["sonic-cfggen<br/>(config CLI のみ)"]
  CLI --> SC
  CDB0[("CONFIG_DB<br/>BANNER_MESSAGE")]
  SC --> CDB0
  DM0["hostcfgd"]
  CDB0 --> DM0

凡例

config 系 (CLI → CONFIG_DB → daemon) のミニ図。テーブル → daemon 対応は docs/reference/config-db-orch-map.md から機械生成。

関連リファレンス

引用元

関連 CLI コマンド

  1. config banner グループ定義は config/main.py L10003-L10053。https://github.com/sonic-net/sonic-utilities/blob/39732bceb8bdefe706518ab40623bbbba6ff33b9/config/main.py#L10003 ↩

  2. テーブル名は swsscommon.CFG_BANNER_MESSAGE_TABLE_NAME 定数経由で取得される（= "BANNER_MESSAGE"）。 ↩