FutureNet

NXR,WXRシリーズ

REST-API編

2. メンテナンス

2-3. 各種コピー操作(maint/copy)

 処理概要

コピーに関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
copy v1 /api/v1/maint/copy
v2 /api/v2/maint/copy

凡例:〇対応、-未対応

 

実行例

メソッド URI
POST /api/{VERSION}/maint/copy

 

設定(TGZ形式)のエクスポート(SSH)

JSON
リクエスト

POST /api/v1/maint/copy
Content-Type: application/json


{
"src" : "config",
"dst" : "ssh://test@192.168.10.100/config.tgz",
"password" : "testpass",
"all" : "true",
"source" : "192.168.10.1"
}

 

レスポンス

200 OK

 

XML
リクエスト

POST /api/v1/maint/copy
Content-Type: application/xml

 

<config>
<src>config</src>
<dst>ssh://test@192.168.10.100/config.tgz</dst>
<password>testpass</password>
<all>true</all>
<source>192.168.10.1</source>
</config>

 

レスポンス

200 OK

 

設定(TGZ形式)のインポート(SSH)

JSON
リクエスト

POST /api/v1/maint/copy
Content-Type: application/json


{
"src" : "ssh://test@192.168.10.100/config.tgz",
"dst" : "startup-config",
"password" : "testpass"
}

 

レスポンス

200 OK

 

XML
リクエスト

POST /api/v1/maint/copy
Content-Type: application/xml

 

<config>
<src>ssh://test@192.168.10.100/config.tgz</src>
<dst>startup-config</dst>
<password>testpass</password>
</config>

 

レスポンス

200 OK

 

設定(xml形式)のエクスポート(SSH)

JSON
リクエスト

POST /api/v1/maint/copy
Content-Type: application/json


{
"src" : "config",
"dst" : "ssh://test@192.168.10.100/config.xml",
"password" : "testpass",
"source" : "192.168.10.1"
}

 

レスポンス

200 OK

 

XML
リクエスト

POST /api/v1/maint/copy
Content-Type: application/xml

 

<config>
<src>config</src>
<dst>ssh://test@192.168.10.100/config.xml</dst>
<password>testpass</password>
<source>192.168.10.1</source>
</config>

 

レスポンス

200 OK

 

設定(xml形式)のインポート(SSH)

JSON
リクエスト

POST /api/v1/maint/copy
Content-Type: application/json


{
"src" : "ssh://test@192.168.10.100/config.xml",
"dst" : "startup-config",
"password" : "testpass"
}

 

レスポンス

200 OK

 

XML
リクエスト

POST /api/v1/maint/copy
Content-Type: application/xml

 

<config>
<src>ssh://test@192.168.10.100/config.xml</src>
<dst>startup-config</dst>
<password>testpass</password>
</config>

 

レスポンス

200 OK

 

テクニカルサポート情報の取得とエクスポート(FTP)

JSON
リクエスト

POST /api/v1/maint/copy
Content-Type: application/json


{
"src" : "tech-support",
"dst" : "ftp://192.168.10.100/tech-support.txt"
}

 

レスポンス

200 OK

 

XML
リクエスト

POST /api/v1/maint/copy
Content-Type: application/xml

 

<config>
<src>tech-support</src>
<dst>ftp://192.168.10.100/tech-support.txt</dst>
</config>

 

レスポンス

200 OK

 

シスログのエクスポート(外部ストレージ: disk0)

JSON
リクエスト

POST /api/v1/maint/copy
Content-Type: application/json


{
"src" : "syslog",
"dst" : "disk0:messages.txt"
}

 

レスポンス

200 OK

 

XML
リクエスト

POST /api/v1/maint/copy
Content-Type: application/xml

 

<config>
<src>syslog</src>
<dst>disk0:messages.txt</dst>
</config>

 

レスポンス

200 OK

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2
config src コピー対象 …

  • config
  • startup-config
  • show-config
  • cms
  • tech-support
  • century-tech-support
  • bootlog
  • syslog
  • reachability-log
  • resource-log
  • dump
  • ssh://user@[A.B.C.D | X:X::X:X]/FILENAME
  • ftp://[A.B.C.D | X:X::X:X]/FILENAME
  • diskX:FILENAME
    ※Xはディスク番号 (ex. disk0)
  • http://[A.B.C.D | X:X::X:X]/FILENAME
  • https://[A.B.C.D | X:X::X:X]/FILENAME
  • https-://[A.B.C.D | X:X::X:X]/FILENAME
  • flash:FILENAME
dst コピー先 …

  • ssh://user@[A.B.C.D | X:X::X:X]/FILENAME
  • ftp://[A.B.C.D | X:X::X:X]/FILENAME
  • diskX:FILENAME
    ※Xはディスク番号 (ex. disk0)
  • flash:FILENAME
  • flash-initial-config
  • startup-config
  • config
    Rest-APIv1は指定不可
password パスワード
※SSHでのみ指定
all 設定all指定 … [true | false]
※設定ファイルのバックアップでのみ有効
source 送信元アドレス … [A.B.C.D | X:X::X:X]