NXR,VXRシリーズ

8-10. ターミナルサーバ設定（terminal-server）

 処理概要

ターミナルサーバ設定に関する処理を実行します。

 

URIおよびメソッド

機能	Version	URI	メソッド
			POST	PUT	GET	DELETE
Terminal Server	v2	/api/v2/terminal-server	－	－	－	－
		/api/v2/terminal-server/server	〇	－	●	－
		/api/v2/terminal-server/server/{NUM}	－	〇	●	〇

凡例：

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

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

－ : 未対応

 

実行例

ターミナルサーバ設定の作成

メソッド	URI
POST	/api/v2/terminal-server/server

JSON

リクエスト

POST /api/v2/terminal-server/server
Content-Type: application/json

 

{
"server": {
"number": 0,
"baud-rate": 115200,
"transport": "telnet",
"port": 10000
}
}

 

レスポンス

201 Created

 

XML

リクエスト

POST /api/v2/terminal-server/server
Content-Type: application/xml

 

<terminal-server>
<server>
<number>0</number>
<baud-rate>115200</baud-rate>
<transport>telnet</transport>
<port>10000</port>
</server>
</terminal-server>

 

レスポンス

201 Created

 

全ターミナルサーバ設定の取得

メソッド	URI
GET	/api/v2/terminal-server/server

JSON

リクエスト

GET /api/v2/terminal-server/server
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"server": {
"number": 0,
"baud-rate": 115200,
"transport": "telnet",
"port": 10000
}
}

 

XML

リクエスト

GET /api/v2/terminal-server/server
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<terminal-server>
<server>
<number>0</number>
<baud-rate>115200</baud-rate>
<transport>telnet</transport>
<port>10000</port>
</server>
</terminal-server>

 

TEXT/PLAIN

リクエスト

GET /api/v2/terminal-server/server
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

terminal-server 0
transport telnet
port 10000
baud-rate 115200

 

ターミナルサーバ設定の更新

メソッド	URI
PUT	/api/v2/terminal-server/server/{NUM}

JSON

リクエスト

PUT /api/v2/terminal-server/server/0
Content-Type: application/json

 

{
"number": 0,
"baud-rate": 115200,
"transport": "telnet",
"port": 10000,
"bind": "192.168.0.1"
}

 

レスポンス

204 No content

 

XML

リクエスト

PUT /api/v2/terminal-server/server/0
Content-Type: application/xml

 

<server>
<number>0</number>
<baud-rate>115200</baud-rate>
<transport>telnet</transport>
<port>10000</port>
<bind>192.168.0.1</bind>
</server>

 

レスポンス

204 No content

 

ターミナルサーバ設定の取得

メソッド	URI
GET	/api/v2/terminal-server/server/{NUM}

JSON

リクエスト

GET /api/v2/terminal-server/server/0
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 0,
"baud-rate": 115200,
"transport": "telnet",
"port": 10000,
"bind": "192.168.0.1"
}

 

XML

リクエスト

GET /api/v2/terminal-server/server/0
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<server>
<number>0</number>
<baud-rate>115200</baud-rate>
<transport>telnet</transport>
<port>10000</port>
<bind>192.168.0.1</bind>
</server>

 

TEXT/PLAIN

リクエスト

GET /api/v2/terminal-server/server/0
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

terminal-server 0
transport telnet
port 10000
listen address 192.168.0.1
baud-rate 115200

 

ターミナルサーバ設定の削除

メソッド	URI
DELETE	/api/v2/terminal-server/server/{NUM}

リクエスト

DELETE /api/v2/terminal-server/server/0

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル			説明
Lv.1	Lv.2	Lv.3
terminal-server	server	number	設定番号
		baud-rate	ボーレート … [ 300 | 600 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200 ]
		parity	パリティ … [ even | none | odd ]
		data-bits	データビット … [ 7 | 8 ]
		stop-bits	ストップビット … [ 1 | 2 ]
		flow-control	フロー制御 … [ all | none | rtscts | xon-xoff ]
		idle-timeout	idle-timeout … <0-604800>(sec)
		transport	transportタイプ … [ raw | telnet ]
		port	ポート番号 … <1024-65535>
		bind	listenアドレス … A.B.C.D X:X::X:X