- FutureNet製品活用ガイド
- FutureNet NXR,VXRシリーズ
- REST-API編
FutureNet
NXR,VXRシリーズ
REST-API編
2. メンテナンス
2-16. パケットダンプの実行・結果確認(maint/dump)
処理概要
パケットダンプに関する処理を実行します。
URIおよびメソッド
機能 | Version | URI | メソッド | |||
POST | PUT | GET | DELETE | |||
dump | v2 | /api/v2/maint/dump | ● | - | ● | - |
/api/v2/maint/dump/{ID} | ● | - | ● | ● |
凡例:
● : 読み取り専用ユーザも含めアクセス可
〇 : 読み取り専用ユーザはアクセス不可
- : 未対応
実行例
パケットダンプの取得方法には、標準出力(以下TEXTモード)とファイル出力(以下PCAPモード)があり、どちらのモードで取得するかはパケットダンプ実行時のpcap指定の有無で決まります。
パケットダンプの実行
メソッド | URI |
POST | /api/v2/maint/dump |
パケットダンプの同時実行数はTEXTモードとPCAPモード合わせて4です。ただし、PCAPモードの同時実行数は1となります。
JSON
リクエスト
POST /api/v2/maint/dump
Accept: application/json
Content-Type: application/json
{
"interface": "ethernet1",
"count": 100,
"size": 1518,
"pcap": "enable",
"exclude-filter":[
{
"protocol": "tcp",
"number": 22
}
]
}
レスポンス
202 Accepted
Content-Type: application/json
{
"exec-id": "1234",
"expire": 600
}
XML
リクエスト
POST /api/v2/maint/dump
Accept: application/xml
Content-Type: application/xml
<config>
<interface>ethernet1</interface>
<count>100</count>
<size>1518</size>
<pcap>enable</pcap>
<exclude-filter>
<protocol>tcp</protocol>
<number>22</number>
</exclude-filter>
</config>
レスポンス
202 Accepted
Content-Type: application/xml
<dump>
<exec-id>1234</exec-id>
<expire>600</expire>
</dump>
パケットダンプの実行IDの一覧取得
メソッド | URI |
GET | /api/v2/maint/dump |
JSON
リクエスト
GET /api/v2/maint/dump
Accept: application/json
レスポンス
200 OK
Content-Type: application/json
{
"exec-id": [
"1234",
"5678"
]
}
XML
リクエスト
GET /api/v2/maint/dump
Accept: application/xml
レスポンス
200 OK
Content-Type: application/xml
<exec-id>1234</exec-id>
<exec-id>5678</exec-id>
</dump>
TEXT/PLAIN
リクエスト
GET /api/v2/maint/dump
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
exec-id : 1234
exec-id : 5678
パケットダンプの実行(実行ID指定)
メソッド | URI |
POST | /api/v2/maint/dump/{ID} |
- 実行ID(exec-id)は、0000 ~ ffffまでの4桁の16進数を指定。
- パケットダンプの同時実行数はTEXTモードとPCAPモード合わせて4です。ただし、PCAPモードの同時実行数は1となります。
JSON
リクエスト
POST /api/v2/maint/dump/0001
Accept: application/json
Content-Type: application/json
{
"interface": "ethernet1",
"count": 100,
"size": 1518,
"exclude-filter":[
{
"protocol": "tcp",
"number": 22
}
]
}
レスポンス
202 Accepted
Content-Type: application/json
{
"exec-id": "0001",
"expire": 600
}
XML
リクエスト
POST /api/v2/maint/dump/0001
Accept: application/xml
Content-Type: application/xml
<config>
<interface>ethernet1</interface>
<count>100</count>
<size>1518</size>
<exclude-filter>
<protocol>tcp</protocol>
<number>22</number>
</exclude-filter>
</config>
レスポンス
202 Accepted
Content-Type: application/xml
<dump>
<exec-id>0001</exec-id>
<expire>600</expire>
</dump>
パケットダンプの状態・実行結果の取得
メソッド | URI |
GET | /api/v2/maint/dump/{ID} |
- 実行ID(exec-id)は、0000 ~ ffffまでの4桁の16進数を指定。
- PCAPモードでは状態の取得が可能です。なお、実行結果のファイルはREST-APIの「/maint/copy」などを使用して別途取得する必要があります。
- TEXTモードでは実行結果の取得が可能です。
- TEXTモードの実行結果は600秒後に消去されますが、PCAPモードの実行結果は自動で削除されることはありません。
PCAPモード(TEXT/PLAIN)
リクエスト
GET /api/v2/maint/dump/0001
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
status: capturing
TEXTモード(TEXT/PLAIN)
リクエスト
GET /api/v2/maint/dump/0001
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
[started: 2023/04/27 17:13:58]
tcpdump: verbose output suppressed, use -v or -vv for full protocol decode
listening on eth1, link-type EN10MB (Ethernet), capture size 1518 bytes
17:21:34.749996 IP 192.168.10.100 > 192.168.10.1: ICMP echo request, id 2336, seq 1, length 64
17:21:34.750106 IP 192.168.10.1 > 192.168.10.100: ICMP echo reply, id 2336, seq 1, length 64
17:21:35.757258 IP 192.168.10.100 > 192.168.10.1: ICMP echo request, id 2336, seq 2, length 64
17:21:35.757289 IP 192.168.10.1 > 192.168.10.100: ICMP echo reply, id 2336, seq 2, length 64
17:21:36.757780 IP 192.168.10.100 > 192.168.10.1: ICMP echo request, id 2336, seq 3, length 64
17:21:36.757803 IP 192.168.10.1 > 192.168.10.100: ICMP echo reply, id 2336, seq 3, length 64
17:21:37.759549 IP 192.168.10.100 > 192.168.10.1: ICMP echo request, id 2336, seq 4, length 64
17:21:37.759572 IP 192.168.10.1 > 192.168.10.100: ICMP echo reply, id 2336, seq 4, length 64
パケットダンプの実行停止・結果の削除
メソッド | URI |
DELETE | /api/v2/maint/dump/{ID} |
- TEXTモードでは実行処理の停止およびパケットダンプ結果の削除を行います。
- PCAPモードでは実行処理の停止を行います。なお、パケットダンプ結果は自動で削除されることはありませんので、REST-APIの「/maint/cli」で delete dumpなどを実行する必要があります。また、パケットダンプ実行中はdelete dumpによる削除はできません。
リクエスト
DELETE /api/v2/maint/dump/0001
レスポンス
204 No content
パラメータ
指定可能なパラメータは下記の通りです。
なお、指定可能なパラメータは製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については各製品のユーザーズガイド(CLI版)も合わせてご参照ください。
- パラメータ表の説明文中の記号について
< > … 括弧内の値の範囲から選択することを示しています。
[ ] … 括弧内の値のどれかを選択することを示しています。
パラメータおよびレベル | 説明 | ||
---|---|---|---|
Lv.1 | Lv.2 | Lv.3 | |
config | interface | パケットダンプ対象のインタフェース名(ex. ethernet0) | |
count | パケット数 … <1-99999> | ||
size | パケットサイズ … <64-1518> | ||
pcap | PCAPモード … [ enable | disable ] | ||
exclude-filter | protocol | ダンプ対象外プロトコル … [ arp | esp | gre | icmp | ip | ipproto | ipv6 | l2tpv3 | ospf | ssh | tcp | telnet | udp ] |
|
number | ダンプ対象外プロトコル,TCP/UDPポート番号 …
|
||
include-filter | protocol | ダンプ対象プロトコル … [ arp | esp | gre | icmp | ip | ipproto | ipv6 | l2tpv3 | ospf | ssh | tcp | telnet | udp ] |
|
number | ダンプ対象プロトコル,TCP/UDPポート番号 …
|
目次
- 1. REST-API機能の利用方法およびAuth-IDの発行
- 2. メンテナンス
- メンテナンス一覧
- 2-1. 機器再起動(maint/restart)
- 2-2. 設定の保存(maint/save-config)
- 2-3. 各種コピー操作(maint/copy)
- 2-4. startup-configの保存・取得(maint/startup-config)
- 2-5. ファームウェアの更新(maint/firmware/update)
- 2-6. ファームウェアリストアップデートでの更新(maint/firmware/list-update)
- 2-7. ファームウェアバージョンの取得(maint/firmware/version)
- 2-8. exec系,showコマンドの実行(maint/cli)
- 2-9. configの反映・取得(maint/config)
- 2-10. ロールバックの実行・ロールバック用コマンドの確認(maint/rollback-config)
- 2-11. ロールバックタイマの取得・停止(maint/rollback-timer)
- 2-12. ping(IPv4)の実行・結果確認(maint/ping)
- 2-13. Ping(IPv6)の実行・結果確認(maint/ping6)
- 2-14. traceroute(IPv4)の実行・結果確認(maint/traceroute)
- 2-15. traceroute(IPv6)の実行・結果確認(maint/traceroute6)
- 2-16. パケットダンプの実行・結果確認(maint/dump)
- 2-17. デバッグタイマの実行(maint/debug)
- 2-18. センチュリー・テクニカルサポート情報の取得(maint/century-tech-support)
- 3. インタフェース設定
- 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