- FutureNet製品活用ガイド
- FutureNet NXR,VXRシリーズ
- REST-API編
FutureNet
NXR,VXRシリーズ
REST-API編
8. 各種サービス設定
8-6. UPnP設定(upnp)
処理概要
UPnP設定に関する処理を実行します。
URIおよびメソッド
機能 | Version | URI | メソッド | |||
POST | PUT | GET | DELETE | |||
UPnP | v2 | /api/v2/upnp | 〇 | 〇 | ● | 〇 |
凡例:
● : 読み取り専用ユーザも含めアクセス可
〇 : 読み取り専用ユーザはアクセス不可
- : 未対応
実行例
UPnP設定の作成
メソッド | URI |
POST | /api/v2/upnp |
JSON
リクエスト
POST /api/v2/upnp
Content-Type: application/json
{
"service": "enable",
"external": "ethernet1",
"listen": "192.168.0.254/24",
"timeout": 3600
}
レスポンス
201 Created
XML
リクエスト
POST /api/v2/upnp
Content-Type: application/xml
<upnp>
<service>enable</service>
<external>ethernet1</external>
<listen>192.168.0.254/24</listen>
<timeout>3600</timeout>
</upnp>
レスポンス
201 Created
UPnP設定の更新
メソッド | URI |
PUT | /api/v2/upnp |
JSON
リクエスト
PUT /api/v2/upnp
Content-Type: application/json
{
"service": "enable",
"external": "ethernet1",
"listen": "192.168.0.254/24",
"timeout": 3600,
"port-reserve": {
"min": 10000
}
}
レスポンス
204 No content
XML
リクエスト
PUT /api/v2/upnp
Content-Type: application/xml
<upnp>
<service>enable</service>
<external>ethernet1</external>
<listen>192.168.0.254/24</listen>
<timeout>3600</timeout>
<port-reserve>
<min>10000</min>
</port-reserve>
</upnp>
レスポンス
204 No content
UPnP設定の取得
メソッド | URI |
GET | /api/v2/upnp |
JSON
リクエスト
GET /api/v2/upnp
Accept: application/json
レスポンス
200 OK
Content-Type: application/json
{
"service": "enable",
"external": "ethernet1",
"listen": "192.168.0.254/24",
"timeout": 3600,
"port-reserve": {
"min": 10000
}
}
XML
リクエスト
GET /api/v2/upnp
Accept: application/xml
レスポンス
200 OK
Content-Type: application/xml
<upnp>
<service>enable</service>
<external>ethernet1</external>
<listen>192.168.0.254/24</listen>
<timeout>3600</timeout>
<port-reserve>
<min>10000</min>
</port-reserve>
</upnp>
TEXT/PLAIN
リクエスト
GET /api/v2/upnp
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
upnp
service enable
external interface ethernet 1
external port-reserve 10000
listen ip 192.168.0.254/24
timeout 3600
UPnP設定の削除
メソッド | URI |
DELETE | /api/v2/upnp |
リクエスト
DELETE /api/v2/upnp
レスポンス
204 No content
パラメータ
指定可能なパラメータは下記の通りです。
なお、指定可能なパラメータは製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については各製品のユーザーズガイド(CLI版)も合わせてご参照ください。
- パラメータ表の説明文中の表記について
< > … 括弧内の値の範囲から選択することを示しています。
[ ] … 括弧内の値のどれかを選択することを示しています。
数字,文字列 … 初期値 - パラメータ表の説明文中のデータタイプについて
A.B.C.D/M … IPv4プレフィックスおよびマスク長
パラメータおよびレベル | 説明 | ||
---|---|---|---|
Lv.1 | Lv.2 | Lv.3 | |
upnp | service | UPnP機能 … [ enable | disable ] | |
external | インタフェース名(ex. ethernet0) | ||
port-reserve | min | 最小UPnP割り当て禁止ポート番号 … <1-65535> | |
max | 最大UPnP割り当て禁止ポート番号 … <1-65535> | ||
listen | Listen IPアドレス … A.B.C.D/M | ||
timeout | ポートマッピングタイムアウト時間 … <60-21474836(600)>(sec) | ||
well-known-port | well-knownポートへの割り当て … [ enable | disable ] |
目次
- 1. REST-API機能の利用方法およびAuth-IDの発行
- 2. メンテナンス
- 3. インタフェース設定
- 4. ルーティング設定
- 5. アクセスリスト設定
- 6. NAT設定
- 7. VPN設定
- 8. 各種サービス設定
- 各種サービス設定一覧
- 8-1. IPv4DHCPサーバ設定(dhcp-server)
- 8-2. DNS設定(dns)
- 8-3. NTP設定(ntp)
- 8-4. SNMP設定(snmp)
- 8-5. シスログ設定(syslog)
- 8-6. UPnP設定(upnp)
- 8-7. スケジュール設定(scheduler)
- 8-8. WarpLink設定(warplink)
- 8-9. Web認証設定(web-auth)
- 8-10. ターミナルサーバ設定(terminal-server)
- 8-11. SSHサーバ設定(ssh)
- 8-12. TELNETサーバ設定(telnet)
- 8-13. HTTPサーバ設定(http)
- 8-14. CMSv2設定(cms)
- 8-15. DNSインターセプト設定(dns-intercept)
- 8-16. DDNS設定(ddns)
- 8-17. DHCPリレー設定(dhcp-relay)
- 8-18. DHCPv6クライアント設定(dhcp6-client)
- 8-19. DHCPv6サーバ設定(dhcp6-server)
- 8-20. メール設定(mail)
- 8-21. SSLトンネル設定(ssl)
- 8-22. モニタログ設定(monitor-log)
- 8-23. SIP-NAT設定(sip-nat)
- 8-24. NGN-SIP設定(ngn-sip)
- 8-25. Wake ON LAN設定(wol)
- 8-26. DIO設定(dio)
- 8-27. speed-test設定(speed-test)
- 8-28. リバースSSHトンネル設定(reverse-ssh)
- 8-29. QoS設定(qos)
- 9. ネットイベント設定
- 10. モバイル・WiFi設定
- 11. IPv4/IPv6設定
- 12. システム設定
更新情報
→ 一覧へ- 2024.10.01NXR,VXR
ネットイベント編
3-19. DDNSクライアントの有効/無効化設定 - 2024.10.01NXR,VXR
運用管理編
11-3. センチュリー・テクニカルサポート情報の取得と転送 - 2024.09.18NXR,VXR
REST-API編
2-18. センチュリー・テクニカルサポート情報の取得(maint/century-tech-support) - 2024.09.18NXR,VXR
REST-API編
2-17. デバッグタイマの実行(maint/debug) - 2024.09.18NXR,VXR
REST-API編
12-10. SSHクライアント設定(ssh-client)
カテゴリ
タグ
- 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