Cisco Nexus 9000 Series NX-OS Programmability Guide、リリース 10.2(x)

About gNOI

gRPC Network Operations Interface (gNOI) defines a set of gRPC-based micro-services for executing operational commands on network devices. The operational commands supported are Ping, Traceroute, Time, SwitchControlProcessor, Reboot, RebootStatus, CancelReboot, Activate and Verify.

gNOI uses gRPC as the transport protocol and the configuration is same as that of gNMI. For details on configuration, please refer to Configuring gNMI.

To send gNOI RPC requests, user needs a client that implements the gNOI client interface for each RPC.

In Cisco NX-OS Release 10.1(1) the gNOI defines Remote Procedure Calls (RPCs) for a limited number of components and some of them related to hardware (like optical interfaces).

Proto files are defined for the gRPC micro-services and are available at GitHub.

サポートされる gNOI RPC

サポートされている gNOI RPC は次のとおりです。

表 1.
プロトコル	gNOI RPC	サポート対象
System	ping	〇
	トレースルート	はい
	時間	はい
	SwitchControl プロセッサ	はい
	リブート	はい
	RebootStatus	はい
	CancelReboot	はい
OS	アクティブ化	はい
OS	インターフェイス	はい
Cert	LoadCertificate	はい
File	get	はい
	Stat	はい
	削除	はい

システム proto

システム proto サービスは、設定およびテレメトリパイプラインの外部でターゲットを管理できるようにする操作可能な RPC のコレクションです。

次に、システム proto の RPC サポートの詳細を示します。


RPC	サポート	説明	制限事項
ping	ping/ping6 cli コマンド	ターゲットで ping コマンドを実行し、結果をストリームで返します。一部のターゲットでは、すべての結果が利用可能になるまで結果がストリーミングされない場合があります。パケット数が明示的に指定されていない場合は、5 が使用されます。	do_not_resolve オプションはサポートされていません。
トレースルート	traceroute/traceroute6 cli コマンド	ターゲットで traceroute コマンドを実行し、結果をストリームで返します。一部のターゲットでは、すべての結果が使用可能になるまで結果がストリーミングされない場合があります。最大ホップカウント 30 が使用されます。	itial_ttl、marx_ttl、wait、do_not_fragment、do_not_resolve、および l4protocol オプションはサポートされていません。
時間	ローカル時刻	ターゲットの現在の時刻を返します。通常、ターゲットが応答しているかどうかをテストするために使用されます。	-
SwitchControl プロセッサ	system switchover cli コマンド	現在のルートプロセッサから指定されたルートプロセッサに切り替えます。スイッチオーバーは即座に発生しますが、応答がクライアントに返されるとは保証されない場合があります。	スイッチオーバーは即座に発生します。その結果、応答がクライアントに返されるとは保証されない場合があります。
リブート	reload module	ターゲットをリブートします。	message オプションはサポートされません。delay オプションはスイッチのリロードでサポートされます。path オプションは 1 つのモジュール番号を受け入れます。
RebootStatus	show version [module] cli コマンド	ターゲットのリブートのステータスを返します。	-
CancelReboot	reload cancel	保留中のリブート要求をキャンセルします。	-

（注）

SetPackage RPC はサポートされていません。

OS プロトコル

OS サービスは、ターゲット上の OS インストールに対するインターフェイスを提供します。OS パッケージのファイルフォーマットは、プラットフォームによって異なります。プラットフォームは、提供された OS パッケージが有効でブート可能であることを検証する必要があります。これには、既知の正しいハッシュに対するハッシュチェックを含める必要があります。ハッシュは OS パッケージに埋め込むことをお勧めします。

ターゲットは、独自の永続ストレージと OS インストールプロセスを管理します。一連の個別の OS パッケージを保存し、新しい OS パッケージが届く場合に備えて、事前にスペースを解放します。ターゲットには、有効な新しい OS パッケージ用の十分なスペースが常にあることが保証されます。現在実行中の OS パッケージは削除しないでください。クライアントは、最後に正常にインストールされたパッケージが使用可能であることを想定して動作するからです。

次に、OS proto の RPC サポートの詳細を示します。


RPC	サポート	説明	制限事項
アクティブ化	install all nxos bootflash:///img_name	要求された OS バージョンを、次回のリブート時に使用されるバージョンとして設定します。この RPC は、ターゲットをリブートします。	リブートに失敗した場合、ロールバックまたは回復はできません。
検証	show version	[検証（Verify）] は、実行中の OS バージョンを確認します。この RPC は、ターゲットの起動中に成功するまで複数回呼び出される場合があります。	-

（注）

インストール RPC はサポートされていません。

証明書 Proto

証明書管理サービスは、ターゲットによってエクスポートされます。ローテーション、インストール、およびその他の証明書 Proto RPC はサポートされていません。

次に、証明書 proto の RPC サポートの詳細を示します。


RPC	サポート	説明	制限事項
LoadCertificate	crypto ca import <trustpoint> pkcs12 <file> <passphrase>	CA 証明書のバンドルをロードします。	-

ファイル Proto

ファイル proto は、file.proto RPC の機能に基づいてメッセージをストリーミングします。ここに記載されていない Put およびその他の RPC は、ファイル Proto ではサポートされていません。

Get、Stat、および Remove RPC は、bootflash、bootflash://sup-remote、logflash、logflash://sup-remote、usb、volatile、volatile://sup-remote、および debug のファイルシステムをサポートします。

次に、ファイル proto の RPC サポートの詳細を示します。


RPC	説明	制限事項
結果	Get はターゲットからファイルの内容を読み取り、ストリーミングします。ファイルは連続したメッセージによってストリーミングされます。各メッセージには最大 64 KB のデータが含まれます。最後のメッセージが送信された後、送信されたデータのハッシュが送信され、ストリームが閉じられます。ファイルが存在しない場合、またはファイルの読み取り中にエラーが発生した場合は、エラーが返されます。	ファイルサイズの上限は 32 MB です。
Stat	Stat は、ターゲット上のファイルに関するメタデータを返します。ファイルが存在しない場合、またはファイルのメタデータへのアクセス中にエラーが発生した場合は、エラーが返されます。	-
削除	Remove は、ターゲットから指定されたファイルを削除します。ファイルが存在しない場合、ディレクトリである場合、または削除操作でエラーが発生した場合は、エラーが返されます。	-

注意事項と制約事項

gNOI 機能には、次の注意事項と制約事項があります。

最大 16 のアクティブな gNOI RPC がサポートされます。
Cisco Nexus 9000 シリーズスイッチは、1 つの gNMI サービスと 2 つの gNOI マイクロサービスを持つ 1 つのエンドポイントを実行します。
10.1(1) リリースでは、gNOI RPC は同等の CLI を使用して実装されます。既存の CLI 制限または有効なオプションはそのまま適用されます。
10.2(1)F リリース以降、file.proto および cert.proto RPC がサポートされています。

gNOI の確認

gNOI の構成を確認するには、次のコマンドを入力します。


コマンド	説明
clear grpc gnoi rpc	カウンタまたは呼び出しをクリーンアップするために使用されます。
debug grpc events {events\|errors} show grpc nxsdk event-history {events\|errors}	イベント履歴からイベントとエラーをデバッグします。
show grpc internal gnoi rpc {summary\|detail}	有用性のために「internal 」キーワードコマンドが追加されました。

偏向のない言語

翻訳について

Book Title

Cisco Nexus 9000 Series NX-OS Programmability Guide、リリース 10.2(x)

Chapter Title

gNOI-gRPC ネットワーク操作インターフェイス

検索結果

章のタイトル： gNOI-gRPC ネットワーク操作インターフェイス