3. ゼロタッチプロビジョニング
3.1. はじめに
3.1.1. ゼロタッチプロビジョニング(ZTP)概要
3.1.2. 用語の定義
- ゼロタッチプロビジョニング、ZTP、ゼロタッチ
本機能の名称で使用。本章ではすべて同じ意味で記載しています。
- ZTP接続ID
NetMeisterで登録したコンフィグと装置を結びつけるために、既存の情報を組み合わせたIDです。
- ZTPスイッチ
装置前面にZTPと書かれたスイッチです。ZTPを有効/無効にする場合に使用します。
- ZTP LED
ZTPスイッチありの装置は、ZTP処理状況によりZTPスイッチの下にあるLEDが点灯・点滅します。
- ダウンロードコンフィグ
ZTPによりNetMeisterから装置に適用するためのコンフィグ。NetMeisterのWeb画面で設定します。
3.1.3. 適用範囲
適用ソフトウェアバージョン
ソフトウェアはVer.1.2以降で使用できます。
適用装置
IX-Rシリーズ
適用環境
フレッツ光ネクスト等のIPv6 NGN閉域網
IPv4 (DHCP)
注釈
NGN閉域網以外のIPv6はサポートしません。
ZTP機能による起動時のNetMeister接続はGE0(GigaEthernet0)を利用します。
3.1.4. 制限事項
イントラネット内などからの接続で、プロキシ越しにネットワークに接続する場合、ZTP開始時のstartup-configにプロキシ設定をしておく必要があります。
起動時コンフィグダウンロード機能とは同時に使用できません。
ZTP機能はGE0(IPv4,IPv6 NGN)を経由してNetMeisterに接続するため、GE0以外のポートやUSBを使用した無線には対応していません。
NGN閉域網を使用した構成でZTP対象の統合ルータの前段にルータを挟んで接続をする場合、ZTP対象のルータにあらかじめ nm ipv6 enable ngn-private east/west の設定をしておく必要があります。
NM Readyモードは未サポートです。
3.2. 設定の流れ
3.2.1. NetMeisterへの装置登録
注釈
NetMeisterに登録後、設定した有効期間以内にZTPにより装置にコンフィグをダウンロードする必要があります。
有効期間を過ぎた場合は再度NetMeisterに登録してください。
3.2.1.1. ZTP接続IDの確認
- show hardwareコマンド
ZTP機能の有効無効に関わらず常に表示されます。
- nm provisioning enableコマンド入力時
入力後にCLIに表示されます。
3.2.1.2. IX-RルータのMACアドレスとシリアル番号の登録
3.2.2. ZTPの有効化設定
以下のいずれかの条件を満たしている場合にZTPが有効になります。
ZTPスイッチがONになっている
ZTPスイッチのある装置の場合、ZTPスイッチをONにすることでZTPが有効になります。装置にCLIやWebGUIでのコンフィグ設定は必要ありません。その状態で装置を起動するとZTPが起動します。nm provisioning enableコマンドが設定されている
startup-configやdefault-configにnm provisioning enableが設定されている状態で装置を起動するとZTPが起動します。
注釈
ZTPスイッチがONの状態かつnm provisioning enableコマンドが設定されている場合、nm provisioning enableコマンドで設定している内容が優先されます。
注意
nm provisioning disableコマンドが設定されている場合、ZTPスイッチがONでもZTPは無効になります。
3.2.3. 子機ZTPの有効化設定
子機ZTPの有効化設定は、「NetMeisterの設定 > 子機収容 > 子機ゼロタッチプロビジョニング(ZTP)の有効化設定」を参照してください。
3.2.4. ZTPの起動後の動作
注釈
NetMeister サーバーへの接続に使用するポートは GE0 です。
装置のコンフィグで既に GE0 または GE0 配下のいずれかのサブインタフェースに no shutdownが設定されている場合、既に設定されているコンフィグ情報で NetMeister に接続します。
NetMeister サーバーへの接続設定は startup-config/default-config のものを使用します。
startup-config/default-config に NetMeister の接続設定がない場合は、「IPv6 NGN 閉域網接続、IPv4 接続」の順に繰り返し NetMeister に接続試行します。
ZTP 処理中に startup-config が変更された場合、ZTP 処理がキャンセルされます。
ユーザーがコンフィグモードにログインした場合 ZTP 処理は一時停止し、コンフィグモードからログアウトすると再開します。
3.2.5. ZTPの動作パターン
3.2.5.1. 最初の起動時のみコンフィグをダウンロード
NetMeisterで「初回コンフィグダウンロード後、無効にする」を設定します。
ダウンロードコンフィグにnm provisioning disableを設定します。
ダウンロードコンフィグにnm provisioning disableの設定をいれない場合はZTP起動後、ZTPスイッチをOFFにしてください。
3.2.5.2. 起動時毎回タウンロード
起動時に毎回ZTP機能が動作するパターンです。以下の設定を行う必要があります。
NetMeisterで「初回コンフィグダウンロードに成功した装置は、初回DL期限後もダウンロード可能とする」を設定します。
ダウンロードコンフィグにnm provisioning enableを設定します。
ダウンロードコンフィグにnm provisioning enableの設定をいれない場合は、ZTPスイッチをONにしてください。
3.2.5.3. ダウンロードしたコンフィグを装置に保存しない
ダウンロードコンフィグにnm provisioning enable no-saveconfigを設定します。
注釈
装置のコンフィグにnm provisioning enable no-saveconfigを設定しても、保存する動作になるので注意してください。
以下のコマンドはstartup-configに保存されます。
terminal speedコマンド
nm provisioning enable no-saveconfigコマンド
要再起動コマンド(暗号化されて保存されます。)
usernameコマンド
3.2.6. ZTPの運用フロー
3.2.6.1. コンフィグ設定や装置情報を事前に紐づけ済の運用準備フロー
3.2.6.2. コンフィグを事前登録し、装置情報の紐づけを現地で行う運用準備フロー
3.2.6.3. 直接現地で ZTP を使用する場合の運用準備フロー
3.3. LED
3.3.1. ZTP LED
ZTP LED
装置起動中~ZTP初期化
緑点滅(1秒周期)ZTP処理中
緑点滅(2秒周期)ZTP処理時間超過
赤点滅(2秒周期)ZTP正常終了
緑点灯
ZTP異常終了
赤点灯
ZTP処理キャンセル
消灯
ZTP処理無効中
消灯
リロード時
※1
- 装置起動中~ZTP初期化:
- 装置起動からソフトウェア起動まで。ZTPスイッチOFFの場合、緑点滅を開始するのはBOOT起動時からとなる。ZTP初期化処理実行時に無条件でいったん消灯状態となる。
- ZTP処理中:
- ZTP処理中の状態。通信エラーやコンフィグモードログインによる処理中断中も含む。
- ZTP処理時間超過:
- ZTP処理開始から10分経過した状態。正常終了/キャンセル/異常終了となるまで継続する。
- ZTP正常終了:
- ZTP処理が最後まで正常に終了した状態。基本モード、NM Readyモードともにこの状態になる。
- ZTP異常終了:
内部エラー(メモリ取得エラー等)でZTP処理の継続が不可能になった状態。
- ZTP処理キャンセル:
ZTP処理中のコンフィグ変更やstartup-config書き換えで、ユーザー操作によりZTP処理が終了した状態。
- ZTP処理無効中:
ZTP機能の無効化コマンド(nm provisioning disable)が設定されている状態。
- リロード時のLED制御(※1)
- + ZTPスイッチ ONまたは[nm provisioning enable]設定: 緑点滅(1秒周期)+ ZTPスイッチ OFFかつ[nm provisioning enable]未設定: 消灯+ nm provisioning disable設定: 消灯
3.3.2. VPN、PPP、BAKのLED
NetMeister 認証中&リトライ中
NetMeister ダウンロード中&リトライ中
回線設定(nm ip/ipv6 enable)
VPN
PPP
BAK
VPN
PPP
BAK
IPv6 (NGN 閉域網経由)
点滅
点灯
点灯
点灯
点灯
点灯
IPv4 (DHCP)
点滅
点滅
点滅
点灯
点滅
点滅
3.3.3. PWRのLED
- 装置運用可能/不可能:
- 起動時に使用したコンフィグファイル(startup-configまたはdefault-config)で、GE0のすべてのインタフェースがshutdownなら運用不可能、GE0のいずれかのインタフェースがno shutdownなら運用可能。
3.4. 統計情報・メッセージ
3.4.1. エラーログ
ZTP処理によるstartup-config更新時、および再起動時、正常終了時、キャンセル時、異常終了時、それぞれエラーログへの記録を行う。
startup-config更新時(Erase/ Modify)
再起動時
INFO: ZTP requested reboot
正常終了時
- 基本モード
INFO: ZTP process has succeeded
- 基本モード(ダウンロードなし)
INFO: ZTP process has finished since configuration is already applied and saved
- NM Readyモード
INFO: ZTP process has succeeded in NM Ready mode
異常終了時
INFO: ZTP process has abnormal terminated by Cause
各斜体文字にはそれぞれ以下の値が入ります。Cause:“download configuration save failed”(ダウンロードコンフィグの保存失敗)“download configuration apply failed”(ダウンロードコンフィグの適用失敗)“internal data save failed”(ZTP関連情報の書き込み失敗)“internal memory get failed”(内部メモリ取得失敗)“config process occupy failed”(コンフィグ権限占有失敗)“command execution failed”(コマンド実行失敗)“internal error”(上記以外の内部エラー)
キャンセル時
INFO: ZTP process has been canceled
注釈
3.4.2. ZTP処理中の無条件表示ログ
以下のログを無条件でコンソール表示する。
ZTP機能開始メッセージ
IX-R/ZTP: Start ZTP process. (ID: 000000000000#IX_R#IX-R2530#123456789A)
IPアドレス設定メッセージ
IX-R/ZTP: Address-Family address has been assigned by Type, Interface
各斜体文字にはそれぞれ以下の値が入ります。Address-Family: IPv4 / IPv6Type: User config / DHCP / PD / RAInterface: GigaEthernet0.x
注釈
NetMeister接続開始メッセージ
IX-R/ZTP: Start connecting to NetMeister server with Connection-Type.
各斜体文字にはそれぞれ以下の値が入ります。Connection-Type: IPv4 / IPv6(Closed NGN)
認証完了メッセージ
IX-R/ZTP: Authentication succeeded with Connection-Type.
各斜体文字にはそれぞれ以下の値が入ります。Connection-Type: IPv4 / IPv6(Closed NGN)
コンフィグダウンロード開始メッセージ
IX-R/ZTP: Start configuration download from NetMeister server.
コンフィグダウンロード完了メッセージ
IX-R/ZTP: Configuration download completed.
ダウンロードコンフィグの保存成功メッセージ
IX-R/ZTP: Configuration has been saved.
コンフィグ保存ありモード時の装置再起動メッセージ
IX-R/ZTP: Reboot router.
コンフィグ保存なしモード時の装置再起動メッセージ
IX-R/ZTP: Configuration requires reboot.
ダウンロードコンフィグの適用成功メッセージ
IX-R/ZTP: Configuration has been applied.
ZTP機能正常終了メッセージ
基本モードとNM Readyモードでメッセージは異なります。IX-R/ZTP: ZTP process has succeeded.IX-R/ZTP: ZTP process has succeeded in NM Ready mode.
認証エラーメッセージ
IX-R/ZTP: Authentication failed (Cause).
各斜体文字にはそれぞれ以下の値が入ります。Cause:code XXX(NetMeisterサーバーからのエラーステータス)timeout(無応答タイムアウト)invalid data received(不正なデータ受信)cert verify error(証明書インストール失敗または、証明書検証NG)
コンフィグダウンロードエラーメッセージ
IX-R/ZTP: Configuration download failed (Cause).
各斜体文字にはそれぞれ以下の値が入ります。Cause:code XXX(NetMeisterサーバーからのエラーステータス)timeout(無応答タイムアウト)invalid data received(不正なデータ受信)cert verify error(証明書検証NG)
処理一時停止メッセージ
IX-R/ZTP: ZTP process has been suspended.
処理再開メッセージ
IX-R/ZTP: ZTP process has been resumed.
ZTP機能異常終了メッセージ
IX-R/ZTP: ZTP process has abnormal terminated by Cause.
各斜体文字にはそれぞれ以下の値が入ります。Cause:download configuration save failed(ダウンロードコンフィグの保存失敗)download configuration apply failed(ダウンロードコンフィグの適用失敗)internal data save failed(ZTP関連情報の書き込み失敗)internal memory get failed(内部メモリ取得失敗)config process occupy failed(コンフィグ権限占有失敗)command execution failed(コマンド実行失敗)internal error(上記以外の内部エラー)
ZTP機能キャンセルメッセージ
IX-R/ZTP: ZTP process has been canceled.
ZTP処理時間超過メッセージ
IX-R/ZTP: ZTP process delays.
ZTP機能正常終了メッセージ(通常モード(ダウンロードなし))
IX-R/ZTP: ZTP process has finished since configuration is already applied and saved.