NX-API は、Cisco MDS 9000 シリーズ CLI システムの拡張機能です。

Cisco MDS 9000 NX-API は、CLI コマンドを取得して実行する RPC スタイルの API です。他の Representational State Transfer（REST）API フレームワークとも共通する HTTP または HTTPS プロトコルに基づいて、Cisco MDS スイッチへのプログラムによるアクセスを可能にします。NX-API は、Cisco MDS NX-OS CLI の構成および管理機能を最新の Web ベースの API で提供します。これにより、ユーザは Web ブラウザを使用して Cisco MDS スイッチを制御できます。Python などのプログラミング言語や適切なライブラリと組み合わせると、ストレージ ネットワーキングの自動化が容易になります。

Cisco MDS NX-API は、特定の show コマンドと非インタラクティブな構成コマンドをサポートしています。

（注）	非インタラクティブ コマンドは、ユーザーにキーボードからの入力を求めずに続行するコマンドです。

HTTP Header

ヘッダーを使用すると、クライアントとサーバーは、要求と応答内でコロンで区切られたプロパティと値のペアを使用し、追加情報を渡すことができます。

ここで、NX-API 要求のコンテンツ エンコーディングを指定します。サポートされるコンテンツ タイプは次のとおりです：

HTTP メソッド

Cisco MDS NX-API は POST メソッドを使用します。

メッセージ本文

メッセージ本文またはペイロードには、HTTP メソッドのデータが含まれます。サポートされているオブジェクトのリストについては、 NX-API 要求要素のセクションを参照してください。

メッセージ応答

メッセージ応答は、HTTP の戻りコードと、メソッドによって返されるデータを含む HTTP 応答本文です。サポートされている要素のリストについては、 NX-API 応答要素のセクションを参照してください。応答コードのリストについては、NX-API 応答コードの項を参照してください。

NX-API で使用するためのアイデンティティ証明書の準備

NX-API のアイデンティティ証明書は、nxapi certificate コマンドを使用してインポートする前に、作成しておく必要があります。証明書は、スイッチ アイデンティティ証明書のみで構成する必要があるため、すべての CA 証明書と中間認証局の証明書を削除する必要があります。秘密キーを削除する必要があります。また、合計サイズが 4096 バイト未満である必要があります。

スイッチ アイデンティティ証明書がトラストポイントのスイッチ暗号化インフラストラクチャにすでにインストールされている場合は、これをエクスポートして再フォーマットし、秘密キーを抽出して NX-API で使用できます。スイッチ アイデンティティ証明書がまだインストールされていない場合は、CA によって作成される必要があります。

証明書の構成については、Cisco MDS 9000 シリーズ セキュリティの設定ガイド、リリース 8.x の証明書認証およびデジタル証明書の構成の章を参照してください。

（注）	NX-API で使用する既存のアイデンティティ証明書を準備するためのツールは、スイッチでは使用できません。これは、OpenSSL がインストールされているホストなどの別のデバイスで実行する必要があります。

1. （オプション）スイッチ アイデンティティ証明書がすでにスイッチにインストールされている場合は、次のコマンドを使用して PKCS12 フォーマットでエクスポートします:

   switch(config)# crypto ca export trustpoint_name pkcs12 mytpexport.pkcs12 my_passphrase

2. OpenSSL がインストールされているホストにファイルをアップロードします：

   switch# copy mytpexport.pkcs12 sftp://10.10.2.2

3. アイデンティティ証明書を抽出します：

   host$ openssl pkcs12 -in mytpexport.pkcs12 -nokeys -clcerts -out idcert.pem
   Enter Import Password: my_passphrase
   host$

4. 暗号化されていない秘密キーを抽出します：

   host$ openssl pkcs12 -in mytpexport.pkcs12 -nocerts -nodes | openssl rsa -out unencryptedprivkey.pem
   Enter Import Password:
   writing RSA key
   host$

5. スイッチ上のブートフラッシュに 2 つのファイルをダウンロードします：

   switch# copy sftp://10.10.2.2/idcert.pem bootflash:
   switch# copy sftp://10.10.2.2/unencryptedprivkey.pem bootflash:

nxapi certificate コマンドを使用してファイルをインポートする準備ができました。

cURL での NX-API の使用

ホスト上の show.version.json ファイルの内容を調べてみましょう。

linux$ cat show.version.json
[{ "jsonrpc": "2.0", "method": "cli", "params": { "cmd": "show version", "version": 1 }, "id": 1 }]
EOF
 

ホストで cURL を使用してスイッチを認証し、目的の POST 要求を送信します。

linux$ curl -v -u admin:cisco -H "Content-Type: application/json-rpc" -H "Cache-Control: no-cache" -d @show.version.json -X POST http://10.10.2.2:80/ins
 
Note: Unnecessary use of -X or --request, POST is already inferred.
*   Trying 10.10.2.2:80...
* Connected to 10.10.2.2:80 (10.10.2.2:80) port 80 (#0)
* Server auth using Basic with user 'admin'
> POST /ins HTTP/1.1
> Host: 10.10.2.2:80
> Authorization: Basic YWRtaW46bmJ2XzEyMzQ1
> User-Agent: curl/7.70.0
> Accept: */*
> Content-Type: application/json-rpc
> Cache-Control: no-cache
> Content-Length: 99
> 
* upload completely sent off: 99 out of 99 bytes
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Server: nginx/1.7.10
< Date: Mon, 14 Jun 1976 13:28:43 GMT
< Content-Type: application/json-rpc; charset=UTF-8
< Transfer-Encoding: chunked
< Connection: keep-alive
< Set-Cookie: nxapi_auth=dzqnf:1fNa+E8KGq0ZZM6TRZTFKTWejBg=; Secure; HttpOnly;
< X-Frame-Options: SAMEORIGIN
< X-XSS-Protection: 1; mode=block
< X-Content-Type-Options: nosniff
< Strict-Transport-Security: max-age=31536000; includeSubDomains
< Content-Security-Policy: block-all-mixed-content; base-uri 'self'; default-src 'self'; script-src 'self'; style-src 'self'; img-src 'self' ; connect-src 'self'; font-src 'self'; object-src 'none'; media-src 'self'; form-action 'self'; frame-ancestors 'self';
< 
{
        "jsonrpc":      "2.0",
        "result":       {
                "header_str":   "Cisco Nexus Operating System (NX-OS) Software\nTAC support: http://www.cisco.com/tac\nDocuments: http://www.cisco.com/en/US/products/ps9372/tsd_products_support_series_home.html\nCopyright (c) 2002-2020, Cisco Systems, Inc. All rights reserved.\nThe copyrights to certain works contained herein are owned by\nother third parties and are used and distributed under license.\nSome parts of this software are covered under the GNU Public\nLicense. A copy of the license is available at\nhttp://www.gnu.org/licenses/gpl.html.\n",
                "bios_ver_str": "2.1.17",
                "loader_ver_str":       "N/A",
                "kickstart_ver_str":    "8.4(1)SK(0) [build 8.4(1)SK(0.160)] [gdb]",
                "sys_ver_str":  "8.4(1)SK(0) [build 8.4(1)SK(0.160)] [gdb]",
                "bios_cmpl_time":       "01/08/14",
                "kick_file_name":       "bootflash:///kick-sky160",
                "kick_cmpl_time":       " 12/20/2020 12:00:00",
                "kick_tmstmp":  "09/08/2020 09:42:15",
                "isan_file_name":       "bootflash:///sky-sep14-02",
                "isan_cmpl_time":       " 12/20/2020 12:00:00",
                "isan_tmstmp":  "09/14/2020 05:56:35",
                "chassis_id":   "MDS 9250i 40 FC 2 IPS 8 FCoE (2 RU) Chassis",
                "module_id":    "40FC+8FCoE+2IPS Supervisor",
                "cpu_name":     "Motorola, e500v2",
                "memory":       4088480,
                "mem_type":     "kB",
                "proc_board_id":        "JAF1852AAFC",
                "host_name":    "host",
                "bootflash_size":       4001760,
                "kern_uptm_days":       0,
                "kern_uptm_hrs":        1,
                "kern_uptm_mins":       25,
                "kern_uptm_secs":       13,
                "rr_usecs":     715180,
                "rr_ctime":     "Mon Jun 14 12:02:47 1976",
                "rr_reason":    "Reset Requested by CLI command reload",
                "rr_sys_ver":   "8.4(1)SK(0.160)",
                "rr_service":   "",
                "manufacturer": "Cisco Systems, Inc."
        },
        "id":   1,
        "cmd":  "show version"
* Connection #0 to host 10.197.155.246 left intact

ユーザーは NX-API でスクリプトを使用する方法を示すサンプル スクリプトにアクセスできます。サンプル スクリプトにアクセスするには、次のリンクをクリックして、必要なソフトウェア リリースに対応するディレクトリを選択します：https://github.com/datacenter/nxos/tree/master/nxapi/samples

NX-API サンドボックスの構成

1. NX-API 機能を有効にし、構成します。NX-API 機能を有効にして構成する方法については、NX-API CLI の構成セクションを参照してください。

2. NX-API サンドボックスを有効にします：

   switch# configure terminal
   switch(config)# nxapi sandbox

NX-API 設定を表示するには、show nxapi コマンドを使用します。

switch# show nxapi

NX-API:       Enabled         Sandbox:      Enabled     
HTTP Port:    Disabled        HTTPS Port:  8443         

Certificate Information:
    Issuer:   C=US, ST=CA, L=San Jose, O=Cisco Systems Inc., OU=dcnxos, CN=nxos
    Expires:  Nov 26 09:26:12 2019 GMT                                         
    Content:  -----BEGIN CERTIFICATE-----
MIIDpzCCAo+gAwIBAgIJAObmdczeHJL8MA0GCSqGSIb3DQEBCwUAMGoxCzAJBgNV
BAYTAlVTMQswCQYDVQQIDAJDQTERMA8GA1UEBwwIU2FuIEpvc2UxGzAZBgNVBAoM
EkNpc2NvIFN5c3RlbXMgSW5jLjEPMA0GA1UECwwGZGNueG9zMQ0wCwYDVQQDDARu
eG9zMB4XDTE5MTEyNTA5MjYxMloXDTE5MTEyNjA5MjYxMlowajELMAkGA1UEBhMC
VVMxCzAJBgNVBAgMAkNBMREwDwYDVQQHDAhTYW4gSm9zZTEbMBkGA1UECgwSQ2lz
Y28gU3lzdGVtcyBJbmMuMQ8wDQYDVQQLDAZkY254b3MxDTALBgNVBAMMBG54b3Mw
ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDreVT3LAYarHxZxELwNwst
ZQqlmah5PJHBGUx+3YQcRi8v8wrEsRI7bZrQgDzXkFEH9yroJUghdc0nkM1GYHNF
avbj4qRaEveRejtGZNMPi11tAOWbRsU0ldxODV3+SeG/A220Bal58JzJjje5wyi8
Wu8UR8w4Lb32GYXI8ifBtlU0LrNsS0pE68yJt782y8IJIAEjGWX3L8dle4qwRqXg
6GBDPbwKFCvi+NX8JN48olONASSHXGdcmZSfiYUNKPD7+AwjG/luxSyIqnFW2w06
zwQLoIbXJx7zvl0Adt3H4ZnaRZOG5UvsWLgEdJZJkaqQPe0+7cpwcubN9/PJlO0l
AgMBAAGjUDBOMB0GA1UdDgQWBBTUI4IqOqmoKy5LEjygiJzd2nEGWzAfBgNVHSME
GDAWgBTUI4IqOqmoKy5LEjygiJzd2nEGWzAMBgNVHRMEBTADAQH/MA0GCSqGSIb3
DQEBCwUAA4IBAQC+7TPfDAz1t4yvG4rpypinU2Plp2FOBRdU85CIVREIplbRX8Vv
VMXYySnrKDjVRPcWtY+EtDW91BfS2I2usHkiKcnOYazDoxpamFI3D6lmb82JAAqG
NMV56hIJAYMpVqfbI+vtC93NR3F2fLD8/Hm/X4L8U6kdu2o+vgqYtc4OOl87lhJS
R8xA2N9kihOA1FUMVL89cFgRvxONjAyQImTB8uWl1stUGpH2kE3dABHC1sbZ1dNw
2/OxpfGnj1Qjvi4wKqjGpX/Kqc0AIx2zsKEX9hpPMQK/wlaRg8hlNCXJzzTQ7IVX
7PWJSqn7gpfyZIgZ9JQQ/WieCH32mQ2xGMDD
-----END CERTIFICATE-----

NX-API 開発者サンドボックスにアクセスするには、次の手順を実行します：

（注）	NX-API 開発者サンドボックスを使用する場合は、Firefox リリース 24.0 以降を使用することを推奨します。NX-API 開発者サンドボックスの [コピー（Copy）] ボタンと [Python] ボタンが機能するには、ブラウザに最新の Adobe Flash プレーヤーがインストールされている必要があります。

1. ブラウザを開き、そのアドレスバーに、HTTP の場合は http://switch_ip_address :port-number 、HTTPS の場合は https://switch_ip_address :port-number と入力します。

   [NX-API 開発者サンドボックス認証（NX-API Developer Sandbox Authentication）] ウィンドウが表示されます。

   
   

   

   
   

2. 適切なクレデンシャルでログインします。

   [NX-API 開発者サンドボックス（NX-API Developer Sandbox）] ウィンドウが表示されます。

NX-API Developer Sandbox は、スイッチでホストされる Web フォームです。NX-OS CLI コマンドを同等の XML または JSON ペイロードに変換し、NX-API ペイロードを同等の CLI に変換します。

図 3 に示すように、Web フォームは、コマンド（上部ペイン）、要求、および応答という 3 つのペインを持つ 1 つの画面です。

コマンド ペインのコントロールを使用すると、サポートされている API のメッセージ フォーマット（NX-API など）とコマンド タイプ（XML や JSON など）を選択できます。使用可能なコマンド タイプ オプションは、選択したメッセージ フォーマットによって異なります。

NX-API 開発者サンドボックスを使用してコマンドの出力を生成するには、次の手順を実行します：

1. コマンド出力を表示するメッセージ フォーマット タイプ（json-rpc、 xml、 json）をクリックします。（デフォルトでは、 json-rpc が選択されています）。

2. 入力したコマンド タイプをクリックします。オプションは、選択したメッセージ フォーマットによって異なります。（デフォルトでは、cli が選択されています）。

   上部ペインの下部にある [リセット（Reset）] をクリックすると、テキスト エントリ ボックス (および [要求（Request）] ペインと [応答（Response）] ペイン) の内容を消去できます。

   （注）

   xml メッセージ フォーマットを選択した場合は、 cli_show および cli_show_ascii コマンド タイプのチャンク モードを有効にできます。[チャンクモードを有効にする（Enable Chunk mode）] チェックボックスをオンにして、大きな show コマンド出力がチャンクされるようにします。出力の次のチャンクを表示するには、[応答（RESPONSE）] エリアの <sid> および </sid> タグの間に記載されているセッション ID（SID）をコピーし、[チャンクモードを有効にする（Enable Chunk mode）] チェックボックスの下の [SID] ボックスに貼り付けます。

3. 上部ペインのテキスト エントリ ボックスに、NX-OS CLI 構成コマンドを 1 行に 1 つずつ入力するか貼り付けます。

4. 入力したコマンドが、選択したメッセージ フォーマットで [要求（REQUEST）] エリアに表示されます。

   リクエスト ペインにも一連のタブがあります。各タブは異なる言語を表しており、Python、Java、JavaScript に対応しています。各タブでは、それぞれの言語でリクエストを表示できます。たとえば、CLI コマンドを XML または JSON ペイロードに変換した後、[Python] タブをクリックして、スクリプトの作成に使用できる Python でのリクエストを表示します。

   • [要求（REQUEST）] エリアに入力されたデータをコピーするには、 [コピー（Copy）]をクリックします。

   • 入力したコマンドの Python コードを生成するには、 [Python]をクリックします。

     （注）	xml メッセージ フォーマットは、[Python] ボタンをサポートしていません。

5. [POST] を クリックして、コマンドの出力を生成します。

   コマンドの出力が [応答（RESPONSE）] エリアに表示されます。

   • [応答（RESPONSE）] エリアに入力されたデータをコピーするには、 [コピー（Copy）] をクリックします。

   コマンドとそれに対応する出力をクリアし、ページをリセットするには、 [リセット（Reset）]をクリックします。

6. NX-API でサポートされている show コマンドのリストを表示するには、 [コマンド リファレンス（Command Reference）] をクリックします。

   [コマンド スキーマ（Command Schema）] ペインには、[コマンドの表示 （Show commands）] ペインで選択したコマンドの詳細が表示されます。

   （注）	現在、 [コマンドリファレンス（Command Reference）] タブは show コマンドのみをサポートしています。

   

   1	show コマンド：サポートされている show コマンドのリストを表示します。
   2	[コマンド スキーマ（Command Schema）]：[コマンドの表示 （Show commands）] ペインで選択したコマンドの NX-API スキーマ（キーワードおよび説明）を表示します。

例：NX-API ステータスの表示

次に、NX-API ステータス応答をさまざまな出力フォーマットで表示する例を示します。

XML 形式

show nxapi

要求:

<?xml version="1.0"?>
<ins_api>
  <version>1.2</version>
  <type>cli_show</type>
  <chunk>0</chunk>
  <sid>sid</sid>
  <input>show nxapi</input>
  <output_format>xml</output_format>
</ins_api>

応答：

<ins_api>
  <type>cli_show</type>
  <version>1.2</version>
  <sid>eoc</sid>
  <outputs>
    <output>
      <body>
     <nxapi_status>Enabled</nxapi_status>
     <sandbox_status>Enabled</sandbox_status>
     <http_port>8080</http_port>
    </body>
      <input>show nxapi</input>
      <msg>Success</msg>
      <code>200</code>
    </output>
  </outputs>
</ins_api>

[JSON 形式（JSON Format）]

show nxapi

要求:

{
  "ins_api": {
    "version": "1.2",
    "type": "cli_show",
    "chunk": "0",
    "sid": "1",
    "input": "show nxapi",
    "output_format": "json"
  }
}
 

応答：

{
  "ins_api": {
    "type": "cli_show",
    "version": "1.2",
    "sid": "eoc",
    "outputs": {
      "output": {
        "input": "show nxapi",
        "msg": "Success",
        "code": "200",
        "body": {
          "nxapi_status": "Enabled",
          "sandbox_status": "Enabled",
          "http_port": "8080"
        }
      }
    }
  }
}
 

JSON-RPC フォーマット

show nxapi

要求:

[
  {
    "jsonrpc": "2.0",
    "method": "cli",
    "params": {
      "cmd": "show nxapi",
      "version": 1.2
    },
    "id": 1
  }
]
 

応答：

{
  "jsonrpc": "2.0",
  "result": {
    "body": {
      "nxapi_status": "Enabled",
      "sandbox_status": "Enabled",
      "http_port": "8080"
    }
  },
  "id": 1
}
 

例：VSAN から VLAN へのマッピングの構成

次に、グローバル構成モード（cli_conf）で、VSAN から VLAN へのマッピングを構成する例を示します。

vlan 3
fcoe vsan 3
vsan database
vsan 3
vsan 3 interface vfc1/8

要求:

<?xml version="1.0"?>
<ins_api>
  <version>1.2</version>
  <type>cli_conf</type>
  <chunk>0</chunk>
  <sid>sid</sid>
  <input>vlan 3 ;fcoe vsan 3 ;vsan database ;vsan 3 ;vsan 3 interface vfc1/8</input>
  <output_format>xml</output_format>
</ins_api>

応答：

<?xml version="1.0"?>
<ins_api>
  <type>cli_conf</type>
  <version>1.2</version>
  <sid>eoc</sid>
  <outputs>
    <output>
      <body/>
      <input>vlan 3</input>
      <code>200</code>
      <msg>Success</msg>
    </output>
    <output>
      <body/>
      <input>fcoe vsan 3</input>
      <code>200</code>
      <msg>Success</msg>
    </output>
    <output>
      <body/>
      <input>vsan database</input>
      <code>200</code>
      <msg>Success</msg>
    </output>
    <output>
      <body/>
      <input>vsan 3</input>
      <code>200</code>
      <msg>Success</msg>
    </output>
    <output>
      <body/>
      <input>vsan 3 interface vfc1/8</input>
      <code>200</code>
      <msg>Success</msg>
    </output>
  </outputs>
</ins_api>

例：ゾーンとゾーンセットの構成

次に、グローバル構成モード（cli_conf）でゾーンを構成する例を示します。

zone name zone2 vsan 1
member pwwn 10:00:00:23:45:67:89:ab
member pwwn 10:00:00:23:45:67:89:cd

要求:

<?xml version="1.0"?>
<ins_api>
  <version>1.2</version>
  <type>cli_conf</type>
  <chunk>0</chunk>
  <sid>sid</sid>
  <input>zone name zone2 vsan 1 ;member pwwn 10:00:00:23:45:67:89:ab ;member pwwn 10:00:00:23:45:67:89:cd</input>
  <output_format>xml</output_format>
</ins_api>

応答：

<?xml version="1.0"?>
<ins_api>
  <type>cli_conf</type>
  <version>1.2</version>
  <sid>eoc</sid>
  <outputs>
    <output>
      <body/>
      <input>zone name zone2 vsan 1</input>
      <code>200</code>
      <msg>Success</msg>
    </output>
    <output>
      <body/>
      <input>member pwwn 10:00:00:23:45:67:89:ab</input>
      <code>200</code>
      <msg>Success</msg>
    </output>
    <output>
      <body/>
      <input>member pwwn 10:00:00:23:45:67:89:cd</input>
      <code>200</code>
      <msg>Success</msg>
    </output>
  </outputs>
</ins_api>

次に、グローバル構成モード（cli_conf）でゾーンセットを構成する例を示します。

zoneset name Zoneset1 vsan 1
member zone2
zoneset activate name Zoneset1 vsan 1

要求:

<?xml version="1.0"?>
<ins_api>
  <version>1.2</version>
  <type>cli_conf</type>
  <chunk>0</chunk>
  <sid>sid</sid>
  <input>zoneset name Zoneset1 vsan 1 ;member zone2 ;zoneset activate name Zoneset1 vsan 1</input>
  <output_format>xml</output_format>
</ins_api>

応答：

<?xml version="1.0"?>
<ins_api>
  <type>cli_conf</type>
  <version>1.2</version>
  <sid>eoc</sid>
  <outputs>
    <output>
      <body/>
      <input>zoneset name Zoneset1 vsan 1</input>
      <code>200</code>
      <msg>Success</msg>
    </output>
    <output>
      <body/>
      <input>member zone2</input>
      <code>200</code>
      <msg>Success</msg>
    </output>
    <output>
      <body>Zoneset activation initiated. check zone status
</body>
      <input>zoneset activate name Zoneset1 vsan 1</input>
      <code>200</code>
      <msg>Success</msg>
    </output>
  </outputs>
</ins_api>

show コマンドが NX-API 対応でない場合でも、JSON および XML エンコード要求の場合は Command type 要素を cli_show_ascii に、JSON-RPC エンコード要求の場合は show_ascii に設定することで、出力にアクセスできます。コマンド出力は、単一のフラット文字列として応答本文で返されます。

次の図に、NX-API 開発者サンドボックスでの NX-API 対応ではない show コマンドの出力例を示します。

NX-API 要求要素は、XML フォーマット、JSON フォーマット、または JSON-RPC フォーマットでスイッチに送信されます。リクエストの HTTP ヘッダーは、リクエストのコンテンツ タイプを識別する必要があります。

（注）	ロックを保持しているセッションが何らかの理由で終了した場合、ロックはシステムによって解放されます。ロックを取得したセッションは、必要な構成のみを実行できます。