Cisco IOS XE Everest 16.6.x プログラマビリティコンフィギュレーションガイド

NETCONF プロトコルの制約事項

NETCONF 機能は、デュアル IOSd 設定またはソフトウェア冗長性を実行中のデバイスではサポートされていません。

NETCONF プロトコルの概要

データモデルの概要：プログラムによる設定と各種の標準規格に準拠した設定

ネットワークデバイスを管理する従来の方法は、階層的データ（設定コマンド）および運用データ（show コマンド）用のコマンドラインインターフェイス（CLI）を使用することです。ネットワーク管理の場合、特にさまざまなネットワークデバイス間で管理情報を交換するために、Simple Network Management Protocol（SNMP）が広く使用されています。頻繁に使用されている CLI と SNMP ですが、これにはいくつかの制約事項があります。CLI は非常に独自的であり、テキストベースの仕様を理解し、解釈するには人間の介入が必要です。SNMP は、階層的データと運用データを区別しません。

これを解決するには、手作業で設定作業を行うのではなく、プログラムを使用したり、各種の標準規格に準拠してネットワークデバイスの設定を記述します。Cisco IOS XE で動作するネットワークデバイスは、データモデルを使用するネットワーク上の複数のデバイスの設定の自動化をサポートしています。データモデルは、業界で定義された標準的な言語で開発され、ネットワークの設定とステータス情報を定義できます。

Cisco IOS XE は、Yet Another Next Generation（YANG）データモデリング言語をサポートしています。YANG をネットワーク設定プロトコル（NETCONF）で使用すると、自動化されたプログラミング可能なネットワーク操作の望ましいソリューションが実現します。NETCONF（RFC 6241）は、クライアントアプリケーションがデバイスからの情報を要求してデバイスに設定変更を加えるために使用する XML ベースのプロトコルです。YANG は主に、NETCONF 操作で使用される設定とステートデータをモデル化するために使用されます。

Cisco IOS XE では、モデルベースのインターフェイスは、既存のデバイス CLI、Syslog、および SNMP インターフェイスと相互運用します。必要に応じて、これらのインターフェイスは、ネットワークデバイスからノースバウンドに公開されます。YANG は、RFC 6020 に基づいて各プロトコルをモデル化するために使用されます。

（注）

開発者に分かりやすい方法で Cisco YANG モデルにアクセスするには、GitHub リポジトリを複製し、vendor/cisco サブディレクトリに移動します。ここでは、IOS XE、IOS-XR、および NX-OS プラットフォームのさまざまなリリースのモデルを使用できます。

NETCONF

NETCONF は、ネットワークデバイスの設定をインストール、操作、削除するためのメカニズムです。

コンフィギュレーションデータとプロトコルメッセージに Extensible Markup Language（XML）ベースのデータ符号化を使用します。

NETCONF はシンプルなリモートプロシージャコール（RPC）ベースのメカニズムを使用してクライアントとサーバ間の通信を促進します。クライアントはネットワークマネージャの一部として実行されているスクリプトやアプリケーションです。通常、サーバはネットワークデバイス（スイッチまたはルータ）です。サーバは、ネットワークデバイス全体のトランスポート層としてセキュアシェル（SSH）を使用します。SSH ポート番号 830 をデフォルトのポートとして使用します。ポート番号は、設定可能なオプションです。

NETCONF は、機能の検出およびモデルのダウンロードもサポートしています。サポート対象のモデルは、ietf-netconf-monitoring モデルを使用して検出されます。各モデルに対する改定日付は、機能の応答に示されています。データモデルは、get-schema RPC を使用して、デバイスからオプションのダウンロードとして入手できます。これらの YANG モデルを使用して、データモデルを理解したりエクスポートしたりできます。NETCONF の詳細については、RFC 6241 を参照してください。

Cisco IOS XE Fuji 16.8.1 よりも前のリリースでは、運用データマネージャ（ポーリングに基づく）が個別に有効になっていました。Cisco IOS XE Fuji 16.8.1 以降のリリースでは、運用データは、NETCONF を実行しているプラットフォームで動作し（設定データの仕組みと同様）、デフォルトで有効になっています。運用データのクエリまたはストリーミングに対応するコンポーネントの詳細については、GitHub リポジトリで命名規則の *-oper を参照してください。

NETCONF RESTCONF IPv6 のサポート

データモデルインターフェイス（DMI）は IPv6 プロトコルの使用をサポートしています。DMI による IPv6 のサポートは、クライアントアプリケーションが、IPv6 アドレスを使用するサービスと通信する場合に役に立ちます。外部向けインターフェイスは、IPv4 と IPv6 の両方についてデュアルスタックをサポートします。

DMI は、ネットワーク要素の管理を容易にする一連のサービスです。NETCONF や RESTCONF などのアプリケーション層プロトコルは、ネットワークを介してこれらの DMI にアクセスします。

IPv6 アドレスが設定されていない場合でも、外部向けアプリケーションは IPv6 ソケットをリッスンし続けますが、これらのソケットは到達不能になります。

NETCONF グローバルセッションのロック

NETCONF プロトコルは、デバイス設定を管理し、デバイスの状態情報を取得するための一連の操作を提供します。NETCONF はグローバルロックをサポートしており、NETCONF では応答しなくなったセッションを kill する機能が導入されています。

複数の同時セッションの全体にわたって一貫性を確保し、設定の競合を防ぐために、セッションのオーナーは NETCONF セッションをロックできます。NETCONF lock RPC は、コンフィギュレーションパーサーと実行コンフィギュレーションデータベースをロックします。その他のすべての NETCONF セッション（ロックを所有していない）は、編集操作を実行できません。ただし、読み取り操作は実行できます。これらのロックは存続時間が短いことを意図しており、オーナーは、他の NETCONF クライアント、NETCONF 以外のクライアント（SNMP、CLI スクリプトなど）、および人間のユーザとやり取りをせずに変更を加えることができます。

アクティブセッションによって保持されているグローバルロックは、関連付けられたセッションが kill されたときに無効になります。ロックによって、ロックを保持しているセッションが、設定に対して排他的な書き込みアクセスを行えるようになります。グローバルロックにより設定の変更が拒否された場合は、エラーメッセージによって、NETCONF グローバルロックが原因で設定の変更が拒否されたことが示されます。

<lock> 操作は必須パラメータ <target> を受け取ります。これは、ロックしようとするコンフィギュレーションデータストアの名前です。ロックがアクティブな場合、<edit-config> 操作と <copy-config> 操作は許可されません。

NETCONF のグローバルロックの保持中に clear configuration lock コマンドが指定された場合は、設定の完全な同期がスケジュールされ、警告の syslog メッセージが生成されます。このコマンドは、パーサーコンフィギュレーションロックのみをクリアします。

次に、<lock> 操作を示す RPC の例を示します。


<rpc message-id="101"
          xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
       <lock>
         <target>
           <running/>
         </target>
       </lock>
</rpc>

NETCONF Kill セッション

セッションの競合時、またはクライアントによるグローバルロックの誤用が生じたときは、show netconf-yang sessions コマンドを使用して NETCONF セッションをモニタできます。また、clear netconf-yang session コマンドを使用して応答しなくなったセッションをクリアすることもできます。clear netconf-yang session コマンドは、NETCONF ロックとコンフィギュレーションロックの両方をクリアします。

<kill-session> 要求は、NETCONF セッションを強制的に終了します。NETCONF エンティティは、オープンセッションの <kill-session> 要求を受信すると、プロセス内のすべての操作を停止し、セッションに関連付けられているすべてのロックとリソースを解放して、関連付けられた接続をすべて閉じます。

<kill-session> 要求には、終了する NETCONF セッションのセッション ID が必要です。セッション ID の値が現在のセッション ID と同じ場合は、無効な値を示すエラーが返されます。NETCONF セッションのトランザクションがまだ進行中に NETCONF セッションが終了した場合は、データモデルインフラストラクチャによってロールバックが要求され、ネットワーク要素にロールバックが適用されて、すべての YANG モデルの同期がトリガーされます。

セッションの kill が失敗し、グローバルロックが保持されている場合は、コンソールまたは vty を使用して clear configuration lock コマンドを入力します。この時点で、データモデルを停止して再起動することができます。

NETCONF プロトコルの設定方法

NETCONF-YANG は、デバイスのプライマリトラストポイントを使用します。トラストポイントが存在しない場合に NETCONF-YANG が設定されると、自己署名トラストポイントが作成されます。詳細については、『 公開キーインフラストラクチャコンフィギュレーションガイド（Cisco IOS XE Gibraltar 16.10.x 向け）』を参照してください。

NETCONF を使用するための権限アクセスの提供

NETCONF API の使用を開始するには、権限レベル 15 を持つユーザである必要があります。そのようにするには、次の作業を行います。

手順

	コマンドまたはアクション	目的
ステップ 1	enable 例: `Device# enable`	特権 EXEC モードを有効にします。パスワードを入力します（要求された場合）。
ステップ 2	configure terminal 例: `Device# configure terminal`	グローバルコンフィギュレーションモードを開始します。
ステップ 3	username `name` privilege `level` password `password` 例: `Device(config)# username example-name privilege 15 password example_password`	ユーザ名をベースとした認証システムを確立します。次のキーワードを設定します。 privilege `level` ：ユーザの権限レベルを設定します。プログラマビリティ機能の場合は、15 にする必要があります。 password `password` ：CLI ビューにアクセスするためのパスワードを設定します。
ステップ 4	aaa authentication login default local および aaa authorization exec default local 例: `Device (config)# aaa authentication login default local Device (config)# aaa authorization exec default local`	（任意）aaa new-model を設定する場合は、 AAA 認証および許可が必要です。リモート AAA サーバの場合は、local を AAA サーバに置き換えます。
ステップ 5	end 例: `Device (config)# end`	グローバルコンフィギュレーションモードを終了します。

NETCONF-YANG の設定

レガシー NETCONF プロトコルがデバイスで有効になっている場合、RFC 準拠の NETCONF プロトコルは機能しません。no netconf legacy コマンドを使用してレガシー NETCONF プロトコルを無効にしてください。

手順

コマンドまたはアクション目的

ステップ 1

enable

例:

Device> enable

特権 EXEC モードを有効にします。

パスワードを入力します（要求された場合）。

ステップ 2

configure terminal

例:

Device# configure terminal

グローバルコンフィギュレーションモードを開始します。

ステップ 3

netconf-yang

例:

Device (config)# netconf-yang

ネットワークデバイスで NETCONF インターフェイスを有効にします。

（注）

CLI による最初のイネーブル化の後、ネットワークデバイスをモデルベースのインターフェイスを通じて管理できるようになります。モデルベースのインターフェイスプロセスの完全なアクティベーションには、最大 90 秒かかることがあります。

ステップ 4

netconf-yang feature candidate-datastore

例:

Device(config)# netconf-yang feature candidate-datastore

候補データストアを有効にします。

ステップ 5

exit

例:

Device (config)# exit

グローバルコンフィギュレーションモードを終了します。

NETCONF オプションの設定

SNMP の設定

NETCONF を有効にして、サポートされている MIB から生成された YANG モデルを使用して SNMP MIB データにアクセスしたり、IOS でサポートされている SNMP トラップを有効にして、サポートされているトラップから NETCONF 通知を受信するには、IOS で SNMP サーバを有効にします。

次の操作を行ってください。

手順

ステップ 1

IOS で SNMP 機能を有効にします。

例:

configure terminal
logging history debugging
logging snmp-trap emergencies
logging snmp-trap alerts
logging snmp-trap critical
logging snmp-trap errors
logging snmp-trap warnings
logging snmp-trap notifications
logging snmp-trap informational
logging snmp-trap debugging
!
snmp-server community public RW
snmp-server trap link ietf
snmp-server enable traps snmp authentication linkdown linkup 
snmp-server enable traps syslog
snmp-server manager
exit

ステップ 2

NETCONF-YANG が起動した後、次の RPC <edit-config> メッセージを NETCONF-YANG ポートに送信して、SNMP トラップのサポートを有効にします。

例:

<?xml version="1.0" encoding="utf-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="">
  <edit-config>
    <target>
      <running/>
    </target>
    <config>
      <netconf-yang xmlns="http://cisco.com/yang/cisco-self-mgmt">
        <cisco-ia xmlns="http://cisco.com/yang/cisco-ia">
          <snmp-trap-control>
            <trap-list>
              <trap-oid>1.3.6.1.4.1.9.9.41.2.0.1</trap-oid>
            </trap-list>
            <trap-list>
              <trap-oid>1.3.6.1.6.3.1.1.5.3</trap-oid>
            </trap-list>
            <trap-list>
              <trap-oid>1.3.6.1.6.3.1.1.5.4</trap-oid>
            </trap-list>
          </snmp-trap-control>
        </cisco-ia>
      </netconf-yang>
    </config>
  </edit-config>
</rpc>

ステップ 3

次の RPC メッセージを NETCONF-YANG ポートに送信して、実行コンフィギュレーションをスタートアップコンフィギュレーションに保存します。

例:

<?xml version="1.0" encoding="utf-8"?>
<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="">
  <cisco-ia:save-config xmlns:cisco-ia="http://cisco.com/yang/cisco-ia"/>
</rpc>

NETCONF プロトコルのコンフィギュレーションの確認

NETCONF コンフィギュレーションを確認するには次のコマンドを使用します。

手順

ステップ 1

show netconf-yang datastores

NETCONF-YANG データストアに関する情報を表示します。

例:

Device# show netconf-yang datastores

Device# show netconf-yang datastores
Datastore Name : running
Globally Locked By Session : 42
Globally Locked Time : 2018-01-15T14:25:14-05:00

ステップ 2

show netconf-yang sessions

NETCONF-YANG セッションに関する情報を表示します。

例:

Device# show netconf-yang sessions

R: Global-lock on running datastore
C: Global-lock on candidate datastore
S: Global-lock on startup datastore
Number of sessions : 10
session-id transport username source-host global-lock
-------------------------------------------------------------------------------
40 netconf-ssh admin 10.85.70.224 None
42 netconf-ssh admin 10.85.70.224 None
44 netconf-ssh admin 10.85.70.224 None
46 netconf-ssh admin 10.85.70.224 None
48 netconf-ssh admin 10.85.70.224 None
50 netconf-ssh admin 10.85.70.224 None
52 netconf-ssh admin 10.85.70.224 None
54 netconf-ssh admin 10.85.70.224 None
56 netconf-ssh admin 10.85.70.224 None
58 netconf-ssh admin 10.85.70.224 None

ステップ 3

show netconf-yang sessions detail

NETCONF-YANG セッションに関する詳細情報を表示します。

例:

Device# show netconf-yang sessions detail
  
R: Global-lock on running datastore
C: Global-lock on candidate datastore
S: Global-lock on startup datastore
 
Number of sessions     : 1
 
session-id             : 19
transport              : netconf-ssh
username               : admin
source-host            : 2001:db8::1
login-time             : 2018-10-26T12:37:22+00:00
in-rpcs                : 0
in-bad-rpcs            : 0
out-rpc-errors         : 0
out-notifications      : 0
global-lock            : None

ステップ 4

show netconf-yang statistics

NETCONF-YANG 統計に関する情報を表示します。

例:

Device# show netconf-yang statistics

netconf-start-time : 2018-01-15T12:51:14-05:00
in-rpcs : 0
in-bad-rpcs : 0
out-rpc-errors : 0
out-notifications : 0
in-sessions : 10
dropped-sessions : 0
in-bad-hellos : 0

ステップ 5

show platform software yang-management process

NETCONF-YANG のサポートに必要なソフトウェアプロセスのステータスを表示します。

例:

Device# show platform software yang-management process 

confd            : Running 
nesd             : Running 
syncfd           : Running 
ncsshd           : Running 
dmiauthd         : Running 
vtyserverutild   : Running 
opdatamgrd       : Running 
nginx            : Running 
ndbmand          : Running

（注）

プロセス nginx は、ip http secure-server または ip http server がデバイスで設定されている場合に実行されます。このプロセスが「実行」状態でなくても NETCONF は正常に機能します。ただし、RESTCONF には nginx プロセスが必要です。

表 1. show platform software yang-management process のフィールドの説明
フィールド	説明
confd	コンフィギュレーションデーモン
nesd	ネットワーク要素シンクロナイザデーモン
syncfd	デーモンからの同期
ncsshd	NETCONF セキュアシェル（SSH）デーモン
dmiauthd	デバイス管理インターフェイス（DMI）認証デーモン
vtyserverutild	VTY サーバユーティリティデーモン
opdatamgrd	運用データマネージャデーモン
nginx	NGINX Web サーバ
ndbmand	NETCONF データベースマネージャ

NETCONF プロトコルの関連資料

関連項目	マニュアルタイトル
IOS-XE、IOS-XR、および NX-OS プラットフォームのさまざまなリリースの YANG データモデル	開発者に分かりやすい方法で Cisco YANG モデルにアクセスするには、GitHub リポジトリを複製し、vendor/cisco サブディレクトリに移動します。ここでは、IOS XE、IOS-XR、および NX-OS プラットフォームのさまざまなリリースのモデルを使用できます。

標準および RFC


標準/RFC	タイトル
RFC 6020	YANG：Network Configuration Protocol（NETCONF）向けデータモデリング言語
RFC 6241	ネットワーク設定プロトコル（NETCONF）
RFC 6536	ネットワーク設定プロトコル（NETCONF）アクセス制御モデル
RFC 8040	RESTCONF プロトコル

シスコのテクニカルサポート


説明	リンク
シスコのサポート Web サイトでは、シスコの製品やテクノロジーに関するトラブルシューティングにお役立ていただけるように、マニュアルやツールをはじめとする豊富なオンラインリソースを提供しています。お使いの製品のセキュリティ情報や技術情報を入手するために、Cisco Notification Service（Field Notice からアクセス）、Cisco Technical Services Newsletter、Really Simple Syndication（RSS）フィードなどの各種サービスに加入できます。シスコのサポート Web サイトのツールにアクセスする際は、Cisco.com のユーザ ID およびパスワードが必要です。	http://www.cisco.com/support

NETCONF プロトコルの機能情報

次の表に、このモジュールで説明した機能に関するリリース情報を示します。この表は、ソフトウェアリリーストレインで各機能のサポートが導入されたときのソフトウェアリリースだけを示しています。その機能は、特に断りがない限り、それ以降の一連のソフトウェアリリースでもサポートされます。

プラットフォームのサポートおよびシスコソフトウェアイメージのサポートに関する情報を検索するには、Cisco Feature Navigator を使用します。Cisco Feature Navigator にアクセスするには、www.cisco.com/go/cfn に移動します。Cisco.com のアカウントは必要ありません。

表 2. NETCONF プロトコルの機能情報
機能名	リリース	機能情報
候補コンフィギュレーションサポート	Cisco IOS XE Fuji 16.9.1	候補コンフィギュレーションサポート機能を使用すると、シンプルなコミットオプションを使用して RFC 6241 を実装することによって、候補機能をサポートできます。この機能は、次のプラットフォームに実装されていました。 Cisco ASR 1000 シリーズアグリゲーションサービスルータ Cisco ASR 900 シリーズアグリゲーションサービスルータ Cisco Catalyst 3650 シリーズスイッチ Cisco Catalyst 3850 シリーズスイッチ Cisco Catalyst 9300 シリーズスイッチ Cisco Catalyst 9400 シリーズスイッチ Cisco Catalyst 9500 シリーズスイッチ Cisco CBR-8 シリーズルータ Cisco Cloud Services Router 1000V シリーズ Cisco ISR 4000 シリーズサービス統合型ルータ次のコマンドが導入されました：netconf-yang feature candidate-datastore
NETCONF プロトコル	Cisco IOS XE Denali 16.3.1	NETCONF プロトコル機能によって、プログラムによる各種の標準規格に準拠した方法で、設定の記述やネットワークデバイスからの運用データの読み取りが容易になります。次のコマンドが導入されました：netconf-yang
	Cisco IOS XE Everest 16.5.1a	この機能は、Cisco Catalyst 9300 シリーズスイッチと Cisco Catalyst 9500 シリーズスイッチに実装されました。
	Cisco IOS XE Everest 16.6.2	この機能は、Cisco Catalyst 9400 シリーズスイッチに実装されました。
	Cisco IOS XE Fuji 16.7.1	この機能は、次のプラットフォームに実装されていました。 Cisco ASR 900 シリーズアグリゲーションサービスルータ Cisco ASR 920 シリーズアグリゲーションサービスルータ Cisco Network Convergence System 4200 シリーズ
	Cisco IOS XE Fuji 16.8.1a	この機能は、Cisco Catalyst 9500 ハイパフォーマンスシリーズスイッチに実装されていました。
NETCONF および RESTCONF IPv6 のサポート	Cisco IOS XE Fuji 16.8.1a	この機能は、次のプラットフォームに実装されていました。 Cisco ASR 1000 シリーズアグリゲーションサービスルータ Cisco ASR 900 シリーズアグリゲーションサービスルータ Cisco Catalyst 3650 シリーズスイッチ Cisco Catalyst 3850 シリーズスイッチ Cisco Catalyst 9300 シリーズスイッチ Cisco Catalyst 9400 シリーズスイッチ Cisco Catalyst 9500 シリーズスイッチ Cisco CBR-8 シリーズルータ Cisco CSR 1000v スイッチ Cisco ISR 1100 シリーズサービス統合型ルータ Cisco ISR 4000 シリーズサービス統合型ルータ
NETCONF グローバルロックおよびセッションの kill	Cisco IOS XE Fuji 16.8.1a	この機能は、次のプラットフォームに実装されていました。 Cisco ASR 1000 シリーズアグリゲーションサービスルータ Cisco ASR 900 シリーズアグリゲーションサービスルータ Cisco Catalyst 3650 シリーズスイッチ Cisco Catalyst 3850 シリーズスイッチ Cisco Catalyst 9300 シリーズスイッチ Cisco Catalyst 9400 シリーズスイッチ Cisco Catalyst 9500 シリーズスイッチ Cisco CBR-8 シリーズルータ Cisco CSR 1000v スイッチ Cisco ISR 1100 シリーズサービス統合型ルータ Cisco ISR 4000 シリーズサービス統合型ルータ

Cisco IOS XE Everest 16.6.x プログラマビリティ コンフィギュレーション ガイド

Bias-Free Language

Results

Chapter: NETCONF プロトコル

NETCONF プロトコル

NETCONF プロトコルの制約事項

NETCONF プロトコルの概要

データ モデルの概要：プログラムによる設定と各種の標準規格に準拠した設定

NETCONF

NETCONF RESTCONF IPv6 のサポート

NETCONF グローバル セッションのロック

NETCONF Kill セッション

NETCONF プロトコルの設定方法

NETCONF を使用するための権限アクセスの提供

手順

例:

例:

例:

例:

例:

NETCONF-YANG の設定

手順

例:

例:

例:

例:

例:

NETCONF オプションの設定

SNMP の設定

手順

例:

例:

例:

NETCONF プロトコルのコンフィギュレーションの確認

手順

例:

例:

例:

例:

例:

NETCONF プロトコルの関連資料

関連資料

標準および RFC

シスコのテクニカル サポート

NETCONF プロトコルの機能情報

Was this Document Helpful?

Contact Cisco

データモデルの概要：プログラムによる設定と各種の標準規格に準拠した設定

NETCONF グローバルセッションのロック

シスコのテクニカルサポート