FutureNet

NXR,WXRシリーズ

REST-API編

3. インタフェース設定

3-7. WWANインタフェース設定(wwan-interface)

 処理概要

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

 

URIおよびメソッド

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

凡例:〇対応、-未対応

  • api/v1は対応していません。

 

実行例

WWANインタフェース設定の作成

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

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

 

{
"wwan": {
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "dhcp"
},
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
},
"spi": "enable",
"nat": {
"masquerade": "enable"
}
},
"mobile": {
"ap": {
"apn": "example.com",
"cid": 1,
"pdp-type": "ip"
}
},
"account": {
"username": "test1",
"password": {
"passphrase": "test1pass"
}
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

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

 

<wwan-interface>
<wwan>
<number>0</number>
<ipv4>
<ipv4-address>
<address>dhcp</address>
</ipv4-address>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
<spi>enable</spi>
<nat>
<masquerade>enable</masquerade>
</nat>
</ipv4>
<mobile>
<ap>
<apn>example.com</apn>
<cid>1</cid>
<pdp-type>ip</pdp-type>
</ap>
</mobile>
<account>
<username>test1</username>
<password>
<passphrase>test1pass</passphrase>
</password>
</account>
</wwan>
</wwan-interface>

 

レスポンス

201 Created

 

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

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"wwan": {
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "dhcp"
},
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
},
"spi": "enable",
"nat": {
"masquerade": "enable"
}
},
"mobile": {
"ap": {
"apn": "example.com",
"cid": 1,
"pdp-type": "ip"
}
},
"account": {
"username": "test1",
"password": {
"passphrase": "test1pass"
}
}
}
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<wwan-interface>
<wwan>
<number>0</number>
<ipv4>
<ipv4-address>
<address>dhcp</address>
</ipv4-address>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
<spi>enable</spi>
<nat>
<masquerade>enable</masquerade>
</nat>
</ipv4>
<mobile>
<ap>
<apn>example.com</apn>
<cid>1</cid>
<pdp-type>ip</pdp-type>
</ap>
</mobile>
<account>
<username>test1</username>
<password>
<passphrase>test1pass</passphrase>
</password>
</account>
</wwan>
</wwan-interface>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

interface wwan 0
ip address dhcp
ip tcp adjust-mss auto
ip masquerade
ip spi-filter
wwan auto-connect
wwan username test1 password test1pass
mobile apn example.com cid 1 pdp-type ip

 

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

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

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

 

{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "dhcp"
},
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
},
"spi": "enable",
"nat": {
"masquerade": "enable"
}
},
"mobile": {
"ap": {
"apn": "example.com",
"cid": 1,
"pdp-type": "ip"
}
},
"account": {
"username": "test2",
"password": {
"passphrase": "test2pass"
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<wwan>
<number>0</number>
<ipv4>
<ipv4-address>
<address>dhcp</address>
</ipv4-address>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
<spi>enable</spi>
<nat>
<masquerade>enable</masquerade>
</nat>
</ipv4>
<mobile>
<ap>
<apn>example.com</apn>
<cid>1</cid>
<pdp-type>ip</pdp-type>
</ap>
</mobile>
<account>
<username>test2</username>
<password>
<passphrase>test2pass</passphrase>
</password>
</account>
</wwan>

 

レスポンス

204 No content

 

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

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "dhcp"
},
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
},
"spi": "enable",
"nat": {
"masquerade": "enable"
}
},
"mobile": {
"ap": {
"apn": "example.com",
"cid": 1,
"pdp-type": "ip"
}
},
"account": {
"username": "test2",
"password": {
"passphrase": "test2pass"
}
}
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<wwan>
<number>0</number>
<ipv4>
<ipv4-address>
<address>dhcp</address>
</ipv4-address>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
<spi>enable</spi>
<nat>
<masquerade>enable</masquerade>
</nat>
</ipv4>
<mobile>
<ap>
<apn>example.com</apn>
<cid>1</cid>
<pdp-type>ip</pdp-type>
</ap>
</mobile>
<account>
<username>test2</username>
<password>
<passphrase>test2pass</passphrase>
</password>
</account>
</wwan>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

interface wwan 0
ip address dhcp
ip tcp adjust-mss auto
ip masquerade
ip spi-filter
wwan auto-connect
wwan username test2 password test2pass
mobile apn example.com cid 1 pdp-type ip

 

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

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

DELETE /api/v2/wwan-interface/wwan/0

 

レスポンス

204 No content

 

パラメータ

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

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

  • パラメータ表の説明文中の記号について
    < > … 括弧内の値の範囲から選択することを示しています。
    [ ] … 括弧内の値のどれかを選択することを示しています。

 

wwan-interface

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
wwan-interface wwan number インタフェース番号
description インタフェースの説明
ipv4 IPv4設定
mtu MTU値 … <68-1500>(bytes)
bandwidth 帯域幅 … <1-10000000000>(bits)
authentication WWAN認証 … [pap | chap]
account WWANアカウント設定
auto-connect 自動再接続 … [enable | disable]
netevent ネットイベント設定
send_mail メール送信設定
ipsec-policy IPsecローカルポリシ番号
ipsec-policy-ignore ipsec-policy-ignore設定
queue キュー設定
route-map ルートマップ設定
area-check モバイルエリア監視 … <1-1440>
mobile モバイル設定
invalid-status-drop session invalid-status-drop … [enable | disable]

 

ipv4

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5 Lv.6
ipv4 ipv4-address address  IPv4アドレス … dhcp
icmp-redirects ICMPリダイレクト … [enable | disable]
icmp-mask-reply ICMPマスク応答 … [enable | disable]
tcp adjust-mss IPv4 TCP MSS調整 … [enable | disable] 
mss IPv4 TCP MSS値 … <500-1460>(bytes)、オートの場合はauto 
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>
rebound  IPv4リバウンド … [enable | disable]
reassemble-output reassemble-output … [enable | disable]
nat masquerade IPマスカレード … [enable | disable]
snat 送信元NAT … SNAT名
dnat 宛先NAT … DNAT名
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>

 

account(wwan)

パラメータおよびレベル   説明
Lv.3 Lv.4 Lv.5
account username ユーザ名
password hidden 暗号化 … [enable | disable]
passphrase パスワード
apply 暗号化適用 … [enable | disable]
※hidden化する場合は必要

 

netevent

パラメータおよびレベル 説明
Lv.3 Lv.4
netevent track-id トラックID
action ネットイベントアクション … [connect | disconnect | reconnect]

 

send_mail

パラメータおよびレベル 説明
Lv.3 Lv.4
send_mail server メールサーバ番号 … <0-2>
to 宛先メールアドレス (ex. test@example.com)
from 送信元メールアドレス (ex. nxr@example.com)
subject 件名

 

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>(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 ルートマップ名

 

mobile

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5
mobile ap apn APN名
cid CID … <1-10>
pdp-type PDPタイプ … [ip | ppp]