ConfigChief の使い方

ConfigChief は、ネットワーク機器のコンフィグを読んでメーカーによらない表(Excel のパラメータブック)にし、その表からコンフィグ・チェック結果表・納品用のシートを出すツールです。

大事な注意: 同梱のパックは、メーカーが公開しているコマンドリファレンスを読んで作りました。実機の出力では確かめていません。 生成したコンフィグは、必ず検証機に流して確かめてから使ってください。何を確かめていないかは、各パックの README(internal/packs/<パック>/README.md)の「確かめていないこと」にあります。

ほかのページ: シートと列の一覧 ・ チェックの一覧 ・ パックの書き方

1. 起動する

ConfigChief.exe を置いて、ダブルクリックします。画面の表示には WebView2 ランタイム(Windows 11 には初めから入っています)が要ります。

ホームの画面。旧コンフィグ・パラメータブック・生成とチェック・納品物の操作が並ぶ

2. 案件フォルダ

1 つの案件が 1 つのフォルダです。中身はテキストと Excel だけなので、共有フォルダや git にそのまま置けます。

案件フォルダ/
  project.yaml       案件の設定
  parameters.xlsx    パラメータブック(値の正本)
  input/old/         旧機器のコンフィグ(1 台 1 ファイル。端末ログのままでも読めます)
  input/new/         手で書いた新コンフィグ(使うときだけ)
  input/customer/    お客様からもらった一覧(xlsx・xls・csv)
  input/logs/        検証機・本番の投入ログ、投入後の設定ログ
  extra/             追加コンフィグ(パックが書けない設定を、人が書いて差し込む)
  mappings/          お客様の一覧の、列の対応
  rules/             案件ごとのチェックのルール
  templates/         納品用パラメータシートのひな形
  packs/             案件専用のメーカーパック(同じ ID の同梱パックより優先)
  state/             判定・承認・控え・操作の記録
  out/<日時>/        実行 1 回ごとの出力(コンフィグ、レポート)

3. 更改の流れ(機器の入れ替え。同じメーカーでも別メーカーでも同じ)

  1. 案件を作り、旧コンフィグを置く: 画面の「案件」で作るか、init。旧機器のコンフィグを input/old/ に入れます。端末ソフトのログ(show running-config を打った画面の保存)もそのまま置けます
  2. 取り込む: 画面の「取り込み」か import。行ごとに、取り込み済み・無視・未対応が色で分かります。パラメータブックができ、「機器対応」「IF 対応」のシートに案が入ります 取り込みの画面。コンフィグの各行が、どの規則でどの表に入ったかが分かる(値はすべて架空の見本)
  3. 対応を決める: Excel で「機器対応」(旧ホスト名 → 新ホスト名・新メーカー)と「IF 対応」(旧 IF 名 → 新 IF 名)を埋めます
  4. パラメータブックにする: 「対応」の画面か book。対応を当てた設計データが、表ごとのシートに入ります。これ以降は、この Excel が値の正本です 対応の画面。旧 IF 名と新 IF 名の対応を確かめる
  5. 未対応の行を片付ける: 画面の「未対応の行」か judge。同じ形の行をまとめて、「手動で対応」(追加コンフィグに書く)・「対応不要」・「保留」を付けます
  6. 生成とチェック: ホームの「生成とチェック」か generate。全台のコンフィグ(out/<日時>/configs/)と、チェック結果表(reports/check_results.xlsx・.html)が出ます。値の誤りがある機器のコンフィグは書きません 結果の画面。Cisco の拠点ルータを NEC IX に書き換え、新しいメーカーで書けない値を指摘として出している
  7. 指摘を直すか、承認する: エラーと警告は、Excel の値を直すか、理由を付けて承認します。未承認の指摘が残っている間は、出力フォルダに UNVERIFIED.txt が置かれます
  8. 検証機で確かめる: 1 台分を検証機に流し、その端末ログを input/logs/ に置いて、画面の「ログ」か logs。機器に弾かれた行が一覧に出ます
  9. 変更が来たら: Excel を直して 6 をやり直します。2 回目からは、前回から変わった機器と行の一覧(reports/changes.xlsx)が出ます
  10. 納品物を出す: ホームの「納品物」か export。納品用パラメータシートと、相手に渡すパラメータ表が出ます
  11. 投入の後: 投入後の設定のログを input/logs/ に置いて、verify。パラメータブックから作ったコンフィグとの違いが出ます

別メーカーへ書き換えるとき

「機器対応」の新メーカーを変えると、同じパラメータブックから別メーカーのコンフィグが出ます。新しいメーカーで書けないものは、3 通りで知らせます。どれも黙って落としません。

出方意味すること
G-602(エラー)その列を、新しいメーカーのパックが書けない持っていかないならセルを空にする。別の書き方で持っていくなら、追加コンフィグに書いてセルを空にする
G-601・G-603・G-606(エラー)列は書けるが、その値の書き方が新しいメーカーに無い・足りない値がある指摘の文にある直し方のとおり、値を書き直す
G-614(警告)パックが、新しいメーカーの書き方に置き換えて書いた(例: QoS の「残りの帯域の %」を「帯域の %」に)指摘の文を読み、置き換えでよければ承認する。よくなければ値を書き直す

4. 新規構築の流れ

  1. 案件を作り、ホームの「空のブックを作る(新規構築)」か book --new。見出しだけのパラメータブックができます。見出しのセルのコメントに、列の説明と記入例があります
  2. 1 台目を、シート「機器」から書きます(ホスト名とメーカーは必須です)
  3. 似た機器は、ホームの「機器の複製」か clone --from <元> --to <新しいホスト名,…> で増やします。値は元のままなので、アドレスなど機器ごとに違う値を直します(重なりはチェックが指摘します)
  4. 全台に共通の値は、「機器」の列に *(全機器)か @グループ名 を書いた 1 行で書けます。空の列をまとめて埋めたいときは、シート「共通値」を使います
  5. あとは更改の 6 以降と同じです

コンフィグを先に手で書く進め方

手で書いたコンフィグを input/new/ に置いて取り込み、book --from new でパラメータブックにできます。旧コンフィグがあれば、「比較」で旧と新を比べて、入れ忘れと値の違いを確かめられます。

5. パラメータブック

6. チェックと承認

チェックの一覧は checks.md です。

頭の字種類例
V値必須の値が空、アドレスの重なり、使われていない ACL
X対向(2 台の間)IPsec の暗号が両端で違う、OSPF のエリアが違う
G生成書けない値、生成した文面を読み直した結果が表と違う
M移行旧との違い、対応が決まっていない IF
Sお客様の一覧一覧とパラメータブックの値が違う
Lログ機器に弾かれた行、投入後の設定との違い

案件ごとのルール

rules/*.yaml に、その案件だけの決まりを書けます。生成とチェックのたびに全台に当てます。

rules:
  - id: P-001
    title: 全台に NTP サーバがある
    severity: error
    require_line: '^ntp server '
  - id: P-002
    title: telnet を使わない
    severity: warning
    under: '^line vty'
    forbid_line: '^transport input .*telnet'
  - id: P-003
    title: インタフェースの説明は空にしない
    severity: warning
    table: interfaces
    where: 'row.enabled'
    expr: 'row.description != ""'
  - id: P-004
    title: NTP サーバは全台で同じ
    severity: warning
    equal_across: {table: ntp_servers, column: server}

種類は 5 つです: require_line(含むべき行)、forbid_line(含んではいけない行)、expr(行ごとの式)、unique(値の重複)、equal_across(全台で値がそろっているか)。devices で機器を絞れます(ホスト名・@グループ・vendor:パックの ID)。

7. パックが書けない設定(追加コンフィグ)

パックが対応していない設定は、extra/ に書いて差し込みます。

ファイル当たる機器
extra/_all.j2全機器
extra/@グループ名.j2そのグループの機器
extra/ホスト名.j2その機器

8. コマンドライン

画面と同じ処理を、窓を開かずに行えます。バッチファイルから呼ぶと、終わるまで待ち、%ERRORLEVEL% で終了コードを見られます(0 = 見るものなし、1 = 未承認の指摘などが残っている、2 = 実行できなかった)。

ConfigChief.exe init     <dir> [--name <案件名>] [--kind migration|new]
ConfigChief.exe import   --project <dir> [--source old|new] [--pack <ID>]
ConfigChief.exe book     --project <dir> [--from old|new] [--replace]
ConfigChief.exe book     --project <dir> --new
ConfigChief.exe clone    --project <dir> --from <ホスト名> --to <ホスト名>[,<ホスト名>…]
ConfigChief.exe compare  --project <dir> --a <old|new|book> --b <old|new|book>
ConfigChief.exe generate --project <dir> [--device <ホスト名>]
ConfigChief.exe check    --project <dir>
ConfigChief.exe approve  --project <dir> --finding <指紋> --reason <理由> --by <名前>
ConfigChief.exe approve  --project <dir> --rule <ID> --devices <範囲> [--table <表>] [--column <列>] --reason <理由> --by <名前>
ConfigChief.exe approve  --project <dir> --remove <承認の ID>
ConfigChief.exe judge    --project <dir> [--source old|new] [--all]
ConfigChief.exe judge    --project <dir> --group <ID> --verdict manual|not_needed|hold|none [--devices <範囲>] [--reason <理由>] --by <名前>
ConfigChief.exe customer --project <dir> [--draft <ファイル> [--sheet <シート>]] [--apply <指紋>,… | --apply-rule S-501|S-503 [--devices <範囲>]]
ConfigChief.exe export   --project <dir> --what sheet|peer|unhandled [--secrets show|mask] [--source old|new]
ConfigChief.exe logs     --project <dir>
ConfigChief.exe verify   --project <dir>
ConfigChief.exe sites    --project <dir> [--source book|old|new|logs]
ConfigChief.exe diff     <fileA> <fileB>
ConfigChief.exe diff     --tree <fileA> <fileB> [--keep-stamps] [--keep-secrets]
ConfigChief.exe diff     --tree --project <dir> --a <側> --b <側>
ConfigChief.exe pack test <パックのフォルダ> [--lines] [--dump]
ConfigChief.exe pack columns <パックのフォルダ>
ConfigChief.exe version

端末に直接打ったときは、Windows の決まりで、端末は終わりを待たずに次の入力を受け付けます(結果の文字は出ます)。待たせたいときは start /wait ConfigChief.exe … と打ちます。

9. そのほかの機能

10. 困ったとき

起きたこと見るところ
メーカーを判定できない取り込みの画面で、候補からパックを選びます(import --pack <ID>)
行が「未対応」になるその行の理由が画面に出ます。パックの README の「読まない行」も見ます。設定として要るなら、追加コンフィグに書きます
生成が止まる(コンフィグが出ない)チェック結果表のエラーを見ます。値の誤り(V-101〜V-107・V-109)がある機器は書きません
G-604(往復の不一致)が出る生成した文面を読み直した結果が、表と違います。パックの不具合か、パックが書けない値です。指摘の場所の値を見ます
機器に弾かれたlogs の一覧に、弾かれた行と機器の返事が出ます。実機の書き方がパックと違うときは、追加コンフィグで補うか、パックを直します

11. 制限