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

FutureNet

NXR,VXRシリーズ

REST-API編

3. インタフェース設定

3-1. Ethernetインタフェース設定（ethernet-interface）

 処理概要

Ethernetインタフェース設定に関する処理を実行します。

 

URIおよびメソッド

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

凡例：

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

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

－ : 未対応

※ NXR-G100シリーズ以外の機種ではREST-APIv2の利用を推奨します。

 

実行例

Ethernetインタフェース設定の追加

メソッド URI
POST /api/v2/ethernet-interface/ethernet
  • VXR-x64（CXR含む）のみ対応

 

JSON
リクエスト

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

 

{
"ethernet": {
"number": 2,
"ipv4": {
"ipv4-address": {
"address": "192.168.2.254/24"
}
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

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

 

<ethernet-interface>
<ethernet>
<number>2</number>
<ipv4>
<ipv4-address>
<address>192.168.2.254/24</address>
</ipv4-address>
</ipv4>
</ethernet>
</ethernet-interface>

 

レスポンス

201 Created

 

全Ethernetインタフェース設定の取得

メソッド URI
GET /api/{VERSION}/ethernet-interface/ethernet
  • api/v1はtext/plainに対応していません。

 

JSON
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"ethernet": [
{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "192.168.0.1/24"
}
}
},
{
"number": 1,
・・・・・

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<ethernet-interface>
<ethernet>
<number>0</number>
<ipv4>
<ipv4-address>
<address>192.168.0.1/24</address>
</ipv4-address>
</ipv4>
</ethernet>
<ethernet>
<number>1</number>
・・・・・

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

interface ethernet 0
ip address 192.168.0.1/24
interface ethernet 1
ip address 192.168.1.1/24
interface ethernet 2
no ip address

 

Ethernetインタフェース設定の更新

メソッド URI
PUT /api/{VERSION}/ethernet-interface/ethernet/{NUM}
  • api/v1はIPv4アドレスの設定変更のみ対応しています。 また、no ip address設定には対応していません。

 

JSON
リクエスト

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

 

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

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<ethernet>
<number>0</number>
<ipv4>
<ipv4-address>
<address>192.168.0.1/24</address>
</ipv4-address>
</ipv4>
</ethernet>

 

レスポンス

204 No content

 

Ethernetインタフェース設定の取得

メソッド URI
GET /api/{VERSION}/ethernet-interface/ethernet/{NUM}
  • api/v1はtext/plainに対応していません。

 

JSON
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/json

 

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

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<ethernet>
<ipv4>
<ipv4-address>
<address>192.168.0.1/24</address>
</ipv4-address>
</ipv4>
</ethernet>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

interface ethernet 0
ip address 192.168.0.1/24

 

Ethernetインタフェース設定の削除

メソッド URI
DELETE /api/v2/ethernet-interface/ethernet/{NUM}
  • VXR-x64（CXR含む）のみ対応
  • VLANインタフェースが存在する場合は削除不可

 

リクエスト

DELETE /api/v2/ethernet-interface/ethernet/2

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

ethernet-interface

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
ethernet-interface ethernet number インタフェース番号
description インタフェースの説明
ipv4 IPv4設定
ipv6 IPv6設定
bridge-group ブリッジグループ設定
mtu MTU値 … <68-1500>（bytes）
bandwidth 帯域幅 … <1-10000000000>（bits）
speed-duplex Ethernetポートのスピードと全二重/半二重 …
[ auto | auto-limit | 10-full | 10-half | 100-full | 100-half ]
※スイッチングハブポートはこちら
adv-speed advertised max-link-speed … [ 100 | 1000 | 2500 | 5000 ]
mdix-auto EthernetポートのMDI/MDI-X自動判別 … [ enable | disable ]
※スイッチングハブポートはこちら
hub スイッチングハブ設定
link-check リンク監視 … <0-60(10)>（sec）
vrrp VRRP設定
pppoe-client PPPoEクライアント … pppX
※Xはインタフェース番号（ex. ppp0）
l2tpv3 L2TPv3設定
shutdown Ethernetインタフェースの停止 … [ enable | disable ]
ipsec-policy IPsecローカルポリシ番号
ipsec-policy-ignore ipsec-policy-ignore設定
queue キュー設定
route-map ルートマップ設定
invalid-status-drop session invalid-status-drop … [ enable | disable ]
event-notify event notify設定
cms CMS設定
bonding-group bonding-group設定
smp-affinity 受信/送信割り込みの分散 … CPU指定、自動の場合はauto
※CPUはHEXで指定（ex. CPU0:1, CPU1:2, …CPU7:80）
rps rps設定

 

ipv4

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5 Lv.6
ipv4 ipv4-address address  IPv4アドレス …

  • A.B.C.D/M
  • dhcp
  • mape-rule
dhcp-client hostname DHCPホスト名
mode DHCPベンダ固有モード … ngn 
static-route Classless Static Route … [ enable | disable ]
initial-interval DHCPアクセス間隔 … <1-60(3)>（sec）
backoff-cutoff 一時退避最大時間 … <2-60(15)>（sec）
retry DHCPリトライ … <1-3600(300)>（sec）
timeout DHCPタイムアウト … <10-3600(60)>（sec）
option MAP-Eルール名
secondary-address セカンダリIPv4アドレス … A.B.C.D/M 
proxy-arp プロキシARP … [ enable | disable ] 
local-proxy-arp ローカルプロキシARP … [ enable | disable ] 
directed-broadcast ダイレクトブロードキャスト … [ enable | disable ] 
icmp-redirects ICMPリダイレクト … [ enable | disable ] 
icmp-mask-reply ICMPマスク応答 … [ enable | disable ] 
tcp adjust-mss IPv4 TCP MSS調整 … [ enable | disable ] 
mss IPv4 TCP MSS値 … [ auto | <500-1460> ]（bytes）
strip-options IPv4 TCP ストリップオプション …
[ all | md5 | mss | sack | sack-permitted | timestamp | wscale ]
arp reachable-time ARPの有効期間 … <30000-3600000>（msec）
queue-len ARPキュー長 … <1-1000(30)>
filter ARPフィルタ … [ enable | disable ]
gratuitous attempt GARP送信回数 …  [ 0 | <1-255> ]
※0でdisable。GARP有効時のデフォルト値は1
interval GARP送信間隔 … <1-3600>（sec）
※デフォルト値はGARP有効時の値
delay GARP遅延時間 … <1-600(5)>（sec）
※デフォルト値はGARP有効時の値
filter in IPv4入力フィルタ … ACL名
out IPv4出力フィルタ … ACL名 
forward-in IPv4転送フィルタ（forward-in） … ACL名
forward-out IPv4転送フィルタ（forward-out） … ACL名 
spi IPv4 SPIフィルタ … [ enable | disable ]
spi-log log IPv4 SPIフィルタログ … [ enable | disable ]
limit IPv4 SPIフィルタログ出力数制限 … <0-100(10)>
※デフォルト値はIPv4 SPIフィルタログ有効時の値
access-linkdown   IPv4アクセスリンクダウン … [ enable | disable ]
rebound  IPv4リバウンド … [ enable | disable ]
reassemble-output reassemble-output … [ enable | disable ]
mcast-to-ucast-forward multicast to unicast packet forwarding … [ enable | disable ]
nat masquerade IPマスカレード … [ enable | disable ]
snat 送信元NAT … SNAT名
dnat 宛先NAT … DNAT名
rip receive version1 RIP受信バージョン1 … [ enable | disable ]
version2 RIP受信バージョン2 … [ enable | disable ]
send version1 RIP送信バージョン1 … [ enable | disable ]
version2 RIP送信バージョン2 … [ enable | disable ]
split-horizon RIPスプリットホライズン … [enable | poisoned | disable]
ospf cost OSPFコスト … <1-65535>
hello-interval hello-interval … <1-65535>（sec）
dead-interval dead-interval … <1-65535>（sec）
retransmit-interval retransmit-interval … <1-65535(5)>（sec）
transmit-delay transmit-delay … <1-65535>（sec）
auth-type OSPF認証方式 … [ message-digest | null | simple ]
auth-key OSPF認証パスワード
message-digest-key key-id key-id … <1-255>
auth-key OSPF MD5パスワード
priority OSPFプライオリティ … <0-255(1)>
mtu-ignore mtu-ignore … [ enable | disable ]
web-auth forward-in IPv4 Web認証フィルタ（forward-in） … ACL名
forward-out IPv4 Web認証フィルタ（forward-out） … ACL名
acl_p2p p2p-list name P2Pアプリケーション … [ any | bittorrent | share | winny ]
deny P2Pパケット破棄 … [ enable | disable ]
log P2Pログ … [ enable | disable ]
dns-intercept number DNSインターセプト設定番号 … <0-3>

 

ipv6

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5 Lv.6 Lv.7 Lv.8
ipv6 ipv6-address address  IPv6アドレス …

  • X:X::X:X/M
    ※リンクローカルアドレスの場合 … X:X::X:X
  • autoconfig
  • DHCPv6-PD名
  • dhcp
    ※dhcpv6-naの場合に指定
  • proxyconfig
eui-64 eui-64 … [ enable | disable ]
dhcpv6-pd IPv6アドレス … X:X::X:X/M
dhcpv6-na DHCPv6クライアント名
ra-token インタフェースID … ::X:X:X:X
map MAP-Eルール名
dhcpv6-client DHCPv6クライアント名
dhcpv6-server DHCPv6サーバ名
tcp adjust-mss IPv6 TCP MSS調整 … [ enable | disable ] 
mss IPv6 TCP MSS値 … [ auto | <500-1440> ]（bytes）
strip-options IPv6 TCP ストリップオプション …
[ all | md5 | mss | sack | sack-permitted | timestamp | wscale ]
ndp ra send-ra RA送信 … [ enable | disable ]
accept-ra accept-ra … [ enable | disable ]
ra-proxy interface RAプロキシ対象インタフェース名
rs-interval RAプロキシRS送信間隔 … <0-604800(180)>（sec）
rs-count RAプロキシRS送信回数 … <1-255(3)>
ra-prefix prefix IPv6 Prefix … X:X::X:X/M
valid-lifetime 有効期間 … <0-4294967295(2592000)>（sec）
preferred-lifetime 推奨期間 … <0-4294967295(604800)>（sec）
no-advertise no-advertise … [ enable | disable ]
off-link オフリンク … [ enable | disable ]
no-autoconfig no-autoconfig … [ enable | disable ]
ra-lifetime RAライフタイム … <0-9000(1800)>（sec）
ra-min-interval RA最小間隔 … <3-1350(200)>（sec）
ra-max-interval RA最大間隔 … <4-1800(600)>（sec）
managed-config RA flag(Mフラグ) … [ enable | disable ]
other-config RA flag(Oフラグ) … [ enable | disable ]
router-preference ルータプリファレンス … [ high | low | medium ]
no-advertise-lla no-advertise-lla … [ enable | disable ]
dns server address RDNSS IPv6DNSサーバアドレス … X:X::X:X
dns-add-dhcp RDDNSSインタフェース名
rs-interval RS間隔 … <1-10>（sec）
rs-count RS送信回数 … <1-2147483647(3)>
reachable-time 隣接ノードの到達性確認間隔 … <0-3600000(30000)>（msec）
ns-interval NS送信間隔 … <1000-3600000>（msec）
dad-attempt DAD送信回数 … <0-600(1)>
accept-redirects ICMPv6 redirects … [ enable | disable ]
queue-len NDキュー長 … <1-1000(30)>
filter in IPv6入力フィルタ … ACL名
out IPv6出力フィルタ … ACL名 
forward-in IPv6転送フィルタ（forward-in） …  ACL名
forward-out IPv6転送フィルタ（forward-out） …  ACL名 
spi IPv6 SPIフィルタ … [ enable | disable ]
spi-log log IPv6 SPIフィルタログ … [ enable | disable ]
limit IPv6 SPIフィルタログ出力数制限 … <0-100(10)>
※デフォルト値はIPv6 SPIフィルタログ有効時の値
access-linkdown   IPv6アクセスリンクダウン … [ enable | disable ]
rebound  IPv6リバウンド … [ enable | disable ]
hop-limit IPv6ホップリミット … <0-255(64)>
web-auth forward-in IPv6 Web認証フィルタ（forward-in） … ACL名
forward-out IPv6 Web認証フィルタ（forward-out） … ACL名

 

bridge-group

パラメータおよびレベル 値または説明
Lv.3 Lv.4
bridge-group number ブリッジグループ番号
port ブリッジポート番号 … <1-128>
path-cost STPパスコスト … <0-65535>
priority STPプライオリティ … <0-255(128)>

 

hub

  • Lv.4の「portX」はハブのポート番号（ex. port1）
パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5 Lv.6 Lv.7
hub portX speed-duplex ハブポートのスピードと全二重/半二重 …
[ auto | auto-limit | 10-full | 10-half | 100-full | 100-half ]
mdix-auto ハブポートのMDI/MDI-X自動判別 … [ enable | disable ]
shutdown ハブポートのインタフェースの停止 … [ enable | disable ]
vlan default-vlan-id ハブポートのデフォルトVLAN ID … <1-4094>
link ハブポートのVLANリンクモード … [ access | trunk ]
member vlan-id ハブポートのVLAN ID … <1-4094>
membership ハブポートのタグ … [ tagged | untagged ]
port_router vlan default-vlan-id ルータポートのデフォルトVLAN ID … <1-4094>
link ルータポートのVLANリンクモード … [ access | trunk ]
member vlan-id ルータポートのVLAN ID … <1-4094>
membership ルータポートのタグ … [ tagged | untagged ]
vlan-db vlan vlan-id VLAN DBのVLAN ID … <1-4094>

 

vrrp

パラメータおよびレベル 値または説明
Lv.3 Lv.4 Lv.5 Lv.6
vrrp ipv4 id VRRP ID … <1-255>
vip-address VRRP仮想IPv4アドレス … A.B.C.D
preempt VRRPプリエンプト … [ enable | disable ]
preempt-delay VRRPプリエンプト遅延時間 … <1-1000>（sec）
priority VRRPプライオリティ … <1-254(100)>
advertise VRRP広告間隔 … <1-255>（sec）
netevent trackid トラックID
action ネットイベントアクション … priority
option ネットイベントVRRPプライオリティ … <1-254>

 

l2tpv3

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5 Lv.6 Lv.7
l2tpv3 l2rp l2rp-group id L2RP ID … <1-255>
type L2RPマスタタイプ … [ priority | active ]
priority L2RPプライオリティ … <1-255(100)>
preempt L2RPプリエンプト … [ enable | disable ]
fdb-reset FDBリセット … [ enable | disable ]
block-reset ブロックリセット … [ enable | disable ]
timers advertise L2RP広告間隔 … <1-60>（sec）
delay L2RP遅延時間 … <0-60>（sec）
port-reset ポートリセット … <0-1>
filter in L2TPv3フィルタ（in） … ACL名
out L2TPv3フィルタ（out） … ACL名

 

ipsec-policy-ignore

パラメータおよびレベル 説明
Lv.3 Lv.4
ipsec-policy-ignore input ipsec-policy-ignore（in） … [ enable | disable ]
output ipsec-policy-ignore（out） … [ enable | disable ]

 

queue

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5
queue type キューイング方式 … [ shape | policy | fifo | priority-group | fair-queue ]
priority-group priority-map番号
fifo-limit FIFOキュー長 … <1-16384(100)>（pks）
policy bandwidth 帯域幅（Kbps）
name class policy名
ifg IFG … [ enable | disable ]
shape rate shape rate（Kbps）
buffer バケット … <8-1000000>（bytes）
limit キュー長 … <1-1000000>（bytes）
ifg IFG … [ enable | disable ]

 

route-map

パラメータおよびレベル 説明
Lv.3 Lv.4
route-map input classify input ルートマップ名
output classify output ルートマップ名
policy ip policy ルートマップ名

 

event-notify

パラメータおよびレベル 説明
Lv.3 Lv.4
event-notify number event notify番号

 

cms

パラメータおよびレベル 説明
Lv.3 Lv.4
cms watch CMS Watch Status … [ enable | disable ]

 

bonding-group

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5
bonding-group number bonding-group番号
ab-primary active-backup primary … [ enable | disable ]
lacp port-priority LACP port priority … <1-65535>
port-id LACP port ID … <1-65535>
aggregation-key LACP aggregation key … <1-65535>

 

rps

パラメータおよびレベル 説明
Lv.3 Lv.4
rps queue RPSのキュー番号 … <0>
cpus RPSのCPU指定 … CPUはHEXで指定（ex. CPU0:1, CPU1:2, …CPU7:80）