<GET>

この操作により、指定したデータストアの構成データを取得します。

次に、 HTTP の Get 要求と応答メッセージの例を示します。

client-host % curl -X GET -H "Authorization: Basic YWRtaW46Y2lzY28=" -H "Accept:
application/yang.data+xml"
"http://192.0.20.123/restconf/data/Cisco-NX-OS-device:System/bgp-items/inst-items/dom-items/Dom-list?content=config"
-i
HTTP/1.1 200 OK
Server: nginx/1.7.10
Date: Tue, 27 Sep 2016 20:26:03 GMT
Content-Type: application/yang.data+xml
Content-Length: 395
Connection: keep-alive
Set-Cookie: nxapi_auth=admin:147500856185650327
Status: 200 OK
    <Dom-list>
        <name>default</name>
        <always>enabled</always>
        <bestPathIntvl>300</bestPathIntvl>
        <holdIntvl>180</holdIntvl>
        <kaIntvl>60</kaIntvl>
        <maxAsLimit>0</maxAsLimit>
        <pfxPeerTimeout>30</pfxPeerTimeout>
        <pfxPeerWaitTime>90</pfxPeerWaitTime>
        <reConnIntvl>60</reConnIntvl>
        <rtrId>2.2.2.2</rtrId>
    </Dom-list>
 client-host %

<POST>

この操作は、指定された設定をターゲットデータストアに書き込みます。

次に、 HTTP の POST 要求と応答メッセージの例を示します。

client-host % curl -X POST -H "Authorization: Basic YWRtaW46Y2lzY28=" -H "Content-Type: application/yang.data+xml" -d '<always>enabled</always><rtrId>2.2.2.2</rtrId>'
"http://192.0.20.123/restconf/data/Cisco-NX-OS-device:System/bgp-items/inst-items/dom-items/Dom-list=default"
-i
HTTP/1.1 201 Created
Server: nginx/1.7.10
Date: Tue, 27 Sep 2016 20:25:31 GMT
Transfer-Encoding: chunked
Connection: keep-alive
Set-Cookie: nxapi_auth=admin:14750085316974134
Status: 201 Created
Location: /System/bgp-items/inst-items/dom-items/Dom-list=default/always/rtrId/

エフェメラルデータの取得

エフェメラル データは、大量のデータです。DME は、各バッチがメモリ使用量の観点から管理可能なサイズになるように、データを取得するバッチ メカニズムを提供します。バッチのサイズは、取得する MO の数です。

パブリッシュされた Cisco-NX-OS-device.yang ファイルの「Ephemeral data」というコメントで、どのデータがエフェメラルであるかに関する情報を確認できます。

要求内の RESTCONF URI が以下を指している場合にのみ、エフェメラルデータからの出力が返されます。

• エフェメラル データのリーフ

• エフェメラル データの子を持つコンテナまたはリスト

• 直接のエフェメラル データの子を持つリストをラップするために使用される空のコンテナ

• システム レベルの GET クエリは、エフェメラル データを返しません。

例

これは、エフェメラル データを取得する例です。

クライアントは、次の GET 要求メッセージを送信する場合があります。

GET /restconf/data/Cisco-NX-OS-device:System//urib-items/table4-items/Table4-list=management/route4-items HTTP/1.1
Host: example.com
Accept: application/yang.data+json 

サーバは次のように応答します。

HTTP/1.1 200 OK
Date: Fri, 06 Mar 2020 11:10:30 GMT
Server: nginx/1.7.10
Content-Type: application/yang.data+json
{
"route4-items": {
"Route4-list": [{
"prefix": "172.23.167.255/32", "flags": "0", ...

機能ステータスの確認

• Cisco NX-OS で、show feature | inc restconf コマンドを入力してエージェントの構成を確認します。

• RESTCONF エージェントのステータスを表示するには、show feature コマンドを使用し、式 restconf を含めます。

switch-1# show feature | grep restconf
restconf	1	enabled
switch-1#

NX- API 接続の確認

• feature nxapi コマンドを発行して、Web サーバーを有効にします。

• HTTP 用にポートを開くように nxapi http port 80 コマンドが構成されていることを確認します。

• HTTPS 用にポートを開くように nxapi https port 443 コマンドが構成されていることを確認します。

• スイッチの管理ポートに ping を実行して、スイッチが到達可能であることを確認します。

Restconf エラーの確認

次に、一般的なエラーメッセージと、それを解決するためのガイドラインを示します。

• 要求を送信した直後（数秒後など）にこのメッセージを受信した場合は、次の点を確認してください：

  Error Message: Sorry, the page you are looking for is currently unavailable 

  • 「接続のトラブルシューティング」に記載されているように、NXAPI 機能が有効になっていること。

  • RESTCONF 機能が有効になっていること（show feature | grep restconf）。RESTCONF が有効になっていない場合は、有効にします（feature restconf）。

  • ポートは、NX-API によって HTTP または HTTPS 用に構成されます。show nxapi を使用して、ポートが構成されていることを確認します。

    switch-1# show nxapi
    nxapi enabled
    HTTP Listen on port 80
    HTTPS Listen on port 443
    

    ポートが HTTP または HTTPS 用に構成されていない場合は、 nxapi http port 80 または nxapi https port 443を発行して構成します。

• 要求の送信後にこのメッセージを受信した場合（数分後など）、スイッチの最上位レベルからの過剰な同時クエリー要求でシステムが過負荷になっていないことを確認します。過剰な最上位レベルのクエリは、かなりのリソース負荷を生じる可能性があります。

  次のいずれかによって、スイッチが過負荷になっていないことを確認できます。

  • クライアントが送信する要求の数をスロットルバックします。

  • スイッチで no feature restconf そして feature restconf を発行して RESTCONF エージェントを再起動します。

RESTCONF エージェントのアカウンティング ログ

POST、PUT、PATCH、または DELETE などの書き込み操作の場合、RESTCONF は関連するアカウンティングログを出力します。これには、受信した元の要求と、スイッチに適用された最終的な変更の両方が含まれます。

アカウンティングログは、show accounting log コマンドを使用して表示できます。

次の要求例を考えてみます。

---
curl -s -L --request POST --user admin: --header 'Content-Type: application/yang.data+json' --url “restconf/data/Cisco-NX-OS-device:System/intf-items/lb-items/LbRtdIf-list=lo10” --data-raw @request.txt
Payload:
<descr>test</descr>
Or
{"descr":"test"}
---

アカウンティング ログには、次の項目が含まれます。

例:

Wed Jun 29 13:53:37
2022:type=update:id=3180018864:user=admin:cmd=(COMMIT),database=[running],configMo=[ <topSystem childAction="" dn="sys" status="created,modified"><interfaceEntity childAction=""
rn="intf" status="created,modified"><l3LbRtdIf childAction="" descr="test" id="lo10" rn="lb-
[lo10]" status="created,modified"/></interfaceEntity></topSystem>] (SUCCESS)

例:

Wed Jun 29 13:53:37
2022:type=update:id=3180018864:user=admin:cmd=(RESTCONF:POST),sourceIp=[192.168.1.2], url=[/restconf/data/Cisco-NX-OS-device:System/intf-items/lb-items/LbRtdIflist=lo10],payload=[<descr>test</descr>] (SUCCESS)

失敗した要求の場合、失敗のシナリオによっては、ユーザーは両方のログを確認できない場合があります。

無効な要求：

無効な要求は、構成の変更なしに拒否されるため、元の要求のみがログに記録されます。

例:

Wed Jun 29 20:16:26
2022:type=update:id=3180018864:user=admin:cmd=(RESTCONF:POST),
sourceIp=[192.168.1.2],url=[/restconf/data/Cisco-NX-OS-device:System/intf-items/lb-items/LbRtdIflist=lo10],payload=[<descr>test</descr>] (FAILED)

さまざまな構成制限による要求の失敗：

この場合、失敗した構成試行と元の要求の両方がログに記録されます。

例：

Wed Jun 29 20:32:01
2022:type=update:id=3180018864:user=admin:cmd=(COMMIT),database=[running], configMo=[<topSystem childAction="" dn="sys" status="created,modified"><telemetryEntity
childAction="" rn="tm" status="created,modified"><telemetryCertificate childAction="" filename="foo" hostname="foo" rn="certificate" status="created,modified" trustpoint="test"/></telemetryEntity></topSystem>] (FAILED)
Wed Jun 29 20:32:01
2022:type=update:id=3180018864:user=admin:cmd=(RESTCONF:PATCH),
sourceIp=[192.168.1.2],url=[/restconf/data/Cisco-NX-OS-device:System/tm-items/certificateitems],payload=[<trustpoint>test</trustpoint><hostname>foo</hostname><filename> foo</filename>] (FAILED)