FutureNet

NXR,WXRシリーズ

REST-API編

8. 各種サービス設定

8-8. WarpLink設定(warplink)

 処理概要

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

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
WarpLink v2 /api/v2/warplink

凡例:〇対応、-未対応

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

 

実行例

WarpLink設定の作成

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

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

 

{
"service": "enable",
"account": {
"username": "test1",
"password": {
"passphrase": "test1pass"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

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

 

<warplink>
<service>enable</service>
<account>
<username>test1</username>
<password>
<passphrase>test1pass</passphrase>
</password>
</account>
</warplink>

 

レスポンス

201 Created

 

WarpLink設定の更新

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

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

 

{
"service": "enable",
"account": {
"username": "test1",
"password": {
"passphrase": "test1pass"
}
},
"send_syslog": "enable"
}

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<warplink>
<service>enable</service>
<account>
<username>test1</username>
<password>
<passphrase>test1pass</passphrase>
</password>
</account>
<send_syslog>enable</send_syslog>
</warplink>

 

レスポンス

204 No content

 

WarpLink設定の取得

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"service": "enable",
"account": {
"username": "test1",
"password": {
"passphrase": "test1pass"
}
},
"send_syslog": "enable"
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<warplink>
<service>enable</service>
<account>
<username>test1</username>
<password>
<passphrase>test1pass</passphrase>
</password>
</account>
<send_syslog>enable</send_syslog>
</warplink>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

warplink
service enable
account username test1 password test1pass
send-syslog enable

 

WarpLink設定の削除

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

DELETE /api/v2/warplink

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4
warplink service WarpLink機能 … [enable | disable]
account username ユーザ名
password hidden 暗号化 … [enable | disable]
passphrase パスワード
apply 暗号化適用 … [enable | disable]
※hidden化する場合は必要
send_statistics interface インタフェース統計情報送信 
send_syslog シスログ送信 … [enable | disable]