FutureNet

NXR,WXRシリーズ

REST-API編

8. 各種サービス設定

8-14. CMSv2設定(cms)

 処理概要

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

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
CMSv2 v2 /api/v2/cms

凡例:〇対応、-未対応

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

 

実行例

CMSv2設定の作成

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

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

 

{
"common": {
"tenant-code": "tenant001",
"node-code": "nxrg110_001"
},
"servers": {
"server": {
"address": "192.168.0.1"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

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

 

<cms>
<common>
<tenant-code>tenant001</tenant-code>
<node-code>nxrg110_001</node-code>
</common>
<servers>
<server>
<address>192.168.0.1</address>
</server>
</servers>
</cms>

 

レスポンス

201 Created

 

CMSv2設定の更新

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

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

 

{
"common": {
"tenant-code": "tenant001",
"node-code": "nxrg110_001"
},
"http": {
"access-interval": 600
},
"servers": {
"server": {
"address": "192.168.0.1"
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<cms>
<common>
<tenant-code>tenant001</tenant-code>
<node-code>nxrg110_001</node-code>
</common>
<http>
<access-interval>600</access-interval>
</http>
<servers>
<server>
<address>192.168.0.1</address>
</server>
</servers>
</cms>

 

レスポンス

204 No content

 

CMSv2設定の取得

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"common": {
"tenant-code": "tenant001",
"node-code": "nxrg110_001"
},
"servers": {
"server": {
"address": "192.168.0.1"
}
}
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<cms>
<common>
<tenant-code>tenant001</tenant-code>
<node-code>nxrg110_001</node-code>
</common>
<servers>
<server>
<address>192.168.0.1</address>
</server>
</servers>
</cms>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

management-server
tenant-code tenant001
node-code nxrg110_001
server 192.168.0.1
exit-server

 

CMSv2設定の削除

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

DELETE /api/v2/cms

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4 Lv.5 Lv.6
cms common tenant-code テナントコード
node-code ノードコード
http access-interval アクセスインターバル … <600-2678400>(sec)
servers server address CMSアドレス …

  • A.B.C.D
  • X:X::X:X
  • FQDN
cert 証明書名
verify-peer ピアのSSL証明書検証 … [enable | disable]
default auth path パス
method デフォルト認証方式 … [bearer | none]
bearer token トークン
firmware update auth method ファームウェアアップデート認証方式 … [bearer | default | none]
bearer token トークン
http url URL …

  • auto
  • disable
  • URL(ex. https://A.B.C.D/…)
list-update auth method ファームウェアリストアップデート認証方式 … [bearer | default | none]
bearer token トークン
http url URL …

  • auto
  • disable
  • URL(ex. https://A.B.C.D/…)
information basic auth method 基本情報認証方式 … [bearer | default | none]
bearer token トークン
http url URL …

  • auto
  • disable
  • URL(ex. https://A.B.C.D/…)
extra auth method 拡張情報認証方式 … [bearer | default | none]
bearer token トークン
http url URL …

  • auto
  • disable
  • URL(ex. https://A.B.C.D/…)
watch auth method 監視情報認証方式 … [bearer | default | none]
bearer token トークン
http url URL …

  • auto
  • disable
  • URL(ex. https://A.B.C.D/…)
syslog latest auth method 最新ログファイル認証方式 … [bearer | default | none]
bearer token トークン
http url URL …

  • auto
  • disable
  • URL(ex. https://A.B.C.D/…)
archived auth method アーカイブログ認証方式 … [bearer | default | none]
bearer token トークン
http url URL …

  • auto
  • disable
  • URL(ex. https://A.B.C.D/…)
import config auth method コンフィグインポート認証方式 … [bearer | default | none]
bearer token トークン
http url URL …

  • auto
  • disable
  • URL(ex. https://A.B.C.D/…)