FutureNet

NXR,WXRシリーズ

REST-API編

8. 各種サービス設定

8-11. SSHサーバ設定(ssh)

 処理概要

SSHサーバ設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
SSH Server v2 /api/v2/ssh

凡例:〇対応、-未対応

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

 

実行例

SSHサーバ設定の更新

メソッド URI
PUT /api/v2/ssh
  • Bodyを指定しなかった場合、設定の削除およびサーバを停止します。

 

JSON
リクエスト

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

 

{
"server": "enable",
"port": 2222
}

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<ssh>
<server>enable</server>
<port>2222</port>
</ssh>

 

レスポンス

204 No content

 

SSHサーバ設定の取得

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"server": "enable",
"port": 2222
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<ssh>
<server>enable</server>
<port>2222</port>
</ssh>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

ssh-server enable
ssh-server port 2222

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4
global ssh server SSHサーバ機能 … [enable | disable]
version バージョン … 2
port ポート番号 … [22 | <512-65535>]
ciphers 暗号化タイプ … [3des-cbc | aes128-cbc | aes128-ctr | aes128-gcm-openssh | aes192-cbc | aes192-ctr | aes256-cbc | aes256-ctr | aes256-gcm-openssh | arcfour | arcfour128 | arcfour256 | blowfish-cbc | cast128-cbc | chacha20-poly1305-openssh]
address-family アドレスファミリ … [ip | ipv6]
authentication  password パスワード認証 … [enable | disable]
public-key 公開鍵認証 … [enable | disable]
vty-authentication 公開鍵認証後のパスワード認証 … [enable | disable]
forbidden-access-wan  ipv4 forbidden-access-wan(IPv4) … [enable | disable]
ipv6 forbidden-access-wan(IPv6) … [enable | disable]