- FutureNet製品活用ガイド
- FutureNet NXR,VXRシリーズ
- REST-API編
FutureNet
NXR,VXRシリーズ
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} | － | 〇 | ● | 〇 | ||
凡例：
● : 読み取り専用ユーザも含めアクセス可
〇 : 読み取り専用ユーザはアクセス不可
－ : 未対応
実行例
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設定 | ||
| ipv6 | IPv6設定 |
||
| 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 ] | ||
| event-notify | event notify設定 | ||
| cms | CMS設定 | ||
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値 … [ 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フィルタログ有効時の値 |
|||
| 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名 | |||
| 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アドレス … autoconfig | ||
| dhcpv6-client | 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 | 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)> | ||||
| rs-interval | RS間隔 … <1-10>（sec） | ||||
| rs-count | RS送信回数 … <1-2147483647(3)> | ||||
| dad-attempt | DAD送信回数 … <0-600(1)> | ||||
| 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名 | ||||
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 | キューイング方式 … [ fair-queue | fifo | policy | priority-group | shape ] | |
| 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 ルートマップ名 | |
mobile
| パラメータおよびレベル | 説明 | ||
|---|---|---|---|
| Lv.3 | Lv.4 | Lv.5 | |
| mobile | ap | apn | APN名 |
| cid | CID … <1-10> | ||
| pdp-type | PDPタイプ … [ ip | ipv6 | ppp ] | ||
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