FutureNet

NXR,WXRシリーズ

REST-API編

11. IPv4/IPv6設定

11-5. IPv4ネットワーキング設定(ipv4-networking)

 処理概要

IPv4ネットワーキング設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
ipv4-networking v2 /api/v2/ipv4-networking
/api/v2/ipv4-networking/icmp-errors-inbound
/api/v2/ipv4-networking/martian-log
/api/v2/ipv4-networking/arp-invalid-log
/api/v2/ipv4-networking/reassemble-output
/api/v2/ipv4-networking/tcp
/api/v2/ipv4-networking/ip-local
/api/v2/ipv4-networking/ip-local/policy-routemap
/api/v2/ipv4-networking/ip-host
/api/v2/ipv4-networking/ip-host/host-list
/api/v2/ipv4-networking/ip-host/host-list/{FQDN}

凡例:〇対応、-未対応

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

 

実行例

icmp-errors-inbound設定の更新

メソッド URI
PUT /api/v2/ipv4-networking/icmp-errors-inbound
JSON
リクエスト

PUT /api/v2/ipv4-networking/icmp-errors-inbound
Content-Type: application/json

 

{
"icmp-errors-inbound": "enable"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/ipv4-networking/icmp-errors-inbound
Content-Type: application/xml

 

<ipv4-networking>
<icmp-errors-inbound>enable</icmp-errors-inbound>
</ipv4-networking>

 

レスポンス

204 No content

 

icmp-errors-inbound設定の取得

メソッド URI
GET /api/v2/ipv4-networking/icmp-errors-inbound
JSON
リクエスト

GET /api/v2/ipv4-networking/icmp-errors-inbound
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"icmp-errors-inbound": "enable"
}

 

XML
リクエスト

GET /api/v2/ipv4-networking/icmp-errors-inbound
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ipv4-networking>
<icmp-errors-inbound>enable</icmp-errors-inbound>
</ipv4-networking>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ipv4-networking/icmp-errors-inbound
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip icmp-errors-inbound

 

icmp-errors-inbound設定の削除

メソッド URI
DELETE /api/v2/ipv4-networking/icmp-errors-inbound

 

リクエスト

DELETE /api/v2/ipv4-networking/icmp-errors-inbound

 

レスポンス

204 No content

 

martian-log設定の更新

メソッド URI
PUT /api/v2/ipv4-networking/martian-log
JSON
リクエスト

PUT /api/v2/ipv4-networking/martian-log
Content-Type: application/json

 

{
"martian-log": "enable"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/ipv4-networking/martian-log
Content-Type: application/xml

 

<ipv4-networking>
<martian-log>enable</martian-log>
</ipv4-networking>

 

レスポンス

204 No content

 

martian-log設定の取得

メソッド URI
GET /api/v2/ipv4-networking/martian-log
JSON
リクエスト

GET /api/v2/ipv4-networking/martian-log
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"martian-log": "enable"
}

 

XML
リクエスト

GET /api/v2/ipv4-networking/martian-log
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ipv4-networking>
<martian-log>enable</martian-log>
</ipv4-networking>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ipv4-networking/martian-log
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip martian-log

 

martian-log設定の削除

メソッド URI
DELETE /api/v2/ipv4-networking/martian-log

 

リクエスト

DELETE /api/v2/ipv4-networking/martian-log

 

レスポンス

204 No content

 

arp-invalid-log設定の更新

メソッド URI
PUT /api/v2/ipv4-networking/arp-invalid-log
JSON
リクエスト

PUT /api/v2/ipv4-networking/arp-invalid-log
Content-Type: application/json

 

{
"arp-invalid-log": "enable"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/ipv4-networking/arp-invalid-log
Content-Type: application/xml

 

<ipv4-networking>
<arp-invalid-log>enable</arp-invalid-log>
</ipv4-networking>

 

レスポンス

204 No content

 

arp-invalid-log設定の取得

メソッド URI
GET /api/v2/ipv4-networking/arp-invalid-log
JSON
リクエスト

GET /api/v2/ipv4-networking/arp-invalid-log
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"arp-invalid-log": "enable"
}

 

XML
リクエスト

GET /api/v2/ipv4-networking/arp-invalid-log
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ipv4-networking>
<arp-invalid-log>enable</arp-invalid-log>
</ipv4-networking>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ipv4-networking/arp-invalid-log
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip arp-invalid-log

 

arp-invalid-log設定の削除

メソッド URI
DELETE /api/v2/ipv4-networking/arp-invalid-log

 

リクエスト

DELETE /api/v2/ipv4-networking/arp-invalid-log

 

レスポンス

204 No content

 

reassemble-output設定の更新

メソッド URI
PUT /api/v2/ipv4-networking/reassemble-output
JSON
リクエスト

PUT /api/v2/ipv4-networking/reassemble-output
Content-Type: application/json

 

{
"reassemble-output": "disable"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/ipv4-networking/reassemble-output
Content-Type: application/xml

 

<ipv4-networking>
<reassemble-output>disable</reassemble-output>
</ipv4-networking>

 

レスポンス

204 No content

 

reassemble-output設定の取得

メソッド URI
GET /api/v2/ipv4-networking/reassemble-output
JSON
リクエスト

GET /api/v2/ipv4-networking/reassemble-output
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"reassemble-output": "disable"
}

 

XML
リクエスト

GET /api/v2/ipv4-networking/reassemble-output
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ipv4-networking>
<reassemble-output>disable</reassemble-output>
</ipv4-networking>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ipv4-networking/reassemble-output
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

no ip reassemble-output

 

reassemble-output設定の削除

メソッド URI
DELETE /api/v2/ipv4-networking/reassemble-output

 

リクエスト

DELETE /api/v2/ipv4-networking/reassemble-output

 

レスポンス

204 No content

 

tcp設定の更新

メソッド URI
PUT /api/v2/ipv4-networking/tcp
  • Bodyを指定しなかった場合、設定を削除します。

 

JSON
リクエスト

PUT /api/v2/ipv4-networking/tcp
Content-Type: application/json

 

{
"tcp": {
"min-snd-mss": 1000
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/ipv4-networking/tcp
Content-Type: application/xml

 

<ipv4-networking>
<tcp>
<min-snd-mss>1000</min-snd-mss>
</tcp>
</ipv4-networking>

 

レスポンス

204 No content

 

tcp設定の取得

メソッド URI
GET /api/v2/ipv4-networking/tcp
JSON
リクエスト

GET /api/v2/ipv4-networking/tcp
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"tcp": {
"min-snd-mss": 1000
}
}

 

XML
リクエスト

GET /api/v2/ipv4-networking/tcp
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ipv4-networking>
<tcp>
<min-snd-mss>1000</min-snd-mss>
</tcp>
</ipv4-networking>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ipv4-networking/tcp
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip tcp minimum-send-mss 1000

 

ip local policy route-map設定の更新

メソッド URI
PUT /api/v2/ipv4-networking/ip-local/policy-routemap
JSON
リクエスト

PUT /api/v2/ipv4-networking/ip-local/policy-routemap
Content-Type: application/json

 

{
"ip-local": {
"policy-routemap": "pbr"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/ipv4-networking/ip-local/policy-routemap
Content-Type: application/xml

 

<ipv4-networking>
<ip-local>
<policy-routemap>pbr</policy-routemap>
</ip-local>
</ipv4-networking>

 

レスポンス

204 No content

 

ip local policy route-map設定の取得

メソッド URI
GET /api/v2/ipv4-networking/ip-local/policy-routemap
JSON
リクエスト

GET /api/v2/ipv4-networking/ip-local/policy-routemap
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"ip-local": {
"policy-routemap": "pbr"
}
}

 

XML
リクエスト

GET /api/v2/ipv4-networking/ip-local/policy-routemap
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ipv4-networking>
<ip-local>
<policy-routemap>pbr</policy-routemap>
</ip-local>
</ipv4-networking>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ipv4-networking/ip-local/policy-routemap
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip local policy route-map pbr

 

ip local policy route-map設定の削除

メソッド URI
DELETE /api/v2/ipv4-networking/ip-local/policy-routemap

 

リクエスト

DELETE /api/v2/ipv4-networking/ip-local/policy-routemap

 

レスポンス

204 No content

 

ip host設定の作成

メソッド URI
POST /api/v2/ipv4-networking/ip-host/host-list
JSON
リクエスト

POST /api/v2/ipv4-networking/ip-host/host-list
Content-Type: application/json

 

{
"host-list": {
"fqdn": "www.example.com",
"address": "203.0.113.1"
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/ipv4-networking/ip-host/host-list
Content-Type: application/xml

 

<ip-host>
<host-list>
<fqdn>www.example.com</fqdn>
<address>203.0.113.1</address>
</host-list>
</ip-host>

 

レスポンス

201 Created

 

全ip host設定の取得

メソッド URI
GET /api/v2/ipv4-networking/ip-host/host-list
JSON
リクエスト

GET /api/v2/ipv4-networking/ip-host/host-list
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"host-list": [
{
"fqdn": "www.example.com",
"address": "203.0.113.1"
},
{
"fqdn": "www2.example.com",
"address": "203.0.113.2"
}
]
}

 

XML
リクエスト

GET /api/v2/ipv4-networking/ip-host/host-list
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ip-host>
<host-list>
<fqdn>www.example.com</fqdn>
<address>203.0.113.1</address>
</host-list>
<host-list>
<fqdn>www2.example.com</fqdn>
<address>203.0.113.2</address>
</host-list>
</ip-host>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ipv4-networking/ip-host/host-list
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip host www.example.com 203.0.113.1
ip host www2.example.com 203.0.113.2

 

ip host設定の更新

メソッド URI
PUT /api/v2/ipv4-networking/ip-host/host-list/{FQDN}
JSON
リクエスト

PUT /api/v2/ipv4-networking/ip-host/host-list/www.example.com
Content-Type: application/json

 

{
"fqdn": "www.example.com",
"address": "203.0.113.11"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/ipv4-networking/ip-host/host-list/www.example.com
Content-Type: application/xml

 

<host-list>
<fqdn>www.example.com</fqdn>
<address>203.0.113.11</address>
</host-list>

 

レスポンス

204 No content

 

ip host設定の取得

メソッド URI
GET /api/v2/ipv4-networking/ip-host/host-list/{FQDN}
JSON
リクエスト

GET /api/v2/ipv4-networking/ip-host/host-list/www.example.com
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"fqdn": "www.example.com",
"address": "203.0.113.11"
}

 

XML
リクエスト

GET /api/v2/ipv4-networking/ip-host/host-list/www.example.com
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<host-list>
<fqdn>www.example.com</fqdn>
<address>203.0.113.11</address>
</host-list>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ipv4-networking/ip-host/host-list/www.example.com
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip host www.example.com 203.0.113.11

 

ip host設定の削除

メソッド URI
DELETE /api/v2/ipv4-networking/ip-host/host-list/{FQDN}
リクエスト

DELETE /api/v2/ipv4-networking/ip-host/host-list/www.example.com

 

レスポンス

204 No content

 

パラメータ

指定可能なパラメータは下記の通りです。

なお指定可能なパラメータは、製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については、各製品のユーザーズガイド(CLI版)も合わせてご参照ください。

  • パラメータ表の説明文中の記号について
    < > … 括弧内の値の範囲から選択することを示しています。
    [ ] … 括弧内の値のどれかを選択することを示しています。
  • パラメータ表の説明文中のデータタイプについて
    A.B.C.D … IPv4アドレス
    FQDN … FQDN名

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4
ipv4-networking icmp-errors-inbound icmp-errors-inbound … [enable | disable]
martian-log martian-log … [enable | disable]
arp-invalid-log arp-invalid-log … [enable | disable]
reassemble-output reassemble-output … [enable | disable]
tcp min-snd-mss tcp minimum-send-mss … <48-1460>
ip-local policy-routemap ルートマップ名
ip-host host-list fqdn FQDN名
address IPアドレス … A.B.C.D