FutureNet

NXR,WXRシリーズ

REST-API編

9. ネットイベント設定

9-1. ネットイベント設定(netevent)

 処理概要

ネットイベント設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
Netevent v2 /api/v2/netevent
/api/v2/netevent/snmp-trap
/api/v2/netevent/send_mail
/api/v2/netevent/track
/api/v2/netevent/track/{TRACK_ID}

凡例:〇対応、-未対応

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

 

実行例

トラック設定ステータス遷移時のSNMPトラップ設定の更新

メソッド URI
PUT /api/v2/netevent/snmp-trap
JSON
リクエスト

PUT /api/v2/netevent/snmp-trap
Content-Type: application/json

 

{
"snmp-trap": "enable"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/netevent/snmp-trap
Content-Type: application/xml

 

<netevent>
<snmp-trap>enable</snmp-trap>
</netevent>

 

レスポンス

204 No content

 

トラック設定ステータス遷移時のSNMPトラップ設定の取得

メソッド URI
GET /api/v2/netevent/snmp-trap
JSON
リクエスト

GET /api/v2/netevent/snmp-trap
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"snmp-trap": "enable"
}

 

XML
リクエスト

GET /api/v2/netevent/snmp-trap
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<netevent>
<snmp-trap>enable</snmp-trap>
</netevent>

 

TEXT/PLAIN
リクエスト

GET /api/v2/netevent/snmp-trap
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

track snmp trap

 

トラック設定ステータス遷移時のSNMPトラップ設定の削除

メソッド URI
DELETE /api/v2/netevent/snmp-trap
リクエスト

DELETE /api/v2/netevent/snmp-trap

 

レスポンス

204 No content

 

トラック設定ステータス遷移時のメール送信設定の更新

メソッド URI
PUT /api/v2/netevent/send_mail
JSON
リクエスト

PUT /api/v2/netevent/send_mail
Content-Type: application/json

 

{
"send_mail": {
"server": 1
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/netevent/send_mail
Content-Type: application/xml

 

<netevent>
<send_mail>
<server>1</server>
</send_mail>
</netevent>

 

レスポンス

204 No content

 

トラック設定ステータス遷移時のメール送信設定の取得

メソッド URI
GET /api/v2/netevent/send_mail
JSON
リクエスト

GET /api/v2/netevent/send_mail
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"send_mail": {
"server": 1
}
}

 

XML
リクエスト

GET /api/v2/netevent/send_mail
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<netevent>
<send_mail>
<server>1</server>
</send_mail>
</netevent>

 

TEXT/PLAIN
リクエスト

GET /api/v2/netevent/send_mail
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

track mail send server 1

 

トラック設定ステータス遷移時のメール送信設定の削除

メソッド URI
DELETE /api/v2/netevent/send_mail
リクエスト

DELETE /api/v2/netevent/send_mail

 

レスポンス

204 No content

 

トラック設定の作成

メソッド URI
POST /api/v2/netevent/track
JSON
リクエスト

POST /api/v2/netevent/track
Content-Type: application/json

 

{
"track": {
"track-id": 1,
"method": "ip",
"keepalive": {
"destination": "192.168.0.1"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/netevent/track
Content-Type: application/xml

 

<netevent>
<track>
<track-id>1</track-id>
<method>ip</method>
<keepalive>
<destination>192.168.0.1</destination>
</keepalive>
</track>
</netevent>

 

レスポンス

201 Created

 

全トラック設定の取得

メソッド URI
GET /api/v2/netevent/track
JSON
リクエスト

GET /api/v2/netevent/track
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"track": [
{
"track-id": 1,
"method": "ip",
"keepalive": {
"destination": "192.168.0.1"
}
},
{
"track-id": 2,
・・・・・

 

XML
リクエスト

GET /api/v2/netevent/track
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<netevent>
<track>
<track-id>1</track-id>
<method>ip</method>
<keepalive>
<destination>192.168.0.1</destination>
</keepalive>
</track>
<track>
<track-id>2</track-id>
・・・・・

 

TEXT/PLAIN
リクエスト

GET /api/v2/netevent/track
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

track 1 ip reachability 192.168.0.1
・・・・・

 

トラック設定の更新

メソッド URI
PUT /api/v2/netevent/track/{TRACK_ID}
JSON
リクエスト

PUT /api/v2/netevent/track/1
Content-Type: application/json

 

{
"track-id": 1,
"method": "ip",
"keepalive": {
"interval": 30,
"destination": "192.168.0.1"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/netevent/track/1
Content-Type: application/xml

 

<track>
<track-id>1</track-id>
<method>ip</method>
<keepalive>
<interval>30</interval>
<destination>192.168.0.1</destination>
</keepalive>
</track>

 

レスポンス

204 No content

 

トラック設定の取得

メソッド URI
GET /api/v2/netevent/track/{TRACK_ID}
JSON
リクエスト

GET /api/v2/netevent/track/1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"track-id": 1,
"method": "ip",
"keepalive": {
"interval": 30,
"destination": "192.168.0.1"
}
}

 

XML
リクエスト

GET /api/v2/netevent/track/1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<track>
<track-id>1</track-id>
<method>ip</method>
<keepalive>
<interval>30</interval>
<destination>192.168.0.1</destination>
</keepalive>
</track>

 

TEXT/PLAIN
リクエスト

GET /api/v2/netevent/track/1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

track 1 ip reachability 192.168.0.1 30 3

 

トラック設定の削除

メソッド URI
DELETE /api/v2/netevent/track/{TRACK_ID}
リクエスト

DELETE /api/v2/netevent/track/1

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4 Lv.5
netevent snmp-trap SNMPトラップ通知 … [enable | disable]
send_mail server メール送信サーバ設定番号
subject 件名
track track-id トラックID
method 監視対象 … [bgp | interface | ip | ipv6 | isakmp | ospf | resume | vrrp | ndisc | ndisc6]
interface インタフェース名
number ISAKMPポリシー番号
router-id OSPFルータID/BGPピアIP …

  • A.B.C.D
  • X:X::X:X
keepalive destination 宛先アドレス …

  • A.B.C.D
  • X:X::X:X
  • FQDN
source  送信元アドレス/インタフェース名 …

  • A.B.C.D
  • X:X::X:X
  • インタフェース名
interval インターバル … <10-32767>(sec)
retry リトライ … <0-255>
delay ディレイ … <10-32767>(sec)
variable variable … [enable | disable]
recovery リカバリー … <1-255>
rtt Round Trip Time … <1-5000>(msec)
rtt-normal RTTノーマルカウント … <1-255>
rtt-delay RTTディレイカウント … <1-255>
df DFビット … [enable | disable]
ttl TTLまたはHop Limit… <1-255>
length ペイロード長 … <56-1500>
vrrp id VRRP ID
interface インタフェース名
log-type モニタログによるロギング … [0 | 1]
timeout イニシャルタイムアウト … <10-3600>(sec)
delay ディレイタイマ … <10-3600>(sec)
※ip/ipv6 reachability以外で使用