はじめに
NSO 5.4 から REST API が使用できなくなりました。本ドキュメントはアップグレード際の注意喚起、および RESTCONF API への移行の情報を取りまとめたものです。
REST API のサポート終了について
NSO 5.4 の CHANGS にある通り REST API は NSO では使用できなくなりました。REST API は RFC 8040 で定義されている RESTCONF API より古いもので、近年 NSO では非推奨となっておりました。
NSO-5.4 [June 26, 2020]
=======================
(snip)
Removals:
(snip)
- rest-api: The REST API has been removed.
NOTE: When upgrading, any 'rest' specific configuration in the
ncs.conf file has to be removed.
(ENG-20522)
そのため弊社としては標準化された RESTCONF API への移行を推奨しており、今回の変更は NSO 5.1 の CHANGES で予告(当初は NSO 5.3 から非サポート)されていたものです。
NSO-5.1 [April 11, 2019]
========================
Deprecated:
(snip)
- rest-api: The REST API is deprecated and will be removed in NSO-5.3.
Users of the REST API should use the RESTCONF API instead,
see NSO Northbound APIs: Migrating from REST to the
RESTCONF API.
(ENG-20521)
RESTCONF API への移行について
NSO 5.3.x 以前のドキュメント『Northbaound APIs』に『Migraing from REST to the RESTCONF API』と言う章が掲載されています。
このドキュメントは REST API と RESTCONF API の違いについて説明しており、REST API から RESTCONF API に移行する際に対応が必要な違いについても解説しています。
REST API を使用する必要がある場合の対処について
NSO 5.4 以降 REST API は非サポートと言うだけでなく、利用そのものが出来なくなっています。
もし、古いリリースから 5.4 台へのアップグレードを検討される中で、現在 REST API を使用したシステムをご利用で、且つ RESTCONF API の移行がすぐに行えないといった条件下では NSO 5.3.x 以前のリリースをご利用ください。
ただし、NSO 5.3.x をご利用になる場合でも、長期的な視点で RESTCONF API への移行をご検討する事を推奨いたします。
作成日:2020 年 07 月 31 日
修正日:---- 年 -- 月 -- 日