FutureNet

NXR,WXRシリーズ

REST-API編

3. インタフェース設定

3-3. PPPインタフェース設定(ppp-interface)

 処理概要

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

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
ppp interface v2 /api/v2/ppp-interface
/api/v2/ppp-interface/pppoe-option
/api/v2/ppp-interface/account-list
/api/v2/ppp-interface/account-list/account
/api/v2/ppp-interface/account-list/account/{USER}
/api/v2/ppp-interface/ppp
/api/v2/ppp-interface/ppp/{NUM}

凡例:〇対応、-未対応

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

 

実行例

PPPoEオプション設定の更新

メソッド URI
PUT /api/v2/ppp-interface/pppoe-option
  • Bodyを指定しなかった場合、デフォルト値になります。

 

JSON
リクエスト

PUT /api/v2/ppp-interface/pppoe-option
Content-Type: application/json

 

{
"pppoe-option": {
"connected-pppoe-session": "disable",
"recv-unknown-ip-packet": "disable",
"recv-unknown-lcp-echo": "disable"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/ppp-interface/pppoe-option
Content-Type: application/xml

 

<ppp-interface>
<pppoe-option>
<connected-pppoe-session>enable</connected-pppoe-session>
<recv-unknown-ip-packet>enable</recv-unknown-ip-packet>
<recv-unknown-lcp-echo>enable</recv-unknown-lcp-echo>
</pppoe-option>
</ppp-interface>

 

レスポンス

204 No content

 

PPPoEオプション設定の取得

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

GET /api/v2/ppp-interface/pppoe-option
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"pppoe-option": {
"connected-pppoe-session": "disable",
"recv-unknown-ip-packet": "disable",
"recv-unknown-lcp-echo": "disable"
}
}

 

XML
リクエスト

GET /api/v2/ppp-interface/pppoe-option
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ppp-interface>
<pppoe-option>
<connected-pppoe-session>disable</connected-pppoe-session>
<recv-unknown-ip-packet>disable</recv-unknown-ip-packet>
<recv-unknown-lcp-echo>disable</recv-unknown-lcp-echo>
</pppoe-option>
</ppp-interface>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ppp-interface/pppoe-option
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

no pppoe-option sent-padt prev-pppoe-session
no pppoe-option sent-padt unknown-ip-packet
no pppoe-option sent-padt unknown-lcp-echo

 

PPPアカウント設定の作成

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

POST /api/v2/ppp-interface/account-list/account
Content-Type: application/json

 

{
"account": {
"username": "test1@example.jp",
"password": {
"passphrase": "test1pass"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/ppp-interface/account-list/account
Content-Type: application/xml

 

<account-list>
<account>
<username>test1@example.jp</username>
<password>
<passphrase>test1pass</passphrase>
</password>
</account>
</account-list>

 

レスポンス

201 Created

 

全PPPアカウント設定の取得

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

GET /api/v2/ppp-interface/account-list/account
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"account": [
{
"username": "test1@example.jp",
"password": {
"passphrase": "test1pass"
}
},
{
"username": "test2@example.jp",
・・・・・

 

XML
リクエスト

GET /api/v2/ppp-interface/account-list/account
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<account-list>
<account>
<username>test1@example.jp</username>
<password>
<passphrase>test1pass</passphrase>
</password>
</account>
<account>
<username>test2@example.jp</username>
・・・・・

 

TEXT/PLAIN
リクエスト

GET /api/v2/ppp-interface/account-list/account
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ppp account username test1@example.jp password test1pass
ppp account username test2@example.jp password test2pass
・・・・・

 

PPPアカウント設定の更新

メソッド URI
PUT /api/v2/ppp-interface/account-list/account/{USER}
JSON
リクエスト

PUT /api/v2/ppp-interface/account-list/account/test1@example.jp
Content-Type: application/json

 

{
"username": "test1@example.jp",
"password": {
"passphrase": "test11pass"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/ppp-interface/account-list/account/test1@example.jp
Content-Type: application/xml

 

<account>
<username>test1@example.jp</username>
<password>
<passphrase>test11pass</passphrase>
</password>
</account>

 

レスポンス

204 No content

 

PPPアカウント設定の取得

メソッド URI
GET /api/v2/ppp-interface/account-list/account/{USER}
JSON
リクエスト

GET /api/v2/ppp-interface/account-list/account/test1@example.jp
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"username": "test1@example.jp",
"password": {
"passphrase": "test1pass"
}
}

 

XML
リクエスト

GET /api/v2/ppp-interface/account-list/account/test1@example.jp
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<account>
<username>test1@example.jp</username>
<password>
<passphrase>test1pass</passphrase>
</password>
</account>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ppp-interface/account-list/account/test1@example.jp
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ppp account username test1@example.jp password test1pass

 

PPPアカウント設定の削除

メソッド URI
DELETE /api/v2/ppp-interface/account-list/account/{USER}
リクエスト

DELETE /api/v2/ppp-interface/account-list/account/test1@example.jp

 

レスポンス

204 No content

 

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

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

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

 

{
"ppp": {
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "negotiated"
},
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
},
"spi": "enable",
"nat": {
"masquerade": "enable"
}
},
"account": {
"username": "test1@example.jp"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

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

 

<ppp-interface>
<ppp>
<number>0</number>
<ipv4>
<ipv4-address>
<address>negotiated</address>
</ipv4-address>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
<spi>enable</spi>
<nat>
<masquerade>enable</masquerade>
</nat>
</ipv4>
<account>
<username>test1@example.jp</username>
</account>
</ppp>
</ppp-interface>

 

レスポンス

201 Created

 

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

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"ppp": [
{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "negotiated"
},
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
},
"spi": "enable",
"nat": {
"masquerade": "enable"
}
},
"account": {
"username": "test1@example.jp"
}
},
{
"number": 1,
・・・・・

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<ppp-interface>
<ppp>
<number>0</number>
<ipv4>
<ipv4-address>
<address>negotiated</address>
</ipv4-address>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
<spi>enable</spi>
<nat>
<masquerade>enable</masquerade>
</nat>
</ipv4>
<account>
<username>test1@example.jp</username>
</account>
</ppp>
<ppp>
<number>1</number>
・・・・・

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

interface ppp 0
ip address negotiated
ip tcp adjust-mss auto
ip masquerade
ip spi-filter
ppp username test1@example.jp
interface ppp 1
・・・・・

 

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

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

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

 

{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "negotiated"
},
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
},
"spi": "enable",
"nat": {
"masquerade": "enable"
}
},
"account": {
"username": "test2@example.jp"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<ppp>
<number>0</number>
<ipv4>
<ipv4-address>
<address>negotiated</address>
</ipv4-address>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
<spi>enable</spi>
<nat>
<masquerade>enable</masquerade>
</nat>
</ipv4>
<account>
<username>test2@example.jp</username>
</account>
</ppp>

 

レスポンス

204 No content

 

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

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "negotiated"
},
"tcp": {
"adjust-mss": "enable",
"mss": "auto"
},
"spi": "enable",
"nat": {
"masquerade": "enable"
}
},
"account": {
"username": "test1@example.jp"
}
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<ppp>
<number>0</number>
<ipv4>
<ipv4-address>
<address>negotiated</address>
</ipv4-address>
<tcp>
<adjust-mss>enable</adjust-mss>
<mss>auto</mss>
</tcp>
<spi>enable</spi>
<nat>
<masquerade>enable</masquerade>
</nat>
</ipv4>
<account>
<username>test1@example.jp</username>
</account>
</ppp>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

interface ppp 0
ip address negotiated
ip tcp adjust-mss auto
ip masquerade
ip spi-filter
ppp username test1@example.jp

 

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

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

DELETE /api/v2/ppp-interface/ppp/0

 

レスポンス

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プレフィックスおよびプレフィックス長

 

ppp-interface

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
ppp-interface ppp number インタフェース番号
description インタフェースの説明
ipv4 IPv4設定
ipv6 IPv6設定
mtu MTU値 … <68-1500>(bytes)
mru MRU値 … <128-1500>(bytes)
keepalive キープアライブ設定
bandwidth 帯域幅 … <1-10000000000>(bits)
pppoe PPPoEサービスネーム設定
callback コールバック許可設定
authentication PPP認証 … [pap | chap | auto]
account PPPアカウント設定
auto-connect 自動再接続 … <10-600>(sec)
ipcp IPCP … [enable | disable]
ipcp-dns IPCP DNS … [accept | reject | specify]
ipcp-ip-request IPCP IPリクエスト … [enable | disable]
ncp NCP設定
dns DNS設定
※ipcp-dnsがspecifyの場合に設定
on-demand オンデマンド … [enable | disable]
idle-timeout アイドルタイムアウト … <30-86400>(sec)
※on-demand有効時のみ動作
idle-sleep アイドルスリープ設定
※idle-timeout設定時のみ動作
crg CRG設定
dialup-string 接続先電話番号 (ex. *99***1#)
dialup-timeout ダイアルタイムアウト … <30-300>(sec)
ipv6cp IPv6CP … [enable | disable]
interface-id IPv6CPインタフェースID …

  • X:X::X:X
  • ethernetX
    ※Xはインタフェース番号 (ex. ethernet0)
peer ピア設定
netevent ネットイベント設定
send_mail メール送信設定
ipsec-policy IPsecローカルポリシ番号
ipsec-policy-ignore ipsec-policy-ignore設定
ipsec-hold-sa ipsec-hold-sa … [enable | disable]
queue キュー設定
route-map ルートマップ設定
mobile モバイル設定
invalid-status-drop session invalid-status-drop … [enable | disable]
event-notify event notify設定
cms CMS設定
pppoe-option connected-pppoe-session connected-pppoe-session … [enable | disable]
recv-unknown-ip-packet recv-unknown-ip-packet … [enable | disable]
recv-unknown-lcp-echo recv-unknown-lcp-echo … [enable | disable]
account-list account アカウント設定

 

ipv4

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5 Lv.6
ipv4 ipv4-address address  IPv4アドレス … A.B.C.D/M、動的の場合はnegotiated
icmp-redirects ICMPリダイレクト … [enable | disable]
icmp-mask-reply ICMPマスク応答 … [enable | disable]
send-source IP send-source … [enable | local | 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>
nat-loopback NATループバック … [enable | disable]
rebound  IPv4リバウンド … [enable | disable]
reassemble-output reassemble-output … [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>(sec)
transmit-delay transmit-delay … <1-65535>(sec)
auth-type OSPF認証方式 … [null | message-digest]
auth-key OSPF認証パスワード
message-digest-key key-id key-id … <1-255>
auth-key OSPF MD5パスワード
priority OSPFプライオリティ … <0-255>
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アドレス …

  • X:X::X:X/M
  • autoconfig
  • DHCPv6-PD名
eui-64 eui-64 … [enable | disable]
dhcpv6-pd IPv6アドレス … X:X::X:X/M
dhcpv6-client DHCPv6クライアント名
tcp adjust-mss IPv6 TCP MSS調整 … [enable | disable]
mss IPv6 TCP MSS値 … <500-1440>(bytes)、オートの場合はauto
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>(sec) 
rs-count RAプロキシRS送信回数 … <1-255>
rs-interval RS間隔 … <1-10>(sec)
rs-count RS送信回数 … <1-2147483647>
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>
rebound  IPv6リバウンド … [enable | disable]
web-auth forward-in IPv6 Web認証フィルタ(forward-in) … ACL名
forward-out IPv6 Web認証フィルタ(forward-out) … ACL名

 

keepalive

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5
keepalive lcp interval LCPキープアライブ間隔 … [0 | <30-600>](sec)
failure-count LCPキープアライブ失敗回数 … <1-10>
icmp interval ICMPキープアライブ間隔 … [0 | <30-600>](sec)
retry ICMPキープアライブリトライ回数 … <0-10>
destination ICMPキープアライブ宛先IPv4アドレス … A.B.C.D

 

pppoe

パラメータおよびレベル 説明
Lv.3 Lv.4
pppoe service-name PPPoEサービスネーム

 

callback

パラメータおよびレベル 説明
Lv.3 Lv.4
callback mode モード … accept
service-name サービス名 … widestar2

 

account(ppp)

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

 

ncp

パラメータおよびレベル 説明
Lv.3 Lv.4
ncp max-configure IPCP configuration requestの最大送信回数 … <1-20>
max-failure configuration request 送信/受信の最大失敗回数 … <1-255>
max-terminate terminate requestの最大送信回数 … <1-10>

 

dns

パラメータおよびレベル 説明
Lv.3 Lv.4
dns primary プライマリIPv4DNSアドレス … A.B.C.D
secondary セカンダリIPv4DNSアドレス … A.B.C.D

 

idle-sleep

パラメータおよびレベル 説明
Lv.3 Lv.4
idle-sleep sleep スリープ … [enable | disable]
resume-method 再開方法 … [timer | schedule]
resume-option 再開オプション … スリープ時間またはスケジュール番号
※resume-methodでtimer選択時はスリープ時間(<1-31536000>(sec))、schedule選択時はスケジュール番号を指定

 

crg

パラメータおよびレベル 説明
Lv.3 Lv.4
crg domain CRGドメイン名

 

peer

パラメータおよびレベル 説明
Lv.3 Lv.4
peer neighbor-route neighbor-route … [enable | disable]

 

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 | ipv4v6 | ipv6 | ppp]
limitation time 接続時間制限 … <30-21474836>(sec)
reconnect 再接続時間制限 … <30-86400>(sec)
data-usage 通信量制限 … <1-1073741824>(KiB)

 

event-notify

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

 

cms

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

 

account(account-list)

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