NXR,VXRシリーズ

12-10. SSHクライアント設定（ssh-client）

 処理概要

SSHクライアント設定に関する処理を実行します。

 

URIおよびメソッド

機能	Version	URI	メソッド
			POST	PUT	GET	DELETE
SSH Client	v2	/api/v2/ssh-client	－	〇	●	－

凡例：

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

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

－ : 未対応

 

実行例

SSHクライアント設定の更新

メソッド	URI
PUT	/api/v2/ssh-client

JSON

リクエスト

PUT /api/v2/ssh-client
Content-Type: application/json

 

{
"certificate": {
"name": "AAA",
"type": "pub"
},
"private-key": {
"name": "AAA",
"type": "pem",
"password": {
"passphrase": "clientpass"
}
}
}

 

レスポンス

204 No content

 

XML

リクエスト

PUT /api/v2/ssh-client
Content-Type: application/xml

 

<ssh-client>
<certificate>
<name>AAA</name>
<type>pub</type>
</certificate>
<private-key>
<name>AAA</name>
<type>pem</type>
<password>
<passphrase>clientpass</passphrase>
</password>
</private-key>
</ssh-client>

 

レスポンス

204 No content

 

SSHクライアント設定の取得

メソッド	URI
GET	/api/v2/ssh-client

JSON

リクエスト

GET /api/v2/ssh-client
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"certificate": {
"name": "AAA",
"type": "pub"
},
"private-key": {
"name": "AAA",
"type": "pem",
"password": {
"passphrase": "clientpass"
}
}
}

 

XML

リクエスト

GET /api/v2/ssh-client
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ssh-client>
<certificate>
<name>AAA</name>
<type>pub</type>
</certificate>
<private-key>
<name>AAA</name>
<type>pem</type>
<password>
<passphrase>clientpass</passphrase>
</password>
</private-key>
</ssh-client>

 

TEXT/PLAIN

リクエスト

GET /api/v2/ssh-client
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ssh-client cert private-key AAA pem
ssh-client cert private-key AAA password clientpass
ssh-client cert certificate AAA pub

 

パラメータ

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

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

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

 

パラメータおよびレベル				説明
Lv.1	Lv.2	Lv.3	Lv.4
ssh-client	certificate	name		証明書名
		type		ファイルタイプ
	private-key	name		秘密鍵名
		type		ファイルタイプ
		password	hidden	暗号化 … [ enable | disable ]
			passphrase	パスワード
			apply	暗号化適用 … [ enable | disable ] ※hidden化する場合は必要