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 は次のとおりです。

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

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

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

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

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

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

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

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

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

ファイル 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 サポートの詳細を示します。

gNOI の初期設定へのリセット操作を行うと、指定されたモジュールのすべての永続ストレージが消去されます。これには、設定、すべてのログ データ、およびフラッシュと SSD のすべての内容が含まれます。リセットは最後のブート イメージでブートし、ライセンスを含むすべてのストレージを消去します。 gNOI の初期設定へのリセットは、次の 2 つのモードをサポートしています。

• 再フォーマットと再パーティションのみが可能な高速消去。

• データをセキュアに消去してワイプし、回復不可能にする、セキュア消去。

factory_reset.proto で定義されている gNOI の初期設定へのリセット操作は、デバイス上のすべての永続ストレージを消去します。こちらの factory_reset.proto リンクを参照してください：https://github.com/openconfig/gnoi/blob/master/factory_reset/factory_reset.proto

次に、gNOI FactoryReset サービスの例を示します。

/ The FactoryReset service exported by Targets.
service FactoryReset {
  // The Start RPC allows the Client to instruct the Target to immediately
  // clean all existing state and boot the Target in the same condition as it is
  // shipped from factory. State includes storage, configuration, logs,
  // certificates and licenses.
  //
  // Optionally allows rolling back the OS to the same version shipped from
  // factory.
  //
  // Optionally allows for the Target to zero-fill permanent storage where state
  // data is stored.
  //
  // If any of the optional flags is set but not supported, a gRPC Status with
  // code INVALID_ARGUMENT must be returned with the details value set to a
  // properly populated ResetError message.
  rpc Start(StartRequest) returns (StartResponse);
}
 
message StartRequest {
  // Instructs the Target to rollback the OS to the same version as it shipped
  // from factory.
  bool factory_os = 1;
  // Instructs the Target to zero fill persistent storage state data.
  bool zero_fill = 2;
}

次に、gNOI の初期設定へのリセットで使用される引数の詳細を示します。

• factory_os = false：工場出荷時の OS バージョンにロールバックするかどうかを指定します。NX-OS では true に設定することはサポートされていません。現在のブート イメージを保持する必要があります。

• zero_fill：時間のかかる包括的なセキュア消去を実行するかどうかを指定します。

  • zero_fill = true：factory-reset module all preserve-image force を指定します。

  • zero_fill = false：factory-reset module all bypass-secure-erase preserve-image force を指定します。

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 の構成を確認するには、次のコマンドを入力します。