- FutureNet製品活用ガイド
- FutureNet NXR,VXRシリーズ
- REST-API編
FutureNet
NXR,VXRシリーズ
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 | ●(注) | - | - | - |
凡例:
● : 読み取り専用ユーザも含めアクセス可
〇 : 読み取り専用ユーザはアクセス不可
- : 未対応
※ 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 | コピー対象 …
|
dst | コピー先 …
|
|
password | パスワード ※SSH,HTTP(S)のベーシック認証でのみ指定 |
|
all | 設定all指定 … [ true | false ] ※設定ファイルのバックアップでのみ有効 |
|
source | 送信元アドレス … [ A.B.C.D | X:X::X:X ] |
目次
- 1. REST-API機能の利用方法およびAuth-IDの発行
- 2. メンテナンス
- メンテナンス一覧
- 2-1. 機器再起動(maint/restart)
- 2-2. 設定の保存(maint/save-config)
- 2-3. 各種コピー操作(maint/copy)
- 2-4. startup-configの保存・取得(maint/startup-config)
- 2-5. ファームウェアの更新(maint/firmware/update)
- 2-6. ファームウェアリストアップデートでの更新(maint/firmware/list-update)
- 2-7. ファームウェアバージョンの取得(maint/firmware/version)
- 2-8. exec系,showコマンドの実行(maint/cli)
- 2-9. configの反映・取得(maint/config)
- 2-10. ロールバックの実行・ロールバック用コマンドの確認(maint/rollback-config)
- 2-11. ロールバックタイマの取得・停止(maint/rollback-timer)
- 2-12. ping(IPv4)の実行・結果確認(maint/ping)
- 2-13. Ping(IPv6)の実行・結果確認(maint/ping6)
- 2-14. traceroute(IPv4)の実行・結果確認(maint/traceroute)
- 2-15. traceroute(IPv6)の実行・結果確認(maint/traceroute6)
- 2-16. パケットダンプの実行・結果確認(maint/dump)
- 2-17. デバッグタイマの実行(maint/debug)
- 2-18. センチュリー・テクニカルサポート情報の取得(maint/century-tech-support)
- 3. インタフェース設定
- 4. ルーティング設定
- 5. アクセスリスト設定
- 6. NAT設定
- 7. VPN設定
- 8. 各種サービス設定
- 9. ネットイベント設定
- 10. モバイル・WiFi設定
- 11. IPv4/IPv6設定
- 12. システム設定
更新情報
→ 一覧へカテゴリ
タグ
- CRG
- DDNS
- DHCP
- DNAT
- DNSインターセプト
- Ethernet
- IIJモバイル
- IKE Modeconfig
- IKEv2 Configuration Payload
- IPinIP
- IPoE
- IPv6
- KDDI
- L2TPv3
- MAP-E
- NGN
- NTTドコモ
- PBR
- Policy Based IPsec
- PPP
- PPPoE
- QoS
- RADIUS連携
- RAシリーズ
- Route Based IPsec
- SMS
- SNAT
- SoftBank
- UPnP
- URL転送
- VLAN
- VRRP
- Web認証
- WiMAX
- コンフィグロールバック
- ネットイベント
- フィルタ
- ブリッジ
- モニタログ
- ワイモバイル
- 仮想スイッチ
- 冗長化
- 無線LAN