機能

RPC の機能は、gNMI サービスの機能のリストを返します。RPC 要求に対する応答メッセージには、gNMI サービスのバージョン、バージョンデータモデル、およびサーバでサポートされているデータエンコードが含まれます。

機能に関する注意事項と制限事項

次は機能に関するガイドラインと制限事項です。

クライアント出力の例

次に言及している例は、機能のクライアント出力を示しています。機能 openconfig が有効になっていることを確認します。

この例は、YANG モデル、gNMIバージョン、およびサポートされているエンコードのサポートを示しています。

$ ./gnmi_cli -a 172.1.1.1:50051 -ca_crt ./grpc.pem -insecure -capabilities
supported_models: <
  name: "Cisco-NX-OS-device"
  organization: "Cisco Systems, Inc."
  version: "2019-11-13"
> 
supported_models: <
  name: "openconfig-acl"
  organization: "OpenConfig working group"
  version: "1.0.0"
> 
supported_models: <
  name: "openconfig-bgp-policy"
  organization: "OpenConfig working group"
  version: "4.0.1"
> 
.
.
.
supported_models: <
  name: "openconfig-spanning-tree"
  organization: "OpenConfig working group"
  version: "0.2.0"
> 
supported_models: <
  name: "openconfig-system"
  organization: "OpenConfig working group"
  version: "0.3.0"
> 
supported_models: <
  name: "openconfig-telemetry"
  organization: "OpenConfig working group"
  version: "0.5.1"
> 
supported_models: <
name: "openconfig-vlan"
  organization: "OpenConfig working group"
  version: "3.0.2"
> 
supported_models: <
  name: "DME"
  organization: "Cisco Systems, Inc."
> 
supported_models: <
  name: "Cisco-NX-OS-Syslog-oper"
  organization: "Cisco Systems, Inc."
  version: "2019-08-15"
> 
supported_encodings: JSON
supported_encodings: PROTO
gNMI_version: "0.5.0"

Get に関する注意事項と制限事項

次に、Get のガイドラインと制限事項を示します。

• GetRequest エンコードは JSONフォーマットのみをサポートします。

• GetRequest.type の場合、DataType CONFIG と STATE のみが YANG 形式との直接の関係と式を持ちます。操作はサポートされていません。

• 1 つの要求に OpenConfig（OC）YANG パスとデバイス YANG パスの両方を含めることはできません。1 つの要求には 1 つのパスのみが含まれます。

• ルートパス（すべてのモデルからのすべてで「/」）に対する GetRequest は許可されていません。

• gNMI Get は、すべてのデフォルト値を返します。Report-all モード RFC 6243 [4]を参照してください。

• Get は Cisco-NX-OS-syslog-oper モデルをサポートしていません。

• openconfig-procmon データを取得するには、クエリをパス /system/processes または /system に送信します。

  （注）	Cisco NX-OSリリース 10.3(x) より前では、 /system パスからデータを取得することはできません。

• 以下のオプションはサポートされていません。

  • パスのプレフィックス

  • パスのエイリアス

  • パス内のワイルドカード

• 1 つの GetReqeuestで 10 のパスを要求することができます。

• GetResponse のサイズ返り値が 12 MB を超える場合、システムはエラーステータス grpc::RESOURCE_EXHAUSTED を返します。

• gRPC の最大受信バッファサイズは 8 MB です。

• より多くの構成があるスイッチに対して Get 操作を実行すると、gRPC プロセスは使用可能なすべてのメモリを消費します。メモリが使い果たされると、次の syslog が生成されます。

  MTX-API: The memory usage is
          reaching the max memory resource limit (3072) MB

  メモリが連続して使い果たされると、次の syslog が生成されます。

  The process has become unstable and
          the feature should be restarted.

  Cisco では、gNMI トランザクションを正常に機能させるため、gRPC 機能を再起動することをお勧めします。

• Get の合計同時セッションの最大数は、構成されている最大同時呼び出し数の 75% です。たとえば、MTX 同時呼び出しが 16 に構成されている場合、Get の合計同時セッションの最大数は 12 になります。

• Get と Set の同時セッションの合計数は、構成されている gNMI の同時最大数から 1 を引いたものです。

  たとえば、gNMI 同時呼び出しが 16 に構成されている場合、Get と Set の合計同時セッションの最大数は 15 になります。

Set に関する注意事項と制限事項

次に、Set のガイドラインと制限事項を示します。

• SetRequest エンコードは JSONフォーマットのみをサポートします。

• 1 つの要求に OpenConfig（OC）YANG パスとデバイス YANG パスの両方を含めることはできません。1 つの要求には 1 つのパスのみが含まれます。

• 以下のオプションはサポートされていません。

  • パスのプレフィックス

  • パスのエイリアス

  • パス内のワイルドカード

• 1 つの SetReqeuestで 20 のパスを要求できます。

• gRPC の最大受信バッファサイズは 8 MB です。

• Get と Set の合計同時セッションの最大数は、構成されている最大 gNMI 同時呼び出し数です。たとえば、gNMI 同時呼び出しが 16 に構成されている場合、Get と Set の合計同時セッションの最大数は 15 になります。

• スイッチに対して Set::Delete RPC 操作を実行した場合、構成が大規模だと、下に示すような MTX 警告メッセージが生成されます。

  Configuration size for this
          namespace exceeds operational limit. Feature may become unstable and require
          restart.

注意事項と制約事項

次に、Set サブスクリプションのガイドラインと制限事項を示します。

• 次のフラグはサポートされていません。

  • エイリアス

  • allow_aggregation

  • 内線番号

  • prefix

  • QoS（Dest. QoS）

• 同じサブスクリプション要求内のすべてのパスのサンプル間隔が同じになっていることを確認します。同じパスで異なるサンプル間隔が必要な場合は、複数のサブスクリプションを作成します。

gNMI サブスクライブオプション

次の表に、サブスクライブオプションのモードを示します。

モードの設定

それぞれのモードは、サブスクリプション内部とサブスクリプション外部の 2 つの設定を必要とします。次に、サブスクリプションの組み合わせについて説明します。

• ONCE：SAMPLE、ONCE

• POLL：SAMPLE、POLL

• STREAM：SAMPLE、STREAM

• ON_CHANGE：ON_CHANGE、STREAM

• TARGET_DEFINED：TARGET_DEFINED、STREAM

Origin

• DME：DME モデルへの登録

• DEVICE：YANG モデルへの登録

• OPENCONFIG：OpenConfig モデルへの登録

名前（Name）

• DME：DME モデルへの登録

• Cisco-NX-OS-device：YANG モデルへの登録

エンコーディング（Encoding）

• JSON：ストリームは JSON 形式で送信される。

• PROTO：ストリームは元のプロトコルフォーマットで送信される。

ペイロードの構成例

次のセクションでは、ペイロードのクライアントの例を示します。

DME ストリーム/サンプルへの登録

注意事項と制約事項

Syslog ストリームに関するガイドラインと制限事項は次のとおりです。

• 無効な syslog はサポートされません。たとえば、フィルタまたはクエリ条件を含む syslog はサポートされません。

• Syslog ストリームは以下のパスのみをサポートします。

  • Cisco-NX-OS-Syslog-oper: syslog

  • Cisco-NX-OS-Syslog-oper: syslog messages

• ストリームサンプルモードと POLL モードのみがサポートされます。

• サポートされるエンコーディングフォーマットは JSON と PROTO です。

オリジナルの YANG Syslog モデル

次に、YANG Syslog モデルの構成例を示します。

（注）	デフォルトでは、タイムゾーンフィールドは空です。タイムゾーンフィールドは、clock format show-timezone syslog を構成するときに設定されます。

PYANG Tree for Syslog Native Yang Model:
>>> pyang -f tree Cisco-NX-OS-infra-syslog-oper.yang module: Cisco-NX-OS-syslog-oper
+--ro syslog
+--ro messages
+--ro message* [message-id]
+--ro message-id int32
+--ro node-name? string
+--ro time-stamp? uint64
+--ro time-of-day? string
+--ro time-zone? string
+--ro category? string
+--ro group? string
+--ro message-name? string
+--ro severity? System-message-severity
+--ro text? string

サブスクライブ要求

次に、サブスクライブ要求の例を示します。

{
    "SubscribeRequest":
    [
        {
            "subscribe":
            {
                "subscription":
                [
                    {
                        "path":
                        {
                            "origin": "syslog-oper",
                            "elem":
                              [
                                {
                                    "name": "syslog"
                                },
                                {
                                    "name":"messages"
                                }
                            ]
                        },
                        "mode": "ON_CHANGE"
                    }
                ],
                "mode": "ON_CHANGE",
                "allow_aggregation" : false,
                "use_models":
                [
                    {
                        "name": "Cisco-NX-OS-Syslog-oper",
                        "organization": "Cisco Systems, Inc.",
                        "version": "0.0.0"
                    }
                ],
                "encoding":"JSON"
            }
        }
    ]
}

応答の例

次に、PROTO エンコードでの出力応答の例を示します。

[Subscribe]-------------------------------
Sat Aug 24 14:38:06 2019
### Generating request : 1 -----------
### Comment : STREAM request
### Delay : 2 sec(s) ...
### Delay : 2 sec(s) DONE

subscribe {
subscription {
path {
origin: "syslog-oper"
elem {
name: "syslog"
}
elem {
name: "messages"
}
}
mode: ON_CHANGE
}

use_models {
name: "Cisco-NX-OS-Syslog-oper"
organization: "Cisco Systems, Inc."
version: "0.0.0"
}
encoding: PROTO
}

Thu Nov 21 14:26:41 2019
Received response 3 --------------------------
update {
timestamp: 1574375201665688000
prefix {
origin: "Syslog-oper"
elem {
name: "syslog"
}
elem {
name: "messages"
}
}
…
update {
path {
elem {
name: "time-stamp"
}
}
val {
uint_val: 1574375200000
}
}
update {
path {
elem {
name: "severity"
}
}
val {
uint_val: 5
}
}
}

/Received -------------------------------------

次に、JSON エンコードでの出力応答の例を示します。

[Subscribe]-------------------------------
### Reading from file ' testing_bl/stream_on_change/OC_SYSLOG.json '

Tue Nov 26 11:47:00 2019
### Generating request : 1 -----------
### Comment : STREAM request
### Delay : 2 sec(s) ...
### Delay : 2 sec(s) DONE
subscribe {
subscription {
path {
origin: "syslog-oper"
elem {
name: "syslog"
}
elem {
name: "messages"
}
}
mode: ON_CHANGE
}
use_models {
name: "Cisco-NX-OS-Syslog-oper"
organization: "Cisco Systems, Inc."
version: "0.0.0"
}
}

Tue Nov 26 11:47:15 2019
Received response 5 --------------------------
update {
timestamp: 1574797636002053000
prefix {
}
update {
path {
origin: "Syslog-oper"
elem {
name: "syslog"
}
}
val {
json_val: "[ { \"messages\" : [[ {\"message-id\":657},{\"node-name\":\"task-n9k-1\",\"time-stamp\":\"1574797635000\",\"time-of-day\":\"Nov 26 2019 11:47:15\",\"severity\":3,\"message-name\":\"HDR_L2LEN_ERR\",\"category\":\"ARP\",\"group\":\"ARP\",\"text\":\"arp [30318] Received packet with incorrect layer 2 address length (8 bytes), Normal pkt with S/D MAC: 003a.7d21.d55e ffff.ffff.ffff eff_ifc mgmt0(9), log_ifc mgmt0(9), phy_ifc mgmt0(9)\",\"time-zone\":\"\"} ]] } ]"
}
}
}