REST API による管理の有効化

はじめに

Cisco IOS XE CLI を使用してルータ上で選択した機能を設定し管理する代わりに、Cisco IOS XE REST API を使用して Cisco ASR 1001-X および ASR 1002-X を管理できます。この章では、これらの Cisco ASR ルータを設定して、REST API を使用した管理を有効にする方法について説明します。REST API の使用の詳細については、『{start cross reference}Cisco IOS XE REST API Management Reference Guide{end cross reference}』[英語] を参照してください。

インストールの概要

Cisco IOS XE REST API のインストールには、次の一般的な手順が含まれます。

  1. Cisco.com から OVA パッケージをダウンロードします。
    1. シスコルータ製品ページから、Cisco CSR 1000V クラウドサービスルータ製品ページに移動します。{start hypertext}http://www.cisco.com/c/en/us/products/routers/cloud-services-router-1000v-series/index.html{end hypertext} [英語]
    2. [Download Software] リンクをクリックします。
    3. Cisco IOS XE リリースパッケージを選択し、ソフトウェアのダウンロード手順に従います。
  2. ASR プラットフォームに REST API OVA をインストールします。
  3. ASR プラットフォームで REST API を有効にします。

Cisco IOS XE CLI を使用した REST API サポートの有効化

REST API サポートのためのデータプレーンデュアル管理インターフェイスの設定

Cisco IOS XE 3.16 以降では、管理コンテナの IP アドレスを次のいずれかに関連付けることができます。

  • データ プレーン インターフェイス(以下の手順を参照)

または

  • 管理プレーンインターフェイス(「{start cross reference}REST API サポートのための管理プレーンデュアル管理インターフェイスの設定{end cross reference}」を参照)

設定に関する注意事項

{start blocklabel}ルータ管理インターフェイスのサブネットの管理コンテナ IP アドレス{end blocklabel}

ルータの管理インターフェイスに関連付ける管理コンテナの IP アドレスを割り当てるには、管理コンテナに設定されている IP アドレスがルータの管理インターフェイスと同じサブネット内にあることを確認します。次に例を示します。

管理コンテナの IP アドレス:192.168.5.225

ルータ管理インターフェイス:192.168.5.224

{start blocklabel}ゲートウェイポート、管理インターフェイス、および IP アドレスの設定順序{end blocklabel}

次の順序で管理コンテナの詳細を設定します。

  1. vNIC ゲートウェイポート(vnic gateway virtualportgroup0)

  2. ゲスト IP アドレス

ゲスト IP アドレスの後に vNIC 管理インターフェイス(vnic management GigabitEthernet0)を設定できます。

手順の概要

  1. enable
  2. configure terminal
  3. interface GigabitEthernet x
  4. ip address ipv4-addr subnet-mask
  5. no shutdown
  6. exit
  7. interface virtualportgroup virtualportgroup-number
  8. configure terminal
  9. interface virtualportgroup 0
  10. ip unnumbered GigabitEthernet0/0/0
  11. exit
  12. ip route ipv4-address ipv4-subnet-mask VirtualPortGroup0
  13. exit
  14. ip unnumbered GigabitEthernet x
  15. no shutdown
  16. exit
  17. virtual-service csr_mgmt
  18. vnic gateway virtualportgroup virtualportgroup_number
  19. guest ip address remote-mgmt-ipv4-addr
  20. exit
  21. vnic management GigabitEthernet0
  22. exit
  23. activate
  24. end
  25. ip route ipaddress subnetmask virtualportgroup virtualportgroupnumber

手順の詳細

  コマンドまたはアクション 目的

ステップ 1

enable

例:

Router> enable

特権 EXEC モードを有効にします。

  • パスワードを入力します(要求された場合)。

ステップ 2

configure terminal

例:

Router# configure terminal

グローバル コンフィギュレーション モードを開始します。

ステップ 3

interface GigabitEthernet x

例:

Router(config)# interface gigabitethernet1

x で指定されたインターフェイスのインターフェイス コンフィギュレーション モードを開始します。

GigabitEthernet の範囲はプラットフォームによって異なります。

ステップ 4

ip address ipv4-addr subnet-mask

例:

Router(config-if)# ip address 198.51.100.235 255.255.255.128

管理インターフェイスの IP アドレスを設定します。

ステップ 5

no shutdown

例:

Router(config-if)# no shutdown

管理インターフェイスを有効にします。

ステップ 6

exit

例:

Router(config-if)# exit

インターフェイス コンフィギュレーション モードを終了します。

ステップ 7

interface virtualportgroup virtualportgroup-number

例:

Router(config)# interface virtualportgroup 0

仮想ポートグループを作成し、仮想ポート グループ インターフェイス コンフィギュレーション モードを開始します。

ステップ 8

configure terminal

例:

Router(config)# configure terminal

インターフェイス コンフィギュレーション モードを開始します。

ステップ 9

interface virtualportgroup 0

例:

Router(config)# interface virtualportgroup 0

仮想ポートグループを作成し、仮想ポート グループ インターフェイス コンフィギュレーション モードを開始します。

ステップ 10

ip unnumbered GigabitEthernet0/0/0

例:

Router(config)# ip unnumbered GigabitEthernet0/0/0

明示的な IP アドレスをインターフェイスに割り当てずにインターフェイス上の IP 処理を有効にします。

ステップ 11

exit

例:

Router(config)# exit

インターフェイス コンフィギュレーション モードを終了します。

ステップ 12

ip route ipv4-address ipv4-subnet-mask VirtualPortGroup0

例:

Router# ip route 198.51.100.108 255.255.255.255 VirtualPortGroup0

仮想ポートグループにマッピングする IP ルートを作成します。guest ip address コマンドを使用して設定したものと同じ IP アドレスを使用します。

ステップ 13

exit

例:

Router# exit

コンフィギュレーション モードを終了します。

ステップ 14

ip unnumbered GigabitEthernet x

例:

router(config-if)# ip unnumbered gigabitethernet1

明示的な IP アドレスをインターフェイスに割り当てずにインターフェイス上の IP 処理を有効にします。

ステップ 15

no shutdown

例:

router(config-if)# no shutdown

仮想ポート グループ インターフェイスを有効にします。

ステップ 16

exit

例:

router(config-if)# exit

仮想ポート グループ インターフェイス モードを終了します。

ステップ 17

virtual-service csr_mgmt

例:

router(config)# virtual-service csr_mgmt

仮想サービスコンテナを設定し、仮想サービス コンフィギュレーション モードを開始します。

ステップ 18

vnic gateway virtualportgroup virtualportgroup_number

例:

router(config-virt-serv)# vnic gateway virtualportgroup 0

仮想サービスコンテナ用の vNIC ゲートウェイ インターフェイスを作成し、仮想ポートグループにマッピングします。

ステップ 19

guest ip address remote-mgmt-ipv4-addr

例:

router(config-virt-serv-intf)# guest ip address 198.51.100.236

仮想サービスコンテナの vNIC ゲートウェイ インターフェイスのリモート管理 IP アドレスを設定します。

ステップ 20

exit

例:

router(config-virt-serv-intf)# exit

仮想サービス インターフェイス コンフィギュレーション モードを終了し、仮想サービス コンフィギュレーション モードに戻ります。

ステップ 21

vnic management GigabitEthernet0

例:

router(config-virt-serv)# vnic management GigabitEthernet0

(Cisco IOS XE 3.16S 以降のみ)

Cisco IOS XE 3.16S 以降では、2 つの vNIC インターフェイスを設定する必要があります。

  • vNIC ゲートウェイ

  • vNIC 管理

ステップ 22

exit

例:

router(config-virt-serv-vnic)# exit

vNIC 管理モードを終了します。

ステップ 23

activate

例:

router(config-virt-serv-vnic)# activate

csr_mgmt 仮想サービスコンテナをアクティブにします。

ステップ 24

end

例:

router(config-virt-serv)# end

仮想サービス コンフィギュレーション モードを終了し、グローバル コンフィギュレーション モードを開始します。

ステップ 25

ip route ipaddress subnetmask virtualportgroup virtualportgroupnumber

例:

router(config)# ip route 198.51.100.236 255.255.255.255 VirtualPortGroup0

仮想ポートグループにマッピングする IP ルートを作成します。 guest ip address コマンドを使用して設定したものと同じ IP アドレスを使用します。

REST API サポートのための管理プレーンデュアル管理インターフェイスの設定

Cisco IOS XE 3.16 以降では、管理コンテナの IP アドレスを次のいずれかに関連付けることができます。

  • 管理プレーンインターフェイス(以下の手順を参照)

または

  • データ プレーン インターフェイス(「{start cross reference}REST API サポートのための管理プレーンデュアル管理インターフェイスの設定{end cross reference}」を参照)

設定に関する注意事項

{start blocklabel}ルータ管理インターフェイスのサブネットの管理コンテナ IP アドレス{end blocklabel}

ルータの管理インターフェイスに関連付ける管理コンテナの IP アドレスを割り当てるには、管理コンテナに設定されている IP アドレスがルータの管理インターフェイスと同じサブネット内にあることを確認します。次に例を示します。

管理コンテナの IP アドレス:192.168.5.225

ルータ管理インターフェイス:192.168.5.224

{start blocklabel}ゲートウェイポート、管理インターフェイス、および IP アドレスの設定順序{end blocklabel}

次の順序で管理コンテナの詳細を設定します。

  1. vNIC ゲートウェイポート(vnic gateway virtualportgroup0)

  2. vNIC 管理インターフェイス(vNIC management GigabitEthernet0)

  3. ゲスト IP アドレス

データ プレーン インターフェイスを使用する関連手順とは異なり、この場合は、ゲスト IP アドレスを設定する前に vNIC 管理インターフェイスを設定する必要があります。

手順の概要

  1. enable
  2. configure terminal
  3. interface GigabitEthernet x
  4. ip address ipv4-addr subnet-mask
  5. no shutdown
  6. exit
  7. interface virtualportgroup virtualportgroup-number
  8. configure terminal
  9. interface virtualportgroup 0
  10. ip unnumbered GigabitEthernet0/0/0
  11. exit
  12. ip unnumbered GigabitEthernet x
  13. no shutdown
  14. exit
  15. virtual-service csr_mgmt
  16. vnic gateway virtualportgroup virtualportgroup_number
  17. exit
  18. vnic management GigabitEthernet0
  19. guest ip address guest-mgmt-ipv4-address
  20. exit
  21. activate
  22. end
  23. ip route ipaddress subnetmask virtualportgroup virtualportgroupnumber

手順の詳細

  コマンドまたはアクション 目的

ステップ 1

enable

例:

Router> enable

特権 EXEC モードを有効にします。

  • パスワードを入力します(要求された場合)。

ステップ 2

configure terminal

例:

Router# configure terminal

グローバル コンフィギュレーション モードを開始します。

ステップ 3

interface GigabitEthernet x

例:

Router(config)# interface gigabitethernet1

x で指定されたインターフェイスのインターフェイス コンフィギュレーション モードを開始します。

GigabitEthernet の範囲はプラットフォームによって異なります。

ステップ 4

ip address ipv4-addr subnet-mask

例:

Router(config-if)# ip address 198.51.100.235 255.255.255.128

管理インターフェイスの IP アドレスを設定します。

ステップ 5

no shutdown

例:

Router(config-if)# no shutdown

管理インターフェイスを有効にします。

ステップ 6

exit

例:

Router(config-if)# exit

インターフェイス コンフィギュレーション モードを終了します。

ステップ 7

interface virtualportgroup virtualportgroup-number

例:

Router(config)# interface virtualportgroup 0

仮想ポートグループを作成し、仮想ポート グループ インターフェイス コンフィギュレーション モードを開始します。

ステップ 8

configure terminal

例:

Router(config)# configure terminal

インターフェイス コンフィギュレーション モードを開始します。

ステップ 9

interface virtualportgroup 0

例:

Router(config)# interface virtualportgroup 0

仮想ポート グループを作成し、仮想ポート グループ インターフェイス コンフィギュレーション モードを開始します。

ステップ 10

ip unnumbered GigabitEthernet0/0/0

例:

Router(config)# ip unnumbered GigabitEthernet0/0/0

明示的な IP アドレスをインターフェイスに割り当てずにインターフェイス上の IP 処理を有効にします。

ステップ 11

exit

例:

Router(config)# exit

インターフェイス コンフィギュレーション モードを終了します。

ステップ 12

ip unnumbered GigabitEthernet x

例:

router(config-if)# ip unnumbered gigabitethernet1

明示的な IP アドレスをインターフェイスに割り当てずにインターフェイス上の IP 処理を有効にします。

ステップ 13

no shutdown

例:

router(config-if)# no shutdown

仮想ポート グループ インターフェイスを有効にします。

ステップ 14

exit

例:

router(config-if)# exit

仮想ポート グループ インターフェイス モードを終了します。

ステップ 15

virtual-service csr_mgmt

例:

router(config)# virtual-service csr_mgmt

仮想サービスコンテナを設定し、仮想サービス コンフィギュレーション モードを開始します。

ステップ 16

vnic gateway virtualportgroup virtualportgroup_number

例:

router(config-virt-serv)# vnic gateway virtualportgroup 0

仮想サービスコンテナ用の vNIC ゲートウェイ インターフェイスを作成し、仮想ポートグループにマッピングします。

ステップ 17

exit

例:

router(config-virt-serv-intf)# exit

仮想サービス インターフェイス コンフィギュレーション モードを終了し、仮想サービス コンフィギュレーション モードに戻ります。

ステップ 18

vnic management GigabitEthernet0

例:

router(config-virt-serv)# vnic management GigabitEthernet0

(Cisco IOS XE 3.16S 以降のみ)

Cisco IOS XE 3.16S 以降では、2 つの vNIC インターフェイスを設定する必要があります。

  • vNIC ゲートウェイ

  • vNIC 管理

ステップ 19

guest ip address guest-mgmt-ipv4-address

例:

guest ip address 198.51.100.225

仮想サービスコンテナの vNIC ゲートウェイ インターフェイスのリモート管理 IP アドレスを設定します。

ステップ 20

exit

例:

router(config-virt-serv-vnic)# exit

vNIC 管理モードを終了します。

ステップ 21

activate

例:

router(config-virt-serv)# activate

csr_mgmt 仮想サービスコンテナをアクティブにします。

ステップ 22

end

例:

router(config-virt-serv)# end

仮想サービス コンフィギュレーション モードを終了し、グローバル コンフィギュレーション モードを開始します。

ステップ 23

ip route ipaddress subnetmask virtualportgroup virtualportgroupnumber

例:

router(config)# ip route 198.51.100.236 255.255.255.255 VirtualPortGroup0

仮想ポートグループにマッピングする IP ルートを作成します。 guest ip address コマンドを使用して設定したものと同じ IP アドレスを使用します。

REST API ローカルポートと自動保存オプションの設定

Cisco IOS XE リリース 3.13S 以降では、REST API ローカルポートと自動保存オプションを設定できます。

手順の概要

  1. remote-management
  2. restful-api local-port local-port-number
  3. restful-api autosave 間隔

手順の詳細

  コマンドまたはアクション 目的

ステップ 1

remote-management

例:


router(config)# remote-management

リモート管理コンフィギュレーション モードを開始します。

ステップ 2

restful-api local-port local-port-number

例:


router(cfg-remote-mgmt)# restful-api local-port 55443

REST API ローカルポート番号を設定します。有効な範囲は、REST API 仮想サービスコンテナが管理インターフェイスと同じ IP アドレスを使用するか、別の IP アドレスを使用するかによって異なります。

  • デュアル管理インターフェイスが設定されている場合の有効な範囲は 1 ~ 61000 です。
  • 共有管理インターフェイスが設定されている場合の有効な範囲は 55001 ~ 61000 です。

どちらの場合も、デフォルト値は 55443 です。

ステップ 3

restful-api autosave 間隔

例:


Router(cfg-remote-mgmt)# restful-api autosave 60

REST API の自動保存間隔を設定します。範囲は 30 ~ 300 秒で、デフォルトは 30 秒です。

ONEP の設定

オープンネットワーク環境プログラミング インターフェイス(ONEP)は、Cisco IOS および REST API のサービスセットを定義するために使用されます。次の手順で ONEP を設定します。

手順の概要

  1. conf t
  2. onep
  3. service set vty
  4. end

手順の詳細

  コマンドまたはアクション 目的

ステップ 1

conf t

例:


asr1k#conf t 

例:


Enter configuration commands, one per line.  End with CNTL/Z.

コンフィギュレーション モードに入ります。

ステップ 2

onep

例:


asr1k(config)#onep

ONEP モードを開始します。

ステップ 3

service set vty

例:


asr1k(config-onep)#service set vty 

VTY サービスセットを選択します。

ステップ 4

end

例:


asr1k(config-onep)#end

例:


asr1k#

ONEP モードを終了します。

REST API サポートの無効化

REST API のサポートはデフォルトで有効になっています。次の手順で REST API を無効にします。

手順の概要

  1. enable
  2. configure terminal
  3. remote-management
  4. no restful-api
  5. end

手順の詳細

  コマンドまたはアクション 目的

ステップ 1

enable

例:


router> enable

特権 EXEC モードを有効にします。

  • パスワードを入力します(要求された場合)。

ステップ 2

configure terminal

例:


router# configure terminal

グローバル コンフィギュレーション モードを開始します。

ステップ 3

remote-management

例:


router(config)# remote-management

リモート管理コンフィギュレーション モードを開始します。

ステップ 4

no restful-api

例:


router(cfg-remote-mgmt)# no restful-api

REST API のサポートを無効にします。

ステップ 5

end

例:


router(cfg-remote-mgmt)# end

リモート管理コンフィギュレーション モードを終了し、コンフィギュレーション モードを開始します。

次のタスク


(注)  


no restful-api コマンドを使用して REST API サポートを無効にすると、REST API の PUT、POST、および DELETE 操作が無効になります。ただし、GET 操作は引き続き使用できます。

REST API コンテナステータスの表示

show virtual-service detail コマンドを使用して、REST API コンテナのステータスを表示します。