FutureNet

NXR,VXRシリーズ

REST-API編

12. システム設定

12-7. CLI設定(cli)

 処理概要

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

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
CLI v2 /api/v2/cli

凡例:

● : 読み取り専用ユーザも含めアクセス可

〇 : 読み取り専用ユーザはアクセス不可

- : 未対応

 

実行例

CLI設定の更新

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

 

JSON
リクエスト

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

 

{
"con-idle-timeout": {
"min": 0
}
}

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<cli>
<con-idle-timeout>
<min>0</min>
</con-idle-timeout>
</cli>

 

レスポンス

204 No content

 

CLI設定の取得

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"con-idle-timeout": {
"min": 0
}
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<cli>
<con-idle-timeout>
<min>0</min>
</con-idle-timeout>
</cli>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

console idle-timeout 0

 

パラメータ

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

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

  • パラメータ表の説明文中の記号について
    < > … 括弧内の値の範囲から選択することを示しています。
    数字,文字列 … 初期値

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4
global cli con-idle-timeout min コンソールアイドルタイマー … <0-35791>(min)
sec コンソールアイドルタイマー … <0-2147483(3600)>(sec)
con-term-len コンソール表示行数 … <0-512(24)>
con-term-width コンソール表示列数 … <40-180(80)>
vty-session-max VTYセッション最大数 … <1-10(4)>
vty-idle-timeout min VTYアイドルタイマー … <0-35791>(min)
sec VTYアイドルタイマー … <0-2147483(600)>(sec)
vty-term-len VTY表示行数 … <0-512>
filter ipv4-name VTY IPv4アクセスフィルタ名
ipv6-name VTY IPv6アクセスフィルタ名