NXR,VXRシリーズ

2-3. 各種コピー操作（maint/copy）

 処理概要

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

 

URIおよびメソッド

機能	Version	URI	メソッド
			POST	PUT	GET	DELETE
copy	v1	/api/v1/maint/copy	●(注)	－	－	－
	v2	/api/v2/maint/copy	●(注)	－	－	－

凡例：

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

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

－ : 未対応

※ NXR-G100シリーズ以外の機種ではREST-APIv2の利用を推奨します。

注 ： 読み取り専用ユーザの場合、NXRへのインポートはできません。

 

実行例

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

• SSHでの設定（TGZ形式）のエクスポート
• SSHでの設定（TGZ形式）のインポート
• SSHでの設定（XML形式）のエクスポート
• SSHでの設定（XML形式）のインポート
• テクニカルサポート情報の取得とFTPでのエクスポート
• シスログの外部ストレージ（disk0）へのエクスポート
• HTTPS（ベーシック認証）でのDNSインターセプト用リストファイルのインポート

 

SSHでの設定（TGZ形式）のエクスポート

JSON

リクエスト

POST /api/v2/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/v2/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

 

SSHでの設定（TGZ形式）のインポート

JSON

リクエスト

POST /api/v2/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/v2/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

 

SSHでの設定（XML形式）のエクスポート

JSON

リクエスト

POST /api/v2/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/v2/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

 

SSHでの設定（XML形式）のインポート

JSON

リクエスト

POST /api/v2/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/v2/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/v2/maint/copy
Content-Type: application/json


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


 

レスポンス

200 OK

 

XML

リクエスト

POST /api/v2/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/v2/maint/copy
Content-Type: application/json


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


 

レスポンス

200 OK

 

XML

リクエスト

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

 

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

 

レスポンス

200 OK

 

HTTPS（ベーシック認証）でのDNSインターセプト用リストファイルのインポート

JSON

リクエスト

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


{
"src" : "https://test@www.example.com/basic-auth/DNSI_FILE.txt",
"dst" : "dns-intercept ip setname DNSI",
"password" : "testpass"
}


 

レスポンス

200 OK

 

XML

リクエスト

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

 

<config>
<src>https://test@www.example.com/basic-auth/DNSI_FILE.txt</src>
<dst>dns-intercept ip setname DNSI</dst>
<password>testpass</password>
</config>

 

レスポンス

200 OK

 

パラメータ

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

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

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

 

パラメータおよびレベル		説明
Lv.1	Lv.2
config	src	コピー対象 … config startup-config show-config json-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 http://USER@[ A.B.C.D | X:X::X:X ]/FILENAME https://USER@[ A.B.C.D | X:X::X:X ]/FILENAME https-://USER@[ 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では指定不可 dns-intercept ip setname SETNAME
	password	パスワード ※SSH,HTTP(S)のベーシック認証でのみ指定
	all	設定all指定 … [ true | false ] ※設定ファイルのバックアップでのみ有効
	source	送信元アドレス … [ A.B.C.D | X:X::X:X ]