# 3. ゼロタッチプロビジョニング

## 3.1. はじめに

### 3.1.1. ゼロタッチプロビジョニング(ZTP)概要

ゼロタッチプロビジョニング（以下「ZTP」）機能は、NetMeisterとの連携により装置コンフィグのプロビジョニング（ネットワーク接続環境の構築）を設置場所でのコンフィグ操作なしで実現する機能です。
事前にNetMeisterにコンフィグ等を登録し設置場所でZTP機能を有効にして起動することで、自動でNetMeisterに接続を行い登録されたコンフィグをダウンロード・適用して動作させることができます。
NetMeisterでの設定等はNetMeisterのマニュアルをご確認ください。

図 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以外のポートには対応していません。

- NGN閉域網を使用した構成でZTP対象の統合ルータの前段にルータを挟んで接続をする場合、ZTP対象のルータにあらかじめ nm ipv6 enable ngn-private east/west の設定をしておく必要があります。

- NM Readyモードは未サポートです。

## 3.2. 設定の流れ

### 3.2.1. NetMeisterへの装置登録

ZTPを利用するにはNetMeisterに以下の情報を登録する必要があります。
1. 装置に設定するコンフィグ
2. 装置のMACアドレス、シリアル番号（装置のゼロタッチプロビジョニング装置登録用QRコード読み取りで簡単登録可能）
3. 1と2の情報の紐づけ

注釈

- NetMeisterに登録後、設定した有効期間以内にZTPにより装置にコンフィグをダウンロードする必要があります。

- 有効期間を過ぎた場合は再度NetMeisterに登録してください。

#### 3.2.1.1. ZTP接続IDの確認

ZTP接続IDはZTPで利用する装置識別IDです。ZTP機能によるNetMeisterサーバー接続時に認証用データとしてZTP接続IDを送信します。
ZTP接続IDはIX-Rルータに固有に割り振られており、次の方法で確認することができます。

show hardwareコマンド

  ZTP機能の有効無効に関わらず常に表示されます。

nm provisioning enableコマンド入力時

  入力後にCLIに表示されます。

#### 3.2.1.2. IX-RルータのMACアドレスとシリアル番号の登録

現品のMACアドレスとシリアル番号を確認し、紐づけ情報にMACアドレスとシリアル番号をNetMeisterに登録します。
装置にゼロタッチプロビジョニング装置登録用QRコードが貼っていれば、スマートフォンで読み取ることでそのままNetMeisterへアクセスして登録することができます。

### 3.2.2. ZTPの有効化設定

以下のいずれかの条件を満たしている場合にZTPが有効になります。

1. ZTPスイッチがONになっている

   > ZTPスイッチのある装置の場合、ZTPスイッチをONにすることでZTPが有効になります。
   > 装置にCLIやWebGUIでのコンフィグ設定は必要ありません。その状態で装置を起動するとZTPが起動します。

2. 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の起動後の動作

ZTP を有効にし装置を起動すると、NetMeisterサーバーへ接続するためのコンフィグが一時的に設定され、NetMeisterサーバーに接続します。
認証に成功すると NetMeisterサーバーから登録済のコンフィグをダウンロードし反映します

図 3.2.1 ZTPの起動後の動作フロー

1. 装置を起動します。
2. ZTP 機能が有効であるか判定します。無効であれば通常どおりに起動します。
3. NetMeister サーバーと通信するためのコンフィグを自動で設定します。
4. NetMeister サーバーへの認証およびコンフィグのダウンロードを行います。
5. ダウンロードしたコンフィグを装置の startup-config に差し替え・保存します。コンフィグに差分がなければ再起動を行いません。
6. 装置を再起動します。
7. 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の動作パターン

ZTPの有効化のために、以下を行います。

> - ZTPスイッチをONまたはコンフィグにnm provisioning enableを設定します。

#### 3.2.5.1. 最初の起動時のみコンフィグをダウンロード

最初の起動時のみにZTP機能が動作し、それ以降の起動にはZTP機能を使用しない動作パターンです。
この方法を行うには以下の状態である必要があります。

> - 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. ダウンロードしたコンフィグを装置に保存しない

通常はNetMeisterからダウンロードしたコンフィグを装置に保存しますが、コンフィグを保存せずに運用することもできます。
その場合の運用は、装置を起動するたびに毎回NetMeisterからコンフィグをダウンロードし適用します。
この方法を行うには以下の設定が必要です。

> - ダウンロードコンフィグに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.2 コンフィグ設定や装置情報を事前に紐づけ済の運用準備フロー図

#### 3.2.6.2. コンフィグを事前登録し、装置情報の紐づけを現地で行う運用準備フロー

図 3.2.3 コンフィグを事前登録し、装置情報の紐づけを現地で行う運用準備フロー図

#### 3.2.6.3. 直接現地で ZTP を使用する場合の運用準備フロー

図 3.2.4 直接現地で ZTP を使用する場合の運用準備フロー図

## 3.3. LED

### 3.3.1. ZTP LED

ZTPスイッチがある装置の場合、ZTPのLEDによりZTP処理状態を通知します。
ZTP機能が有効な場合、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

ZTP処理中はVPN、PPP、BAKのLEDによってZTPの状態を表します。
WAN接続モード、接続フェーズ、接続エラーを通知します。
ZTP処理開始前とZTP処理終了後(正常・異常関係なく)は本来のLED表示に戻ります。

> | NetMeister 認証中&リトライ中 | NetMeister ダウンロード中&リトライ中
> --- | --- | ---
> 回線設定(nm ip/ipv6 enable) | VPN | PPP | BAK | VPN | PPP | BAK
> IPv6 (NGN 閉域網経由) | 点滅 | 点灯 | 点灯 | 点灯 | 点灯 | 点灯
> IPv4 (DHCP) | 点滅 | 点滅 | 点滅 | 点灯 | 点滅 | 点滅

### 3.3.3. PWRのLED

PWRのLEDはZTP異常終了/処理時間超過時の装置運用状態を表します。
PWRのLEDが赤点滅(1秒周期)の場合、装置運用不可能となります。

- 装置運用可能/不可能：
    起動時に使用したコンフィグファイル(startup-configまたはdefault-config)で、
    GE0のすべてのインタフェースがshutdownなら運用不可能、
    GE0のいずれかのインタフェースがno shutdownなら運用可能。

## 3.4. 統計情報・メッセージ

### 3.4.1. エラーログ

ZTP処理によるstartup-config更新時、および再起動時、正常終了時、キャンセル時、異常終了時、それぞれエラーログへの記録を行う。

startup-config更新時(Erase/ Modify)

INFO: Erase startup-config cmd:erase state:succeeded from:@ZTP
INFO: Modify startup-config cmd:write state:succeeded from:@ZTP

再起動時

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

注釈

同じ種別のエラーログは最新のログで上書きされます。
特にstartup-config更新はZTP以外の機能で更新された場合も上書きされるためご注意ください。

### 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 / IPv6
> Type: User config / DHCP / PD / RA
> Interface: GigaEthernet0.x

注釈

両方接続時はそれぞれのログが出力されます。
IPアドレスを取得するタイミングによってはZTP処理の途中で表示される場合もあります。

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.