- FutureNet製品活用ガイド
- FutureNet NXR,VXRシリーズ
- REST-API編
FutureNet
NXR,VXRシリーズ
REST-API編
3. インタフェース設定
3-4. トンネルインタフェース設定（tunnel-interface）
処理概要
トンネルインタフェース設定に関する処理を実行します。
URIおよびメソッド
| 機能 | Version | URI | メソッド | |||
| POST | PUT | GET | DELETE | |||
| tunnel interface | v2 | /api/v2/tunnel-interface | － | － | － | － |
| /api/v2/tunnel-interface/tunnel | 〇 | － | ● | － | ||
| /api/v2/tunnel-interface/tunnel/{NUM} | － | 〇 | ● | 〇 | ||
凡例：
● : 読み取り専用ユーザも含めアクセス可
〇 : 読み取り専用ユーザはアクセス不可
－ : 未対応
実行例
トンネルインタフェース設定の作成
| メソッド | URI |
| POST | /api/v2/tunnel-interface/tunnel |
JSON
リクエスト
POST /api/v2/tunnel-interface/tunnel
Content-Type: application/json
{
"tunnel": {
"number": 1,
"ipv4": {
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
}
},
"tunnel-parameter": {
"mode": "ipsec4",
"protect": "ipsec1"
}
}
}
レスポンス
201 Created
XML
リクエスト
POST /api/v2/tunnel-interface/tunnel
Content-Type: application/xml
<tunnel-interface>
<tunnel>
<number>1</number>
<ipv4>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
</ipv4>
<tunnel-parameter>
<mode>ipsec4</mode>
<protect>ipsec1</protect>
</tunnel-parameter>
</tunnel>
</tunnel-interface>
レスポンス
201 Created
全トンネルインタフェース設定の取得
| メソッド | URI |
| GET | /api/v2/tunnel-interface/tunnel |
JSON
リクエスト
GET /api/v2/tunnel-interface/tunnel
Accept: application/json
レスポンス
200 OK
Content-Type: application/json
{
"tunnel": [
{
"number": 1,
"ipv4": {
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
}
},
"tunnel-parameter": {
"mode": "ipsec4",
"protect": "ipsec1"
}
},
{
"number": 2,
・・・・・
XML
リクエスト
GET /api/v2/tunnel-interface/tunnel
Accept: application/xml
レスポンス
200 OK
Content-Type: application/xml
<tunnel-interface>
<tunnel>
<number>1</number>
<ipv4>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
</ipv4>
<tunnel-parameter>
<mode>ipsec4</mode>
<protect>ipsec1</protect>
</tunnel-parameter>
</tunnel>
<tunnel>
<number>2</number>
・・・・・
TEXT/PLAIN
リクエスト
GET /api/v2/tunnel-interface/tunnel
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
interface tunnel 1
no ip address
ip tcp adjust-mss auto
tunnel mode ipsec ipv4
tunnel protection ipsec policy 1
interface tunnel 2
・・・・・
トンネルインタフェース設定の更新
| メソッド | URI |
| PUT | /api/v2/tunnel-interface/tunnel/{NUM} |
JSON
リクエスト
PUT /api/v2/tunnel-interface/tunnel/1
Content-Type: application/json
{
"number": 1,
"ipv4": {
"ipv4-address": {
"address": "192.168.0.1/32"
},
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
}
},
"tunnel-parameter": {
"mode": "ipsec4",
"protect": "ipsec1"
}
}
レスポンス
204 No content
XML
リクエスト
PUT /api/v2/tunnel-interface/tunnel/1
Content-Type: application/xml
<tunnel>
<number>1</number>
<ipv4>
<ipv4-address>
<address>192.168.0.1/32</address>
</ipv4-address>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
</ipv4>
<tunnel-parameter>
<mode>ipsec4</mode>
<protect>ipsec1</protect>
</tunnel-parameter>
</tunnel>
レスポンス
204 No content
トンネルインタフェース設定の取得
| メソッド | URI |
| GET | /api/v2/tunnel-interface/tunnel/{NUM} |
JSON
リクエスト
GET /api/v2/tunnel-interface/tunnel/1
Accept: application/json
レスポンス
200 OK
Content-Type: application/json
{
"number": 1,
"ipv4": {
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
}
},
"tunnel-parameter": {
"mode": "ipsec4",
"protect": "ipsec1"
}
}
XML
リクエスト
GET /api/v2/tunnel-interface/tunnel/1
Accept: application/xml
レスポンス
200 OK
Content-Type: application/xml
<tunnel>
<number>1</number>
<ipv4>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
</ipv4>
<tunnel-parameter>
<mode>ipsec4</mode>
<protect>ipsec1</protect>
</tunnel-parameter>
</tunnel>
TEXT/PLAIN
リクエスト
GET /api/v2/tunnel-interface/tunnel/1
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
interface tunnel 1
no ip address
ip tcp adjust-mss auto
tunnel mode ipsec ipv4
tunnel protection ipsec policy 1
トンネルインタフェース設定の削除
| メソッド | URI |
| DELETE | /api/v2/tunnel-interface/tunnel/{NUM} |
リクエスト
DELETE /api/v2/tunnel-interface/tunnel/1
レスポンス
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プレフィックスおよびプレフィックス長
FQDN … FQDN名
tunnel-interface
| パラメータおよびレベル | 説明 | ||
|---|---|---|---|
| Lv.1 | Lv.2 | Lv.3 | |
| tunnel-interface | tunnel | number | インタフェース番号 |
| description | インタフェース名 | ||
| ipv4 | IPv4設定 | ||
| ipv6 | IPv6設定 | ||
| tunnel-parameter | トンネルパラメータ設定 | ||
| mtu | MTU値 … <68-1500>（bytes） ※デフォルト値はtunnel modeに依存 |
||
| bandwidth | 帯域幅 … <1-10000000000>（bits） | ||
| netevent | ネットイベント設定 | ||
| 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設定 | ||
ipv4
| パラメータおよびレベル | 説明 | |||
|---|---|---|---|---|
| Lv.3 | Lv.4 | Lv.5 | Lv.6 | |
| ipv4 | ipv4-address | address | IPv4アドレス … A.B.C.D/M | |
| icmp-redirects | ICMPリダイレクト … [ enable | disable ] | |||
| icmp-mask-reply | ICMPマスク応答 … [ enable | disable ] | |||
| send-source | IP send-source … [ enable | local | disable ] ※interface tunnel0,1のみ対応 |
|||
| 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 ] |
|||
| 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フィルタログ有効時の値 |
|||
| nat-loopback | NATループバック … [ 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(1)>（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 | winny | share | bittorrent ] | |
| 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 | |
| ipv6 | ipv6-address | address | IPv6アドレス …
|
||
| dhcpv6-pd | IPv6アドレス … X:X::X:X/M | ||||
| 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 | accept-redirects | ICMPv6 redirects … [ enable | disable ] | |||
| 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フィルタログ有効時の値 |
||||
| rebound | IPv6リバウンド … [ enable | disable ] | ||||
| web-auth | forward-in | IPv6 Web認証フィルタ（forward-in） … ACL名 | |||
| forward-out | IPv6 Web認証フィルタ（forward-out） … ACL名 | ||||
tunnel-parameter
| パラメータおよびレベル | 説明 | ||
|---|---|---|---|
| Lv.3 | Lv.4 | Lv.5 | |
| tunnel-parameter | source | 送信元IPまたはインタフェース …
|
|
| destination | 宛先IPまたはFQDN …
|
||
| mode | カプセル化モード … [ gre | gre6 | ipip | ipsec4 | ipsec6 | ipipv6 | ipv6ip | ipv6ipv6 | 6rd ] |
||
| key | キー … <0-4294967295> | ||
| checksum | チェックサム … [ enable | disable ] | ||
| ttl | TTL … [ <1-255> | inherit ] | ||
| pmtud | Path MTU Discovery … [ enable | disable ] | ||
| tos | ToS … [ <0-252> | inherit ] | ||
| pre-fragment | pre-fragment … [ post | pre ] | ||
| protect | IPsecトンネルポリシー番号 … ipsecX ※Xはトンネルポリシー番号 (ex. ipsec1) |
||
| hop-limit | ホップリミット … <1-255(64)> | ||
| traffic-class | トラフィッククラス … [ <0-252> | inherit ] | ||
| encap-limit | encap-limit … [ <0-255(4)> | none ] | ||
| ip6rd | prefix | 6rd prefix … X:X::X:X/M | |
| ip-prefix-len | Prefix長 … <0-32> | ||
netevent
| パラメータおよびレベル | 説明 | |
|---|---|---|
| Lv.3 | Lv.4 | |
| netevent | track-id | トラックID |
| action | ネットイベントアクション … [ connect | disconnect | reconnect ] | |
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名 | ||
| shape | rate | shape rate（Kbps） | |
| buffer | バケット … <8-1000000>（bytes） | ||
| limit | キュー長 … <1-1000000>（bytes） | ||
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 ] |
目次
- 1. REST-API機能の利用方法およびAuth-IDの発行
- 2. メンテナンス
- 3. インタフェース設定
- インタフェース設定一覧
- 3-1. Ethernetインタフェース設定（ethernet-interface）
- 3-2. ループバックインタフェース設定（loopback-interface）
- 3-3. PPPインタフェース設定（ppp-interface）
- 3-4. トンネルインタフェース設定（tunnel-interface）
- 3-5. TAPインタフェース設定（tap-interface）
- 3-6. ブリッジインタフェース設定（bridge-interface）
- 3-7. WWANインタフェース設定（wwan-interface）
- 3-8. MAPインタフェース設定（map-interface）
- 3-9. WLANインタフェース設定（wlan-interface）
- 3-10. vethインタフェース設定（veth-interface）
- 4. ルーティング設定
- 5. アクセスリスト設定
- 6. NAT設定
- 7. VPN設定
- 8. 各種サービス設定
- 9. ネットイベント設定
- 10. モバイル・WiFi設定
- 11. IPv4/IPv6設定
- 12. システム設定
更新情報
→ 一覧へカテゴリ
タグ
- CRG
- DDNS
- DHCP
- DNAT
- DNSインターセプト
- Ethernet
- IIJモバイル
- IKE Modeconfig
- IKEv2 Configuration Payload
- IPinIP
- IPoE
- IPv6
- KDDI
- L2TPv3
- MAP-E
- NGN
- NTTドコモ
- PBR
- Policy Based IPsec
- PPP
- PPPoE
- QoS
- RADIUS連携
- RAシリーズ
- Route Based IPsec
- SMS
- SNAT
- SoftBank
- UPnP
- URL転送
- VLAN
- VRRP
- Web認証
- WiMAX
- コンフィグロールバック
- ネットイベント
- フィルタ
- ブリッジ
- モニタログ
- ワイモバイル
- 仮想スイッチ
- 冗長化
- 無線LAN