FutureNet

NXR,WXRシリーズ

REST-API編

8. 各種サービス設定

8-4. SNMP設定(snmp)

 処理概要

SNMP設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
SNMP v2 /api/v2/snmp

凡例:〇対応、-未対応

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

 

実行例

SNMP設定の作成

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

POST /api/v2/snmp
Content-Type: application/json

 

{
"bind": "192.168.0.254",
"security": {
"network": "192.168.0.0/24",
"community": "public"
},
"trap": {
"manager": "192.168.0.1",
"community": "public",
"pdu-type": "inform",
"inform-interval": 10
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/snmp
Content-Type: application/xml

 

<snmp>
<bind>192.168.0.254</bind>
<security>
<network>192.168.0.0/24</network>
<community>public</community>
</security>
<trap>
<manager>192.168.0.1</manager>
<community>public</community>
<pdu-type>inform</pdu-type>
<inform-interval>10</inform-interval>
</trap>
</snmp>

 

レスポンス

201 Created

 

SNMP設定の更新

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

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

 

{
"bind": "192.168.0.254",
"security": {
"network": "192.168.0.0/24",
"community": "public"
},
"syslocation": "Honsya",
"syscontact": "admin@example.jp",
"sysname": "Honsya-NXR",
"trap": {
"manager": "192.168.0.1",
"community": "public",
"pdu-type": "inform",
"inform-interval": 10
}
}

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<snmp>
<bind>192.168.0.254</bind>
<security>
<network>192.168.0.0/24</network>
<community>public</community>
</security>
<syslocation>Honsya</syslocation>
<syscontact>admin@example.jp</syscontact>
<sysname>Honsya-NXR</sysname>
<trap>
<manager>192.168.0.1</manager>
<community>public</community>
<pdu-type>inform</pdu-type>
<inform-interval>10</inform-interval>
</trap>
</snmp>

 

レスポンス

204 No content

 

SNMP設定の取得

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

GET /api/v2/snmp
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"bind": "192.168.0.254",
"security": {
"network": "192.168.0.0/24",
"community": "public"
},
"syslocation": "Honsya",
"syscontact": "admin@example.jp",
"sysname": "Honsya-NXR",
"trap": {
"manager": "192.168.0.1",
"community": "public",
"pdu-type": "inform",
"inform-interval": 10
}
}

 

XML
リクエスト

GET /api/v2/snmp
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<snmp>
<bind>192.168.0.254</bind>
<security>
<network>192.168.0.0/24</network>
<community>public</community>
</security>
<syslocation>Honsya</syslocation>
<syscontact>admin@example.jp</syscontact>
<sysname>Honsya-NXR</sysname>
<trap>
<manager>192.168.0.1</manager>
<community>public</community>
<pdu-type>inform</pdu-type>
<inform-interval>10</inform-interval>
</trap>
</snmp>

 

TEXT/PLAIN
リクエスト

GET /api/v2/snmp
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

snmp
bind address 192.168.0.254
security 192.168.0.0/24 public
syslocation Honsya
syscontact admin@example.jp
sysname Honsya-NXR
trap manager 192.168.0.1 public inform interval 10

 

SNMP設定の削除

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

DELETE /api/v2/snmp

 

レスポンス

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プレフィックスおよびプレフィックス長

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
snmp security network アクセスを許可するSNMPマネージャ …

  • A.B.C.D/M
  • X:X::X:X/M
community コミュニティ名
syslocation sysLocation
syscontact sysContact
sysname sysName
sysdescr sysDescr
trap manager トラップ送信先SNMPマネージャ …

  • A.B.C.D
  • X:X::X:X
community トラップコミュニティ名
pdu-type PDUタイプ … [v1 | v2 | inform]
port ポート番号 … <1-65535>
inform-interval Inform間隔 … <10-1800>(sec)
inform-retry Informリトライ回数 … <0-10>
agent type タイプ … [ip | interface]
value 値 …

  • ip … A.B.C.D
  • interface … インタフェース名
bind トラップ送信元アドレス …

  • A.B.C.D
  • X:X::X:X
ifindex-persist ifindex-persist … [enable | disable]