FutureNet

NXR,WXRシリーズ

REST-API編

8. 各種サービス設定

8-5. シスログ設定(syslog)

 処理概要

シスログ設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
Syslog v2 /api/v2/syslog

凡例:〇対応、-未対応

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

 

実行例

シスログ設定の作成

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

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

 

{
"system_log": {
"local": "enable",
"server": {
"address": "192.168.0.1"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

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

 

<syslog>
<system_log>
<local>enable</local>
<server>
<address>192.168.0.1</address>
</server>
</system_log>
</syslog>

 

レスポンス

201 Created

 

シスログ設定の更新

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

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

 

{
"system_log": {
"local": "enable",
"server": {
"address": "192.168.0.1"
}
},
"rotate": {
"disk": " flash1",
"files": 10
}
}

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<syslog>
<system_log>
<local>enable</local>
<server>
<address>192.168.0.1</address>
</server>
</system_log>
<rotate>
<disk>flash1</disk>
<files>10</files>
</rotate>
</syslog>

 

レスポンス

204 No content

 

シスログ設定の取得

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"system_log": {
"local": "enable",
"server": {
"address": "192.168.0.1"
}
},
"rotate": {
"disk": " flash1",
"files": 10
}
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<syslog>
<system_log>
<local>enable</local>
<server>
<address>192.168.0.1</address>
</server>
</system_log>
<rotate>
<disk>flash1</disk>
<files>10</files>
</rotate>
</syslog>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

syslog
local enable
server 192.168.0.1
rotate flash1 threshold files 10
exit-syslog

 

シスログ設定の削除

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

DELETE /api/v2/syslog

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4 Lv.5 Lv.6
syslog system_log local ローカル出力 … [enable | disable]
file 出力ファイル名
mark MARK出力 … <0-10080>(min)
priority プライオリティ … [debug | info | notice]
system_message システムメッセージ出力時間 … [hour | mark]
suppress メッセージ抑制時間 … <10-3600>(sec)
server address シスログサーバアドレス …

  • A.B.C.D
  • X:X::X:X
  • FQDN
source 送信元アドレス … A.B.C.D
port 宛先ポート番号 … <1024-65535>
auto_rotate auto rotate … [enable | disable]
rotate disk ローテートファイル保存先 … [diskX | flash1]
※Xはdisk番号 (ex. disk0)
logsize ファイルサイズ閾値 … <150-4000>(kbyte)
※最大値は機種により異なります
files 最大ファイル数 … <1-10>
email log_email send ログメール送信 … [enable | disable]
to 宛先メールアドレス
from 送信元メールアドレス
subject 件名
strings line Line番号 … <1-32>
string メール検索文字列
server auth 認証方式 … [pop-before-smtp | smtp-auth-login | smtp-auth-plain]
smtp address SMTPサーバアドレス …

  • A.B.C.D
  • FQDN
port SMTPポート番号 … <1-65535>
pop3 address POP3サーバアドレス …

  • A.B.C.D
  • FQDN
account username ユーザ名
password hidden 暗号化 … [enable | disable]
passphrase パスワード
apply 暗号化適用 … [enable | disable]
※hidden化する場合は必要