FutureNet

NXR,WXRシリーズ

REST-API編

3. インタフェース設定

3-9. WLANインタフェース設定(wlan-interface)

 処理概要

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

 

URIおよびメソッド

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

凡例:〇対応、-未対応

 

実行例

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

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

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

 

{
"wlan": {
"number": 0,
"wlan-parameter": {
"ssid": "nxrg050wlan0",
"authenticate": {
"type": "wpa2-psk",
"encrypt": "aes"
},
"wpa-psk": {
"password": {
"passphrase": "nxrg050wlan0pass"
}
}
},
"ipv4": {
"ipv4-address": {
"address": "192.168.11.1/24"
}
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

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

 

<wlan-interface>
<wlan>
<number>0</number>
<wlan-parameter>
<ssid>nxrg050wlan0</ssid>
<authenticate>
<type>wpa2-psk</type>
<encrypt>aes</encrypt>
</authenticate>
<wpa-psk>
<password>
<passphrase>nxrg050wlan0pass</passphrase>
</password>
</wpa-psk>
</wlan-parameter>
<ipv4>
<ipv4-address>
<address>192.168.11.1/24</address>
</ipv4-address>
</ipv4>
</wlan>
</wlan-interface>

 

レスポンス

201 Created

 

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

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"wlan": {
"number": 0,
"wlan-parameter": {
"ssid": "nxrg050wlan0",
"authenticate": {
"type": "wpa2-psk",
"encrypt": "aes"
},
"wpa-psk": {
"password": {
"passphrase": "nxrg050wlan0pass"
}
}
},
"ipv4": {
"ipv4-address": {
"address": "192.168.11.1/24"
}
}
}
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<wlan-interface>
<wlan>
<number>0</number>
<wlan-parameter>
<ssid>nxrg050wlan0</ssid>
<authenticate>
<type>wpa2-psk</type>
<encrypt>aes</encrypt>
</authenticate>
<wpa-psk>
<password>
<passphrase>nxrg050wlan0pass</passphrase>
</password>
</wpa-psk>
</wlan-parameter>
<ipv4>
<ipv4-address>
<address>192.168.11.1/24</address>
</ipv4-address>
</ipv4>
</wlan>
</wlan-interface>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

interface wlan 0
wlan ssid nxrg050wlan0
wlan wpa-psk password nxrg050wlan0pass
wlan authenticate wpa2-psk aes
ip address 192.168.11.1/24

 

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

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

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

 

{
"number": 0,
"wlan-parameter": {
"ssid": "nxrg050wlan0",
"max-associations": 16,
"authenticate": {
"type": "wpa2-psk",
"encrypt": "aes"
},
"wpa-psk": {
"password": {
"passphrase": "nxrg050wlan0pass"
}
}
},
"ipv4": {
"ipv4-address": {
"address": "192.168.11.1/24"
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<wlan>
<number>0</number>
<wlan-parameter>
<ssid>nxrg050wlan0</ssid>
<max-associations>16</max-associations>
<authenticate>
<type>wpa2-psk</type>
<encrypt>aes</encrypt>
</authenticate>
<wpa-psk>
<password>
<passphrase>nxrg050wlan0pass</passphrase>
</password>
</wpa-psk>
</wlan-parameter>
<ipv4>
<ipv4-address>
<address>192.168.11.1/24</address>
</ipv4-address>
</ipv4>
</wlan>

 

レスポンス

204 No content

 

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

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 0,
"wlan-parameter": {
"ssid": "nxrg050wlan0",
"max-associations": 16,
"authenticate": {
"type": "wpa2-psk",
"encrypt": "aes"
},
"wpa-psk": {
"password": {
"passphrase": "nxrg050wlan0pass"
}
}
},
"ipv4": {
"ipv4-address": {
"address": "192.168.11.1/24"
}
}
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<wlan>
<number>0</number>
<wlan-parameter>
<ssid>nxrg050wlan0</ssid>
<max-associations>16</max-associations>
<authenticate>
<type>wpa2-psk</type>
<encrypt>aes</encrypt>
</authenticate>
<wpa-psk>
<password>
<passphrase>nxrg050wlan0pass</passphrase>
</password>
</wpa-psk>
</wlan-parameter>
<ipv4>
<ipv4-address>
<address>192.168.11.1/24</address>
</ipv4-address>
</ipv4>
</wlan>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

interface wlan 0
wlan ssid nxrg050wlan0
wlan max-associations 16
wlan wpa-psk password nxrg050wlan0pass
wlan authenticate wpa2-psk aes
ip address 192.168.11.1/24

 

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

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

DELETE /api/v2/wlan-interface/wlan/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プレフィックスおよびプレフィックス長

 

wlan-interface

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
wlan-interface
wlan number インタフェース番号
description インタフェースの説明
wlan-parameter WLAN設定
ipv4 IPv4設定
ipv6 IPv6設定
bridge-group ブリッジグループ設定
mtu MTU値 … <68-1500>(bytes)
bandwidth 帯域幅 … <1-10000000000>(bits)
l2tpv3 L2TPv3設定
shutdown wlanインタフェースの停止 … [ enable | disable ]
ipsec-policy IPsecローカルポリシ番号
ipsec-policy-ignore ipsec-policy-ignore設定
route-map ルートマップ設定
invalid-status-drop session invalid-status-drop … [ enable | disable ]

 

wlan-parameter

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5 Lv.6 Lv.7
wlan-parameter mode mode … [ access-point | station ]
scan-ssid ActiveScan … [ enable | disable ]
eap type EAP Type … [ tls | ttls | peap ]
identity Identity
password hidden 暗号化 … [ enable | disable ]
passphrase パスワード
apply 暗号化適用 … [ enable | disable ]
※hidden化する場合は必要
private-key password hidden 暗号化 … [ enable | disable ]
passphrase パスワード
apply 暗号化適用 … [ enable | disable ]
※hidden化する場合は必要
ssid SSID
guest-mode ゲストモード … [ enable | disable ] 
access-point-bridge プライバシープロテクション … [ enable | disable ]
max-asociations 接続台数制限 … <1-255>
※設定可能範囲は機種により異なります
dtim-period DTIM周期 … <1-255>
※設定可能範囲は機種により異なります
authenticate type 認証方式 … [ open-system | shared-key | wpa-psk | wpa2-psk | wpa-mixed-psk | wpa-eap | wpa2-eap | wpa-mixed-eap ]
※設定可能項目は機種により異なります
encrypt 暗号方式 … [ wep | tkip | aes ]
※設定可能項目は機種により異なります
wep-key key number Key番号 … <1-255>
password hidden 暗号化 … [ enable | disable ]
passphrase パスワード
apply 暗号化適用 … [ enable | disable ]
※hidden化する場合は必要
wpa-psk password hidden 暗号化 … [ enable | disable ]
passphrase パスワード
apply 暗号化適用 … [ enable | disable ]
※hidden化する場合は必要
rekey gtk GTK Rekey … <1-255>
gtk-strict GTK strict … [ enable | disable ]
gmk GMK Rekey … <1-255>
ptk PTK Rekey … <1-255>
radius authentication address IPv4アドレス … A.B.C.D
password hidden 暗号化 … [ enable | disable ]
passphrase パスワード
apply 暗号化適用 … [ enable | disable ]
※hidden化する場合は必要
port ポート番号 … [ 1645 | <1024-65535> ]
accounting address IPv4アドレス … A.B.C.D
password hidden 暗号化 … [ enable | disable ]
passphrase パスワード
apply 暗号化適用 … [ enable | disable ]
※hidden化する場合は必要
port ポート番号 … [ 1646 | <1024-65535> ]
attribute type アトリビュートタイプ … [ nas-identifier | nas-ip-address ]
value アトリビュート値 …

  • アトリビュート
  • A.B.C.D
dead-interval 切り戻し間隔 … <60-86400>(sec)
mac-access-list permission パーミッション … [ disable | deny | permit ]
mac-address MACアドレス
inactive-timeout 無通信監視 … <60-3600>(sec)
※設定可能範囲は機種により異なります

 

ipv4

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

  • A.B.C.D/M
  • dhcp
dhcp-client hostname DHCPホスト名
secondary-address セカンダリIPv4アドレス … A.B.C.D/M 
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>
filter ARPフィルタ … [ enable | disable ]
gratuitous attempt GARP送信回数 … <1-255>
interval GARP送信間隔 … <1-3600>(sec)
delay GARP遅延時間 … <1-600>(sec)
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>
access-linkdown   IPv4アクセスリンクダウン … [ 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名

 

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名
eui-64 eui-64 … [ enable | disable ]
dhcpv6-pd IPv6アドレス … X:X::X:X/M
ra-token インタフェースID … ::X:X:X:X
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-prefix prefix IPv6 Prefix … X:X::X:X/M
valid-lifetime 有効期間 … <0-4294967295>(sec)
preferred-lifetime 推奨期間 … <0-4294967295>(sec)
no-advertise no-advertise … [ enable | disable ]
off-link オフリンク … [ enable | disable ]
no-autoconfig no-autoconfig … [ enable | disable ]
ra-lifetime RAライフタイム … <0-9000>(sec)
ra-min-interval RA最小間隔 … <3-1350>(sec)
ra-max-interval RA最大間隔 … <4-1800>(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>
reachable-time 隣接ノードの到達性確認間隔 … <0-3600000>(msec)
ns-interval NS送信間隔 … <1000-3600000>(msec)
dad-attempt DAD送信回数 … <0-600>
accept-redirects ICMPv6 redirects … [ enable | disable ]
queue-len NDキュー長 … <1-1000>
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>
access-linkdown   IPv6アクセスリンクダウン … [ enable | disable ]
rebound  IPv6リバウンド … [ enable | disable ]
hop-limit IPv6ホップリミット … <0-255>
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>

 

l2tpv3

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5 Lv.6 Lv.7
l2tpv3 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 ]

 

route-map

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