- FutureNet製品活用ガイド
- FutureNet NXR,VXRシリーズ
- REST-API編
FutureNet
NXR,VXRシリーズ
REST-API編
8. 各種サービス設定
8-4. SNMP設定(snmp)
処理概要
SNMP設定に関する処理を実行します。
URIおよびメソッド
機能 | Version | URI | メソッド | |||
POST | PUT | GET | DELETE | |||
SNMP | v2 | /api/v2/snmp | 〇 | 〇 | ● | 〇 |
凡例:
● : 読み取り専用ユーザも含めアクセス可
〇 : 読み取り専用ユーザはアクセス不可
- : 未対応
実行例
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 | Lv.4 | Lv.5 | Lv.6 | |
snmp | security | network | アクセスを許可するSNMPマネージャ …
|
|||
community | コミュニティ名(community) | |||||
syslocation | sysLocation | |||||
syscontact | sysContact | |||||
sysname | sysName | |||||
sysdescr | sysDescr | |||||
trap | manager | トラップ送信先SNMPマネージャ …
|
||||
community | トラップコミュニティ名(community) | |||||
pdu-type | PDUタイプ … [ inform | v1 | v2 ] | |||||
port | ポート番号 … <1-65535(162)> | |||||
inform-interval | inform間隔 … <10-1800(60)>(sec) ※デフォルト値はPDUタイプ inform指定時の値 |
|||||
inform-retry | informリトライ回数 … <0-10(3)> ※デフォルト値はPDUタイプ inform指定時の値 |
|||||
agent | type | タイプ … [ interface | ip ] |
||||
value | 値 …
|
|||||
bind | トラップ送信元アドレス …
|
|||||
ifindex-persist | ifindex-persist … [ enable | disable ] | |||||
snmpv3 | engine-id | エンジンID | ||||
access | user | USMユーザ番号 … <1-5> | ||||
level | アクセスセキュリティレベル … [ auth | noauth | priv ] | |||||
usm-user | number | USMユーザ番号 … <1-5> | ||||
name | ユーザ名 | |||||
auth | hash | 認証アルゴリズム … [ md5 | sha ] | ||||
password | hidden | 暗号化 … [ enable | disable ] | ||||
passphrase | 認証パスワード | |||||
priv | encrypt | 暗号アルゴリズム … [ aes | des ] | ||||
password | hidden | 暗号化 … [ enable | disable ] | ||||
passphrase | 暗号化パスワード | |||||
trap | host | SNMPv3トラップ送信先SNMPマネージャ …
|
||||
level | トラップセキュリティレベル … [ auth | noauth | priv ] | |||||
user | USMユーザ番号 … <1-5> |
目次
- 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