1. FutureNet製品活用ガイド
  2. FutureNet NXR,VXRシリーズ
  3. REST-API編

FutureNet

NXR,VXRシリーズ

REST-API編

3. インタフェース設定

3-2. ループバックインタフェース設定（loopback-interface）

 処理概要

ループバックインタフェース設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
loopback-interface v2 /api/v2/loopback-interface － － － －
/api/v2/loopback-interface/loopback 〇 － ● －
/api/v2/loopback-interface/loopback/{NUM} － 〇 ● 〇

凡例：

● : 読み取り専用ユーザも含めアクセス可

〇 : 読み取り専用ユーザはアクセス不可

－ : 未対応

 

実行例

ループバックインタフェース設定の作成

メソッド URI
POST /api/v2/loopback-interface/loopback
JSON
リクエスト

POST /api/v2/loopback-interface/loopback
Content-Type: application/json

 

{
"loopback": {
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "192.168.0.1/32"
}
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/loopback-interface/loopback
Content-Type: application/xml

 

<loopback-interface>
<loopback>
<number>0</number>
<ipv4>
<ipv4-address>
<address>192.168.0.1/32</address>
</ipv4-address>
</ipv4>
</loopback>
</loopback-interface>

 

レスポンス

201 Created

 

全ループバックインタフェース設定の取得

メソッド URI
GET /api/v2/loopback-interface/loopback
JSON
リクエスト

GET /api/v2/loopback-interface/loopback
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"loopback": [
{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "192.168.0.1/32"
}
}
},
{
"number": 1,
・・・・・

 

XML
リクエスト

GET /api/v2/loopback-interface/loopback
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<loopback-interface>
<loopback>
<number>0</number>
<ipv4>
<ipv4-address>
<address>192.168.0.1/32</address>
</ipv4-address>
</ipv4>
</loopback>
<loopback>
<number>1</number>
・・・・・

 

TEXT/PLAIN
リクエスト

GET /api/v2/loopback-interface/loopback
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

interface loopback 0
ip address 192.168.0.1/32
interface loopback 1
・・・・・

 

ループバックインタフェース設定の更新

メソッド URI
PUT /api/v2/loopback-interface/loopback/{NUM}
JSON
リクエスト

PUT /api/v2/loopback-interface/loopback/0
Content-Type: application/json

 

{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "192.168.0.1/32"
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/loopback-interface/loopback/0
Content-Type: application/xml

 

<loopback>
<number>0</number>
<ipv4>
<ipv4-address>
<address>192.168.0.1/32</address>
</ipv4-address>
</ipv4>
</loopback>

 

レスポンス

204 No content

 

ループバックインタフェース設定の取得

メソッド URI
GET /api/v2/loopback-interface/loopback/{NUM}
JSON
リクエスト

GET /api/v2/loopback-interface/loopback/0
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "192.168.0.1/32"
}
}
}

 

XML
リクエスト

GET /api/v2/loopback-interface/loopback/0
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<loopback>
<number>0</number>
<ipv4>
<ipv4-address>
<address>192.168.0.1/32</address>
</ipv4-address>
</ipv4>
</loopback>

 

TEXT/PLAIN
リクエスト

GET /api/v2/loopback-interface/loopback/0
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

interface loopback 0
ip address 192.168.0.1/32

 

ループバックインタフェース設定の削除

メソッド URI
DELETE /api/v2/loopback-interface/loopback/{NUM}
リクエスト

DELETE /api/v2/loopback-interface/loopback/0

 

レスポンス

204 No content

 

パラメータ

指定可能なパラメータは下記の通りです。

なお、指定可能なパラメータは製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については各製品のユーザーズガイド（CLI版）も合わせてご参照ください。

  • パラメータ表の説明文中の表記について
    [ ] … 括弧内の値のどれかを選択することを示しています。
    数字,文字列 … 初期値
  • パラメータ表の説明文中のデータタイプについて
    A.B.C.D/M … IPv4プレフィックスおよびマスク長
    X:X::X:X … IPv6アドレス
    X:X::X:X/M … IPv6プレフィックスおよびプレフィックス長

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4 Lv.5
loopback-interface loopback number インタフェース番号
description インタフェースの説明
ipv4 ipv4-address address IPv4アドレス … A.B.C.D/M
secondary-address セカンダリIPv4アドレス … A.B.C.D/M
icmp-mask-reply ICMPマスク応答 … [ enable | disable ]
ipv6 ipv6-address address IPv6アドレス …

  • X:X::X:X/M
    ※リンクローカルアドレスの場合 … X:X::X:X
  • DHCPv6-PD名
dhcpv6-pd IPv6アドレス … X:X::X:X/M